Current Path : C:/Users/Mahmood/Desktop/moodle8/lib/classes/event/ |
Current File : C:/Users/Mahmood/Desktop/moodle8/lib/classes/event/cohort_member_added.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/>. /** * User added to a cohort event. * * @package core * @copyright 2013 Dan Poltawski <dan@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace core\event; defined('MOODLE_INTERNAL') || die(); /** * User added to a cohort event class. * * @package core * @since Moodle 2.6 * @copyright 2013 Dan Poltawski <dan@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class cohort_member_added extends base { /** * Init method. * * @return void */ protected function init() { $this->data['crud'] = 'c'; $this->data['edulevel'] = self::LEVEL_OTHER; $this->data['objecttable'] = 'cohort'; } /** * Returns localised general event name. * * @return string */ public static function get_name() { return get_string('eventcohortmemberadded', 'core_cohort'); } /** * Returns description of what happened. * * @return string */ public function get_description() { return "The user with id '$this->userid' added the user with id '$this->relateduserid' to the cohort with " . "id '$this->objectid'."; } /** * Returns relevant URL. * * @return \moodle_url */ public function get_url() { return new \moodle_url('/cohort/assign.php', array('id' => $this->objectid)); } /** * Return legacy event name. * * @return string legacy event name. */ public static function get_legacy_eventname() { return 'cohort_member_added'; } /** * Return legacy event data. * * @return \stdClass */ protected function get_legacy_eventdata() { $data = new \stdClass(); $data->cohortid = $this->objectid; $data->userid = $this->relateduserid; return $data; } /** * Custom validations. * * @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() { // Cohorts are not included in backups, so no mapping is needed for restore. return array('db' => 'cohort', 'restore' => base::NOT_MAPPED); } }