[Summary view] [Print] [Text 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   * Class for exporting a cohort summary from an stdClass.
  19   *
  20   * @package    tool_lp
  21   * @copyright  2015 Damyon Wiese
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  namespace tool_lp\external;
  25  defined('MOODLE_INTERNAL') || die();
  26  
  27  use renderer_base;
  28  use moodle_url;
  29  
  30  /**
  31   * Class for exporting a cohort summary from an stdClass.
  32   *
  33   * @copyright  2015 Damyon Wiese
  34   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  35   */
  36  class cohort_summary_exporter extends \core_competency\external\exporter {
  37  
  38      protected static function define_related() {
  39          // Cohorts can exist on a category context.
  40          return array('context' => '\\context');
  41      }
  42  
  43      public static function define_properties() {
  44          return array(
  45              'id' => array(
  46                  'type' => PARAM_INT,
  47              ),
  48              'name' => array(
  49                  'type' => PARAM_TEXT,
  50              ),
  51              'idnumber' => array(
  52                  'type' => PARAM_RAW,        // ID numbers are plain text.
  53                  'default' => ''
  54              ),
  55              'visible' => array(
  56                  'type' => PARAM_BOOL,
  57              )
  58          );
  59      }
  60  
  61      public static function define_other_properties() {
  62          return array(
  63              'contextname' => array(
  64                  'type' => PARAM_TEXT
  65              ),
  66          );
  67      }
  68  
  69      protected function get_other_values(renderer_base $output) {
  70          return array(
  71              'contextname' => $this->related['context']->get_context_name()
  72          );
  73      }
  74  }