[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 course module 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  
  29  
  30  /**
  31   * Class for exporting a course module summary from a cm_info class.
  32   *
  33   * @copyright  2015 Damyon Wiese
  34   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  35   */
  36  class course_module_summary_exporter extends \core_competency\external\exporter {
  37  
  38      protected static function define_related() {
  39          return array('cm' => 'cm_info');
  40      }
  41  
  42      protected function get_other_values(renderer_base $output) {
  43          $cm = $this->related['cm'];
  44          $context = $cm->context;
  45  
  46          $values = array(
  47              'id' => $cm->id,
  48              'name' => external_format_string($cm->name, $context->id),
  49              'iconurl' => $cm->get_icon_url()->out()
  50          );
  51          if ($cm->url) {
  52              $values['url'] = $cm->url->out();
  53          }
  54          return $values;
  55      }
  56  
  57  
  58      public static function define_other_properties() {
  59          return array(
  60              'id' => array(
  61                  'type' => PARAM_INT,
  62              ),
  63              'name' => array(
  64                  'type' => PARAM_TEXT
  65              ),
  66              'url' => array(
  67                  'type' => PARAM_URL,
  68                  'optional' => true,
  69              ),
  70              'iconurl' => array(
  71                  'type' => PARAM_URL
  72              )
  73          );
  74      }
  75  }