[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  namespace core\hook\navigation;
  18  
  19  use core\hook\described_hook;
  20  use core\hook\stoppable_trait;
  21  use core\navigation\views\primary;
  22  
  23  /**
  24   * Allows plugins to insert nodes into site primary navigation
  25   *
  26   * @package    core
  27   * @copyright  2023 Marina Glancy
  28   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  29   */
  30  class primary_extend implements described_hook,
  31          \Psr\EventDispatcher\StoppableEventInterface {
  32      use stoppable_trait;
  33  
  34      /**
  35       * Creates new hook.
  36       *
  37       * @param primary $primaryview Primary navigation view
  38       */
  39      public function __construct(protected primary $primaryview) {
  40      }
  41  
  42      /**
  43       * Primary navigation view
  44       *
  45       * @return primary
  46       */
  47      public function get_primaryview(): primary {
  48          return $this->primaryview;
  49      }
  50  
  51      /**
  52       * Describes the hook purpose.
  53       *
  54       * @return string
  55       */
  56      public static function get_hook_description(): string {
  57          return 'Allows plugins to insert nodes into site primary navigation';
  58      }
  59  
  60      /**
  61       * List of tags that describe this hook.
  62       *
  63       * @return string[]
  64       */
  65      public static function get_hook_tags(): array {
  66          return ['navigation'];
  67      }
  68  }