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 endorsement class for displaying a badge endorsement.
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 endorsement.
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 endorsement_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' => 'Endorsement id',
50
            ],
51
            'badgeid' => [
52
                'type' => PARAM_INT,
53
                'description' => 'Badge id',
54
            ],
55
            'issuername' => [
56
                'type' => PARAM_TEXT,
57
                'description' => 'Endorsement issuer name',
58
            ],
59
            'issuerurl' => [
60
                'type' => PARAM_URL,
61
                'description' => 'Endorsement issuer URL',
62
            ],
63
            'issueremail' => [
64
                'type' => PARAM_RAW,
65
                'description' => 'Endorsement issuer email',
66
            ],
67
            'claimid' => [
68
                'type' => PARAM_URL,
69
                'description' => 'Claim URL',
70
                'null' => NULL_ALLOWED,
71
            ],
72
            'claimcomment' => [
73
                'type' => PARAM_NOTAGS,
74
                'description' => 'Claim comment',
75
                'null' => NULL_ALLOWED,
76
            ],
77
            'dateissued' => [
78
                'type' => PARAM_INT,
79
                'description' => 'Date issued',
80
                'default' => 0,
81
            ]
82
        ];
83
    }
84
 
85
    /**
86
     * Returns a list of objects that are related.
87
     *
88
     * @return array
89
     */
90
    protected static function define_related() {
91
        return array(
92
            'context' => 'context',
93
        );
94
    }
95
}