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
 * Web service function called event.
19
 *
20
 * @package    core
21
 * @copyright  2013 Frédéric Massart
22
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23
 */
24
 
25
namespace core\event;
26
defined('MOODLE_INTERNAL') || die();
27
 
28
/**
29
 * Web service function called event class.
30
 *
31
 * @property-read array $other {
32
 *      Extra information about event.
33
 *
34
 *      - string function: name of the function.
35
 * }
36
 *
37
 * @package    core
38
 * @since      Moodle 2.6
39
 * @copyright  2013 Frédéric Massart
40
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
41
 */
42
class webservice_function_called extends base {
43
 
44
    /**
45
     * Legacy log data.
46
     */
47
    protected $legacylogdata;
48
 
49
    /**
50
     * Returns description of what happened.
51
     *
52
     * @return string
53
     */
54
    public function get_description() {
55
        return "The web service function '{$this->other['function']}' has been called.";
56
    }
57
 
58
    /**
59
     * Return localised event name.
60
     *
61
     * @return string
62
     */
63
    public static function get_name() {
64
        return get_string('eventwebservicefunctioncalled', 'webservice');
65
    }
66
 
67
    /**
68
     * Init method.
69
     *
70
     * @return void
71
     */
72
    protected function init() {
73
        $this->data['crud'] = 'r';
74
        $this->data['edulevel'] = self::LEVEL_OTHER;
75
        $this->context = \context_system::instance();
76
    }
77
 
78
    /**
79
     * Custom validation.
80
     *
81
     * @throws \coding_exception
82
     * @return void
83
     */
84
    protected function validate_data() {
85
        parent::validate_data();
86
        if (!isset($this->other['function'])) {
87
           throw new \coding_exception('The \'function\' value must be set in other.');
88
        }
89
    }
90
 
91
    public static function get_other_mapping() {
92
        return false;
93
    }
94
}