[Summary view]

Differences Between: [Versions 400 and 403] [Versions 401 and 403] [Versions 402 and 403]

   1  <?php
   2  // This file is part of Moodle - http://moodle.org/
   3  //
   4  // Moodle is free software: you can redistribute it and/or modify
   5  // it under the terms of the GNU General Public License as published by
   6  // the Free Software Foundation, either version 3 of the License, or
   7  // (at your option) any later version.
   8  //
   9  // Moodle is distributed in the hope that it will be useful,
  10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  // GNU General Public License for more details.
  13  //
  14  // You should have received a copy of the GNU General Public License
  15  // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16  
  17  /**
  18   * A base class for actions that are an icon that lets you manipulate the question in some way.
  19   *
  20   * @package   core_question
  21   * @copyright 2009 Tim Hunt
  22   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace core_question\local\bank;
  26  
  27  /**
  28   * A base class for actions that are an icon that lets you manipulate the question in some way.
  29   *
  30   * @copyright 2009 Tim Hunt
  31   * @author    2021 Safat Shahin <safatshahin@catalyst-au.net>
  32   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  33   * @deprecated Since Moodle 4.3 MDL-75125 - Use question_action_base instead.
  34   * @todo MDL-78090 This class will be deleted in Moodle 4.7
  35   */
  36  abstract class action_column_base extends column_base {
  37  
  38      /**
  39       * @return string
  40       * @deprecated Since Moodle 4.3
  41       */
  42      public function get_title(): string {
  43          debugging('The action_column_base class is deprecated. Please use question_action_base instead.', DEBUG_DEVELOPER);
  44          return '&#160;';
  45      }
  46  
  47      /**
  48       * @return string[]
  49       * @deprecated Since Moodle 4.3
  50       */
  51      public function get_extra_classes(): array {
  52          debugging('The action_column_base class is deprecated. Please use question_action_base instead.', DEBUG_DEVELOPER);
  53  
  54          return ['iconcol'];
  55      }
  56  
  57      /**
  58       * @param $icon
  59       * @param $title
  60       * @param $url
  61       * @return void
  62       * @deprecated Since Moodle 4.3
  63       */
  64      protected function print_icon($icon, $title, $url): void {
  65          debugging('The action_column_base class is deprecated. Please use question_action_base instead.', DEBUG_DEVELOPER);
  66          global $OUTPUT;
  67          echo \html_writer::tag('a', $OUTPUT->pix_icon($icon, $title), ['title' => $title, 'href' => $url]);
  68      }
  69  
  70      /**
  71       * @return string[]
  72       * @deprecated Since Moodle 4.3
  73       */
  74      public function get_extra_joins(): array {
  75          debugging('The action_column_base class is deprecated. Please use question_action_base instead.', DEBUG_DEVELOPER);
  76          return ['qv' => 'JOIN {question_versions} qv ON qv.questionid = q.id',
  77                  'qbe' => 'JOIN {question_bank_entries} qbe on qbe.id = qv.questionbankentryid',
  78                  'qc' => 'JOIN {question_categories} qc ON qc.id = qbe.questioncategoryid'];
  79      }
  80  
  81      /**
  82       * @return string[]
  83       * @deprecated Since Moodle 4.3
  84       */
  85      public function get_required_fields(): array {
  86          debugging('The action_column_base class is deprecated. Please use question_action_base instead.', DEBUG_DEVELOPER);
  87          // Createdby is required for permission checks.
  88          // Qtype so we can easily avoid applying actions to question types that
  89          // are no longer installed.
  90          return ['q.id', 'q.qtype', 'q.createdby', 'qc.contextid'];
  91      }
  92  
  93  }