. /** * The mod_forum subscription deleted event. * * @package mod_forum * @copyright 2014 Dan Poltawski * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace mod_forum\event; defined('MOODLE_INTERNAL') || die(); /** * The mod_forum subscription deleted event class. * * @property-read array $other { * Extra information about the event. * * - int forumid: The id of the forum which has been unsusbcribed from. * } * * @package mod_forum * @since Moodle 2.7 * @copyright 2014 Dan Poltawski * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class subscription_deleted extends \core\event\base { /** * Init method. * * @return void */ protected function init() { $this->data['crud'] = 'd'; $this->data['edulevel'] = self::LEVEL_PARTICIPATING; $this->data['objecttable'] = 'forum_subscriptions'; } /** * Returns description of what happened. * * @return string */ public function get_description() { return "The user with id '$this->userid' unsubscribed the user with id '$this->relateduserid' to the forum with " . "course module id '$this->contextinstanceid'."; } /** * Return localised event name. * * @return string */ public static function get_name() { return get_string('eventsubscriptiondeleted', 'mod_forum'); } /** * Get URL related to the action * * @return \moodle_url */ public function get_url() { return new \moodle_url('/mod/forum/subscribers.php', array('id' => $this->other['forumid'])); } /** * Return the legacy event log data. * * @return array|null */ protected function get_legacy_logdata() { return array($this->courseid, 'forum', 'unsubscribe', 'view.php?f=' . $this->other['forumid'], $this->other['forumid'], $this->contextinstanceid); } /** * 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.'); } if (!isset($this->other['forumid'])) { throw new \coding_exception('The \'forumid\' value must be set in other.'); } if ($this->contextlevel != CONTEXT_MODULE) { throw new \coding_exception('Context level must be CONTEXT_MODULE.'); } } }