Current Path : /var/www/ljmtc/cbt/mod/grouptool/classes/event/ |
Current File : /var/www/ljmtc/cbt/mod/grouptool/classes/event/agrp_deleted.php |
<?php // This file is part of mod_grouptool for Moodle - http://moodle.org/ // // It 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. // // It 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/>. /** * The mod_grouptool_agrp_deleted event. * * @package mod_grouptool * @author Philipp Hager * @copyright 2014 Academic Moodle Cooperation {@link http://www.academic-moodle-cooperation.org} * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace mod_grouptool\event; defined('MOODLE_INTERNAL') || die(); /** * The \mod_grouptool\agrp_deleted class holds the logic for the event. * * @package mod_grouptool * @author Philipp Hager * @copyright 2014 Academic Moodle Cooperation {@link http://www.academic-moodle-cooperation.org} * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class agrp_deleted extends \core\event\base { /** * Init method. * * @return void */ protected function init() { $this->data['crud'] = 'd'; $this->data['edulevel'] = self::LEVEL_TEACHING; $this->data['objecttable'] = 'grouptool_agrps'; } /** * Create object from data object and set properties. * * @param \stdClass $data event data * @return \core\event\base event object * @throws \coding_exception */ public static function create_from_object(\stdClass $data) { $event = self::create([ 'objectid' => $data->id, 'context' => \context_module::instance($data->cmid), 'other' => $data ]); return $event; } /** * Get URL related to the action. * * @return \moodle_url * @throws \moodle_exception */ public function get_url() { return new \moodle_url("/mod/$this->objecttable/view.php", ['id' => $this->contextinstanceid, 'tab' => 'overview']); } /** * Return the legacy event log data. * * @return array|null */ protected function get_legacy_logdata() { return [ $this->courseid, $this->objecttable, 'agrp deleted id \''.$this->data['other']->agrpid.'\'', 'view.php?id=' . $this->contextinstanceid.'&tab=overview', $this->objectid, $this->contextinstanceid ]; } /** * Returns description of what happened. * * @return string */ public function get_description() { return "The active group with id '".$this->data['other']->agrpid."' ". "representing group with id '".$this->data['other']->groupid."' ". "in grouptool with the course module id '$this->contextinstanceid' has been deleted."; } /** * Return localised event name. * * @return string * @throws \coding_exception */ public static function get_name() { return get_string('eventagrpdeleted', 'grouptool'); } /** * Custom validation. * * @throws \coding_exception * @return void */ protected function validate_data() { parent::validate_data(); // Make sure this class is never used without proper object details. if (empty($this->objectid) || empty($this->objecttable)) { throw new \coding_exception('The agrp_deleted event must define objectid and object table.'); } // Make sure the context level is set to module. if ($this->contextlevel != CONTEXT_MODULE) { throw new \coding_exception('Context level must be CONTEXT_MODULE.'); } if (empty($this->data['other']->cmid)) { throw new \coding_exception('CMID must be specified.'); } if (empty($this->data['other']->groupid)) { throw new \coding_exception('Group-ID must be specified.'); } if (empty($this->data['other']->agrpid)) { throw new \coding_exception('Active-Group-ID must be specified.'); } } }