[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   * Base class class for navigation node.
  19   *
  20   * @package    core_question
  21   * @copyright  2021 Catalyst IT Australia Pty Ltd
  22   * @author     Safat Shahin <safatshahin@catalyst-au.net>
  23   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24   */
  25  
  26  namespace core_question\local\bank;
  27  
  28  /**
  29   * Class navigation_node_base is the base class for navigation node.
  30   *
  31   * @package    core_question
  32   * @copyright  2021 Catalyst IT Australia Pty Ltd
  33   * @author     Safat Shahin <safatshahin@catalyst-au.net>
  34   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  35   */
  36  abstract class navigation_node_base {
  37  
  38      /**
  39       * Title for this node.
  40       */
  41      abstract public function get_navigation_title();
  42  
  43      /**
  44       * Key for this node.
  45       */
  46      abstract public function get_navigation_key();
  47  
  48      /**
  49       * URL for this node
  50       */
  51      abstract public function get_navigation_url();
  52  
  53      /**
  54       * Tab capabilities.
  55       *
  56       * If it has capabilities to be checked, it will return the array of capabilities.
  57       *
  58       * @return null|array
  59       */
  60      public function get_navigation_capabilities(): ?array {
  61          return null;
  62      }
  63  
  64  }