[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   * Contains related class for displaying information of a related badge.
  19   *
  20   * @package   core_badges
  21   * @copyright 2018 Dani Palou <dani@moodle.com>
  22   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace core_badges\external;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  use core\external\exporter;
  30  
  31  /**
  32   * Class for displaying information of a related badge.
  33   *
  34   * @package   core_badges
  35   * @copyright 2018 Dani Palou <dani@moodle.com>
  36   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  37   */
  38  class related_info_exporter extends exporter {
  39  
  40      /**
  41       * Return the list of properties.
  42       *
  43       * @return array
  44       */
  45      protected static function define_properties() {
  46          return [
  47              'id' => [
  48                  'type' => PARAM_INT,
  49                  'description' => 'Badge id',
  50              ],
  51              'name' => [
  52                  'type' => PARAM_TEXT,
  53                  'description' => 'Badge name',
  54              ],
  55              'version' => [
  56                  'type' => PARAM_TEXT,
  57                  'description' => 'Version',
  58                  'optional' => true,
  59                  'null' => NULL_ALLOWED,
  60              ],
  61              'language' => [
  62                  'type' => PARAM_NOTAGS,
  63                  'description' => 'Language',
  64                  'optional' => true,
  65                  'null' => NULL_ALLOWED,
  66              ],
  67              'type' => [
  68                  'type' => PARAM_INT,
  69                  'description' => 'Type',
  70                  'optional' => true,
  71              ],
  72          ];
  73      }
  74  
  75      /**
  76       * Returns a list of objects that are related.
  77       *
  78       * @return array
  79       */
  80      protected static function define_related() {
  81          return array(
  82              'context' => 'context',
  83          );
  84      }
  85  }