Current Path : C:/Users/Mahmood/Desktop/moodle8/lib/classes/event/ |
Current File : C:/Users/Mahmood/Desktop/moodle8/lib/classes/event/note_created.php |
<?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/>. /** * Event for when a new note entry is added. * * @package core * @copyright 2013 Ankit Agarwal * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace core\event; defined('MOODLE_INTERNAL') || die(); /** * Class note_created * * Class for event to be triggered when a note is created. * * @property-read array $other { * Extra information about event. * * - string publishstate: (optional) the publish state. * } * * @package core * @since Moodle 2.6 * @copyright 2013 Ankit Agarwal * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class note_created extends base { /** * Set basic properties for the event. */ protected function init() { $this->data['objecttable'] = 'post'; $this->data['crud'] = 'c'; $this->data['edulevel'] = self::LEVEL_OTHER; } /** * Returns localised general event name. * * @return string */ public static function get_name() { return get_string("eventnotecreated", "core_notes"); } /** * Returns non-localised event description with id's for admin use only. * * @return string */ public function get_description() { return "The user with id '$this->userid' created the note with id '$this->objectid' for the user with id " . "'$this->relateduserid'."; } /** * Returns relevant URL. * @return \moodle_url */ public function get_url() { $logurl = new \moodle_url('/notes/index.php', array('course' => $this->courseid, 'user' => $this->relateduserid)); $logurl->set_anchor('note-' . $this->objectid); return $logurl; } /** * replace add_to_log() statement. * * @return array of parameters to be passed to legacy add_to_log() function. */ protected function get_legacy_logdata() { $logurl = new \moodle_url('index.php', array('course' => $this->courseid, 'user' => $this->relateduserid)); $logurl->set_anchor('note-' . $this->objectid); return array($this->courseid, 'notes', 'add', $logurl, 'add note'); } /** * Custom validation. * * @throws \coding_exception * @return void */ protected function validate_data() { parent::validate_data(); if (!isset($this->relateduserid)) { throw new \coding_exception('The \'relateduserid\' must be set.'); } } public static function get_objectid_mapping() { // Notes are not backed up, so no need to map on restore. return array('db' => 'post', 'restore' => base::NOT_MAPPED); } public static function get_other_mapping() { // Nothing to map. return false; } }