[Summary view]

   1  <?php
   2  // This file is part of Moodle - https://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 <https://www.gnu.org/licenses/>.
  16  
  17  namespace core\hook;
  18  
  19  /**
  20   * This interface describes a class which can discover all hook
  21   * classes of a plugin.
  22   *
  23   * To add new discovery agent in your plugin you need to add your_plugin\hooks
  24   * class that implements this interface.
  25   *
  26   * @package   core
  27   * @copyright Andrew Lyons <andrew@nicols.co.uk>
  28   * @license   https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  29   */
  30  interface discovery_agent {
  31      /**
  32       * Returns a list of hooks for component.
  33       *
  34       * @return array
  35       */
  36      public static function discover_hooks(): array;
  37  }