<?php // This file is part of Moodle - http://moodle.org/ // // Moodle is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // // Moodle is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // // You should have received a copy of the GNU General Public License // along with Moodle. If not, see <http://www.gnu.org/licenses/>. /** * Web service function called event. * * @package core * @copyright 2013 Frédéric Massart * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace core\event; defined('MOODLE_INTERNAL') || die(); /** * Web service function called event class. * * @property-read array $other { * Extra information about event. * * - string function: name of the function. * } * * @package core * @since Moodle 2.6 * @copyright 2013 Frédéric Massart * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class webservice_function_called extends base { /** * Legacy log data. */ protected $legacylogdata; /** * Returns description of what happened. * * @return string */ public function get_description() { return "The web service function '{$this->other['function']}' has been called."; } /**< * Return the legacy event log data. < * < * @return array|null < */ < protected function get_legacy_logdata() { < return $this->legacylogdata; < } < < /*** Return localised event name. * * @return string */ public static function get_name() { return get_string('eventwebservicefunctioncalled', 'webservice'); } /** * Init method. * * @return void */ protected function init() { $this->data['crud'] = 'r'; $this->data['edulevel'] = self::LEVEL_OTHER; $this->context = \context_system::instance();< } < < /** < * Return the legacy event log data. < * < * @param array $legacydata the legacy data to set < */ < public function set_legacy_logdata($legacydata) { < $this->legacylogdata = $legacydata;} /** * Custom validation. * * @throws \coding_exception * @return void */ protected function validate_data() { parent::validate_data(); if (!isset($this->other['function'])) { throw new \coding_exception('The \'function\' value must be set in other.'); } } public static function get_other_mapping() { return false; } }