[Summary view]

   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   * Interface to indicate that a question bank column can go in the action menu.
  19   *
  20   * @package   core_question
  21   * @copyright 2019 Tim Hunt
  22   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace core_question\bank;
  26  defined('MOODLE_INTERNAL') || die();
  27  
  28  
  29  /**
  30   * Interface to indicate that a question bank column can go in the action menu.
  31   *
  32   * If a question bank column implements this interface, and if the {@link edit_menu_column}
  33   * is present in the question bank view, then the 'column' will be shown as an entry in the
  34   * edit menu instead of as a separate column.
  35   *
  36   * Probably most columns that want to implement this will be subclasses of
  37   * {@link action_column_base}, and most such columns should probably implement
  38   * this interface.
  39   *
  40   * If your column is a simple action, you can probably save duplicated code by
  41   * using the base class action_column_menuable as an easy way to implement both
  42   * action_column_base and this interface.
  43   *
  44   * @copyright 2019 Tim Hunt
  45   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  46   */
  47  interface menuable_action {
  48  
  49      /**
  50       * Return the appropriate action menu link, or null if it does not apply to this question.
  51       *
  52       * @param \stdClass $question data about the question being displayed in this row.
  53       * @return \action_menu_link|null the action, if applicable to this question.
  54       */
  55      public function get_action_menu_link(\stdClass $question): ?\action_menu_link;
  56  }