[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  /**
  18   * Class for exporting a course module summary from an stdClass.
  19   *
  20   * @package    core_course
  21   * @copyright  2015 Damyon Wiese
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  namespace core_course\external;
  25  defined('MOODLE_INTERNAL') || die();
  26  
  27  use renderer_base;
  28  
  29  /**
  30   * Class for exporting a course module summary from a cm_info class.
  31   *
  32   * @copyright  2015 Damyon Wiese
  33   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  34   */
  35  class course_module_summary_exporter extends \core\external\exporter {
  36  
  37      protected static function define_related() {
  38          return array('cm' => 'cm_info');
  39      }
  40  
  41      protected function get_other_values(renderer_base $output) {
  42          $cm = $this->related['cm'];
  43  
  44          $values = array(
  45              'id' => $cm->id,
  46              'name' => $cm->name,
  47              'iconurl' => $cm->get_icon_url()->out()
  48          );
  49          if ($cm->url) {
  50              $values['url'] = $cm->url->out();
  51          }
  52          return $values;
  53      }
  54  
  55      /**
  56       * Get the format parameters for name.
  57       *
  58       * @return array
  59       */
  60      protected function get_format_parameters_for_name() {
  61          $cm = $this->related['cm'];
  62          $context = $cm->context;
  63          return [
  64              'context' => $context,
  65          ];
  66      }
  67  
  68      public static function define_other_properties() {
  69          return array(
  70              'id' => array(
  71                  'type' => PARAM_INT,
  72              ),
  73              'name' => array(
  74                  'type' => PARAM_TEXT
  75              ),
  76              'url' => array(
  77                  'type' => PARAM_URL,
  78                  'optional' => true,
  79              ),
  80              'iconurl' => array(
  81                  'type' => PARAM_URL
  82              )
  83          );
  84      }
  85  }