Proyectos de Subversion Moodle

Rev

| Ultima modificación | Ver Log |

Rev Autor Línea Nro. Línea
1 efrain 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 alignment class for displaying a badge alignment.
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 a badge alignment.
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 alignment_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' => 'Alignment id',
50
                'optional' => true,
51
            ],
52
            'badgeid' => [
53
                'type' => PARAM_INT,
54
                'description' => 'Badge id',
55
                'optional' => true,
56
            ],
57
            'targetName' => [
58
                'type' => PARAM_TEXT,
59
                'description' => 'Target name',
60
                'optional' => true,
61
            ],
62
            'targetUrl' => [
63
                'type' => PARAM_URL,
64
                'description' => 'Target URL',
65
                'optional' => true,
66
            ],
67
            'targetDescription' => [
68
                'type' => PARAM_TEXT,
69
                'description' => 'Target description',
70
                'null' => NULL_ALLOWED,
71
                'optional' => true,
72
            ],
73
            'targetFramework' => [
74
                'type' => PARAM_TEXT,
75
                'description' => 'Target framework',
76
                'null' => NULL_ALLOWED,
77
                'optional' => true,
78
            ],
79
            'targetCode' => [
80
                'type' => PARAM_TEXT,
81
                'description' => 'Target code',
82
                'null' => NULL_ALLOWED,
83
                'optional' => true,
84
            ]
85
        ];
86
    }
87
 
88
    /**
89
     * Returns a list of objects that are related.
90
     *
91
     * @return array
92
     */
93
    protected static function define_related() {
94
        return array(
95
            'context' => 'context',
96
        );
97
    }
98
}