[Summary view]

Differences Between: [Versions 311 and 401] [Versions 311 and 402] [Versions 311 and 403]

   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 for a list of selectable things.
  19   *
  20   * @package   gradereport_singleview
  21   * @copyright 2014 Moodle Pty Ltd (http://moodle.com)
  22   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace gradereport_singleview\local\screen;
  26  
  27  defined('MOODLE_INTERNAL') || die;
  28  
  29  /**
  30   * Interface for a list of selectable things.
  31   *
  32   * @package   gradereport_singleview
  33   * @copyright 2014 Moodle Pty Ltd (http://moodle.com)
  34   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  35   */
  36  interface selectable_items {
  37      /**
  38       * Get the description of this list
  39       * @return string
  40       */
  41      public function description();
  42  
  43      /**
  44       * Get the label for the select box that chooses items for this page.
  45       * @return string
  46       */
  47      public function select_label();
  48  
  49      /**
  50       * Get the list of options to show.
  51       * @return array
  52       */
  53      public function options();
  54  
  55      /**
  56       * Get type of things in the list (gradeitem or user)
  57       * @return string
  58       */
  59      public function item_type();
  60  }