badges/classes/external/backpack_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  * Contains competency class for displaying a badge backpack.
  19  *
  20  * @package   core_badges
  21  * @copyright 2019 Damyon Wiese
  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 a badge competency.
  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 backpack_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' => 'Backpack id',
  50             ],
  51             'backpackapiurl' => [
  52                 'type' => PARAM_URL,
  53                 'description' => 'Backpack API URL',
  54             ],
  55             'backpackweburl' => [
  56                 'type' => PARAM_URL,
  57                 'description' => 'Backpack Website URL',
  58             ],
  59             'sitebackpack' => [
  60                 'type' => PARAM_BOOL,
  61                 'description' => 'Is this the current site backpack',
  62             ],
  63             'apiversion' => [
  64                 'type' => PARAM_FLOAT,
  65                 'description' => 'API version supported',
  66             ],
  67             'sortorder' => [
  68                 'type' => PARAM_INT,
  69                 'description' => 'Sort order'
  70             ]
  71         ];
  72     }
  73 }