[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 tag collection.
  19   *
  20   * @package   core_tag
  21   * @copyright 2019 Juan Leyva <juan@moodle.com>
  22   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace core_tag\external;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  use core\external\exporter;
  30  
  31  /**
  32   * Contains related class for displaying information of a tag collection.
  33   *
  34   * @package   core_tag
  35   * @copyright 2019 Juan Leyva <juan@moodle.com>
  36   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  37   */
  38  class tag_collection_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' => 'Collection id.',
  50              ],
  51              'name' => [
  52                  'type' => PARAM_NOTAGS,
  53                  'description' => 'Collection name.',
  54                  'null' => NULL_ALLOWED,
  55              ],
  56              'isdefault' => [
  57                  'type' => PARAM_BOOL,
  58                  'description' => 'Whether is the default collection.',
  59                  'default' => false,
  60              ],
  61              'component' => [
  62                  'type' => PARAM_COMPONENT,
  63                  'description' => 'Component the collection is related to.',
  64                  'null' => NULL_ALLOWED,
  65              ],
  66              'sortorder' => [
  67                  'type' => PARAM_INT,
  68                  'description' => 'Collection ordering in the list.',
  69              ],
  70              'searchable' => [
  71                  'type' => PARAM_BOOL,
  72                  'description' => 'Whether the tag collection is searchable.',
  73                  'default' => true,
  74              ],
  75              'customurl' => [
  76                  'type' => PARAM_NOTAGS,
  77                  'description' => 'Custom URL for the tag page instead of /tag/index.php.',
  78                  'null' => NULL_ALLOWED,
  79              ],
  80          ];
  81      }
  82  }