[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 editor_tiny;
  18  
  19  use context;
  20  
  21  /**
  22   * An interface representing a plugin with menu items.
  23   *
  24   * @package    editor_tiny
  25   * @copyright  2021 Andrew Lyons <andrew@nicols.co.uk>
  26   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  27   */
  28  interface plugin_with_configuration {
  29      /**
  30       * Get a list of the menu items provided by this plugin.
  31       *
  32       * @param context $context The context that the editor is used within
  33       * @param array $options The options passed in when requesting the editor
  34       * @param array $fpoptions The filepicker options passed in when requesting the editor
  35       * @param editor $editor The editor instance in which the plugin is initialised
  36       * @return array
  37       */
  38      public static function get_plugin_configuration_for_context(
  39          context $context,
  40          array $options,
  41          array $fpoptions,
  42          ?editor $editor = null
  43      ): array;
  44  }