578645aadf
Includes some minor PHPDocs typo fixes.
106 lines
2.9 KiB
PHP
106 lines
2.9 KiB
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/>.
|
|
|
|
/**
|
|
* mod_chat sessions viewed event.
|
|
*
|
|
* @package mod_chat
|
|
* @copyright 2013 Frédéric Massart
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
namespace mod_chat\event;
|
|
defined('MOODLE_INTERNAL') || die();
|
|
|
|
/**
|
|
* mod_chat sessions viewed event class.
|
|
*
|
|
* @property-read array $other Extra information about the event.
|
|
* -int start: start of period.
|
|
* -int end: end of period.
|
|
*
|
|
* @package mod_chat
|
|
* @copyright 2013 Frédéric Massart
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class sessions_viewed extends \core\event\base {
|
|
|
|
/**
|
|
* Returns description of what happened.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function get_description() {
|
|
return "The user {$this->userid} has viewed the sessions of the chat {$this->objectid}.";
|
|
}
|
|
|
|
/**
|
|
* Return the legacy event log data.
|
|
*
|
|
* @return array|null
|
|
*/
|
|
protected function get_legacy_logdata() {
|
|
return array($this->courseid, 'chat', 'report', 'report.php?id=' . $this->contextinstanceid,
|
|
$this->objectid, $this->contextinstanceid);
|
|
}
|
|
|
|
/**
|
|
* Return localised event name.
|
|
*
|
|
* @return string
|
|
*/
|
|
public static function get_name() {
|
|
return get_string('event_sessions_viewed', 'mod_chat');
|
|
}
|
|
|
|
/**
|
|
* Get URL related to the action
|
|
*
|
|
* @return \moodle_url
|
|
*/
|
|
public function get_url() {
|
|
return new \moodle_url('/mod/chat/report.php', array('id' => $this->contextinstanceid));
|
|
}
|
|
|
|
/**
|
|
* Init method.
|
|
*
|
|
* @return void
|
|
*/
|
|
protected function init() {
|
|
$this->data['crud'] = 'r';
|
|
$this->data['edulevel'] = self::LEVEL_OTHER;
|
|
$this->data['objecttable'] = 'chat';
|
|
}
|
|
|
|
/**
|
|
* Custom validation.
|
|
*
|
|
* @throws \coding_exception
|
|
* @return void
|
|
*/
|
|
protected function validate_data() {
|
|
parent::validate_data();
|
|
if (!isset($this->data['other']['start'])) {
|
|
throw new \coding_exception('The property start must be set in other.');
|
|
}
|
|
if (!isset($this->data['other']['end'])) {
|
|
throw new \coding_exception('The property end must be set in other.');
|
|
}
|
|
}
|
|
|
|
}
|