[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 an object containing a name and a description.
  19   *
  20   * @package    tool_dataprivacy
  21   * @copyright  2018 Jun Pataleta
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  namespace tool_dataprivacy\external;
  25  defined('MOODLE_INTERNAL') || die();
  26  
  27  use core\external\exporter;
  28  
  29  /**
  30   * Class that exports an object containing a name and a description.
  31   *
  32   * @copyright  2018 Jun Pataleta
  33   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  34   */
  35  class name_description_exporter extends exporter {
  36  
  37      /**
  38       * Returns a list of objects that are related.
  39       *
  40       * @return array
  41       */
  42      protected static function define_related() {
  43          return array(
  44              'context' => 'context',
  45          );
  46      }
  47  
  48      /**
  49       * Return the list of properties.
  50       *
  51       * @return array
  52       */
  53      protected static function define_properties() {
  54          return [
  55              'name' => [
  56                  'type' => PARAM_TEXT,
  57              ],
  58              'description' => [
  59                  'type' => PARAM_TEXT,
  60              ],
  61          ];
  62      }
  63  }