course/classes/external/course_module_chooser_exporter.php

   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  * Author exporter.
  19  *
  20  * @package    core_course
  21  * @copyright  2019 Mihail Geshoski <mihail@moodle.com>
  22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23  */
  24
  25 namespace core_course\external;
  26
  27 defined('MOODLE_INTERNAL') || die();
  28
  29 use core\external\exporter;
  30 use renderer_base;
  31
  32 /**
  33  * Course module chooser exporter.
  34  *
  35  * @copyright  2019 Mihail Geshoski <mihail@moodle.com>
  36  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  37  */
  38 class course_module_chooser_exporter extends exporter {
  39
  40     /** @var array $modules Array containing the available modules */
  41     private $modules;
  42
  43     /**
  44      * Constructor.
  45      *
  46      * @param array $modules The available course modules
  47      * @param array $related The related data for the export
  48      */
  49     public function __construct(array $modules, array $related = []) {
  50         $this->modules = $modules;
  51         return parent::__construct([], $related);
  52     }
  53
  54     /**
  55      * Return the list of additional properties.
  56      *
  57      * @return array
  58      */
  59     protected static function define_other_properties() {
  60         return [
  61             'options' => [
  62                 'multiple' => true,
  63                 'optional' => true,
  64                 'type' => [
  65                     'label' => ['type' => PARAM_TEXT],
  66                     'modulename' => ['type' => PARAM_TEXT],
  67                     'description' => ['type' => PARAM_TEXT],
  68                     'urls' => [
  69                         'type' => [
  70                             'addoption' => [
  71                                 'type' => PARAM_URL
  72                             ]
  73                         ]
  74                     ],
  75                     'icon' => [
  76                         'type' => PARAM_RAW,
  77                         'optional' => true,
  78                         'default' => null,
  79                         'null' => NULL_ALLOWED
  80                     ]
  81                 ]
  82             ]
  83         ];
  84     }
  85
  86     /**
  87      * Get the additional values to inject while exporting.
  88      *
  89      * @param renderer_base $output The renderer.
  90      * @return array Keys are the property names, values are their values.
  91      */
  92     protected function get_other_values(renderer_base $output) {
  93
  94         $options = new \stdClass();
  95         $options->trusted = false;
  96         $options->noclean = false;
  97         $options->smiley = false;
  98         $options->filter = false;
  99         $options->para = true;
 100         $options->newlines = false;
 101         $options->overflowdiv = false;
 102
 103         $context = $this->related['context'];
 104
 105         $modulesdata = [];
 106         foreach ($this->modules as $module) {
 107             $customiconurl = null;
 108
 109             // The property 'name' may contain more than just the module, in which case we need to extract the true module name.
 110             $modulename = $module->name;
 111             if ($colon = strpos($modulename, ':')) {
 112                 $modulename = substr($modulename, 0, $colon);
 113             }
 114
 115             if (isset($module->help) || !empty($module->help)) {
 116                 list($description) = external_format_text((string) $module->help, FORMAT_MARKDOWN,
 117                     $context->id, null, null, null, $options);
 118             } else {
 119                 $description = get_string('nohelpforactivityorresource', 'moodle');
 120             }
 121
 122             $icon = new \pix_icon('icon', '', $modulename);
 123
 124             // When exporting check if the title is an object, we assume it's a lang string object otherwise we send the raw string.
 125             $modulesdata[] = [
 126                 'label' => $module->title instanceof \lang_string ? $module->title->out() : $module->title,
 127                 'modulename' => $modulename,
 128                 'description' => $description,
 129                 'urls' => [
 130                     'addoption' => $module->link->out(false),
 131                 ],
 132                 'icon' => $icon->export_for_template($output)
 133             ];
 134         }
 135
 136         return [
 137             'options' => $modulesdata
 138         ];
 139     }
 140
 141     /**
 142      * Returns a list of objects that are related.
 143      *
 144      * @return array
 145      */
 146     protected static function define_related() {
 147         return [
 148             'context' => 'context'
 149         ];
 150     }
 151 }