admin/tool/lp/classes/external/path_node_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  * Class for exporting path_node data.
  19  *
  20  * @package    tool_lp
  21  * @copyright  2016 Issam Taboubi <issam.taboubi@umontreal.ca>
  22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23  */
  24 namespace tool_lp\external;
  25 defined('MOODLE_INTERNAL') || die();
  26
  27
  28 /**
  29  * Class for exporting path_node data.
  30  *
  31  * @copyright  2016 Issam Taboubi <issam.taboubi@umontreal.ca>
  32  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  33  */
  34 class path_node_exporter extends exporter {
  35
  36     /**
  37      * Return the list of properties.
  38      *
  39      * @return array
  40      */
  41     protected static function define_properties() {
  42         return [
  43             'id' => [
  44                 'type' => PARAM_INT,
  45                 'null' => NULL_ALLOWED
  46             ],
  47             'name' => [
  48                 'type' => PARAM_TEXT
  49             ],
  50             'first' => [
  51                 'type' => PARAM_BOOL
  52             ],
  53             'last' => [
  54                 'type' => PARAM_BOOL
  55             ],
  56             'position' => [
  57                 'type' => PARAM_INT
  58             ]
  59         ];
  60     }
  61 }