[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 item.
  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 item.
  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_item_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' => 'Tag id.',
  50              ],
  51              'name' => [
  52                  'type' => PARAM_TAG,
  53                  'description' => 'Tag name.',
  54              ],
  55              'rawname' => [
  56                  'type' => PARAM_RAW,
  57                  'description' => 'The raw, unnormalised name for the tag as entered by users.',
  58              ],
  59              'isstandard' => [
  60                  'type' => PARAM_BOOL,
  61                  'description' => 'Whether this tag is standard.',
  62                  'default' => false,
  63              ],
  64              'tagcollid' => [
  65                  'type' => PARAM_INT,
  66                  'description' => 'Tag collection id.',
  67              ],
  68              'taginstanceid' => [
  69                  'type' => PARAM_INT,
  70                  'description' => 'Tag instance id.',
  71              ],
  72              'taginstancecontextid' => [
  73                  'type' => PARAM_INT,
  74                  'description' => 'Context the tag instance belongs to.',
  75              ],
  76              'itemid' => [
  77                  'type' => PARAM_INT,
  78                  'description' => 'Id of the record tagged.',
  79              ],
  80              'ordering' => [
  81                  'type' => PARAM_INT,
  82                  'description' => 'Tag ordering.',
  83              ],
  84              'flag' => [
  85                  'type' => PARAM_INT,
  86                  'description' => 'Whether the tag is flagged as inappropriate.',
  87                  'default' => 0,
  88                  'null' => NULL_ALLOWED,
  89              ],
  90          ];
  91      }
  92  }