moodle/moodle
3
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-08-07 18:06:51 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

MDL-44017 Events: Deprecated content_viewed event

Browse source 
Replaced content_viewed event with appropriate events and deprecated
content_viewed event
This commit is contained in:
Rajesh Taneja 2014-03-04 16:13:28 +08:00
parent 0a489777fc
commit e1b16f9773
39 changed files with 1291 additions and 453 deletions
Download patch file Download diff file Expand all files Collapse all files

54
report/stats/classes/event/content_viewed.php
View file

@ -1,54 +0,0 @@
<?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 some content in stats report is viewed.
*
* @package report_stats
* @copyright 2013 Ankit Agarwal
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace report_stats\event;
/**
* Event triggered, when some content in stats report is viewed.
*
* @property-read array $other {
* Extra information about event.
*
* @type string content viewed content identifier.
* @type string url (optional) url of report page.
* }
*
* @package report_stats
* @copyright 2013 Ankit Agarwal
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class content_viewed extends \core\event\content_viewed {
/**
* Returns relevant URL.
*
* @return \moodle_url
*/
public function get_url() {
if (!empty($this->other['url'])) {
return new \moodle_url($this->other['url']);
}
return new \moodle_url('report/stats/index.php', array('id' => $this->courseid));
}
}

111
report/stats/classes/event/report_viewed.php Normal file
View file

@ -0,0 +1,111 @@
<?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 when stats report is viewed.
*
* @package report_stats
* @copyright 2013 Ankit Agarwal
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace report_stats\event;
/**
* Event triggered, when stats report is viewed.
*
* @property-read array $other Extra information about the event.
* -int report: (optional) Report type.
* -int time: (optional) Time from which report is viewed.
* -int mode: (optional) Report mode.
*
* @package report_stats
* @copyright 2013 Ankit Agarwal
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class report_viewed extends \core\event\base {
/**
* Init method.
*
* @return void
*/
protected function init() {
$this->data['crud'] = 'r';
$this->data['edulevel'] = self::LEVEL_TEACHING;
}
/**
* Return localised event name.
*
* @return string
*/
public static function get_name() {
return get_string('eventreportviewed', 'report_stats');
}
/**
* Returns description of what happened.
*
* @return string
*/
public function get_description() {
return 'The user with id ' . $this->userid . ' viewed statistics report for course with id ' . $this->courseid;
}
/**
* Return the legacy event log data.
*
* @return array
*/
protected function get_legacy_logdata() {
return array($this->courseid, "course", "report stats", "report/stats/index.php?course=$this->courseid", $this->courseid);
}
/**
* Returns relevant URL.
*
* @return \moodle_url
*/
public function get_url() {
return new \moodle_url('report/stats/index.php', array('id' => $this->courseid, 'mode' => $this->data['other']['mode'],
'report' => $this->data['other']['report']));
}
/**
* Custom validation.
*
* @throws \coding_exception
* @return void
*/
protected function validate_data() {
if (!isset($this->data['other']['report'])) {
throw new \coding_exception('The property report must be set in other.');
}
if (!isset($this->data['other']['time'])) {
throw new \coding_exception('The property time must be set in other.');
}
if (!isset($this->data['other']['mode'])) {
throw new \coding_exception('The property mode must be set in other.');
}
if (!isset($this->data['relateduserid'])) {
throw new \coding_exception('The property relateduserid must be set.');
}
}
}

94
report/stats/classes/event/user_report_viewed.php Normal file
View file

@ -0,0 +1,94 @@
<?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 when user stats report is viewed.
*
* @package report_stats
* @copyright 2013 Ankit Agarwal
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace report_stats\event;
/**
* Event triggered, when user stats report is viewed.
*
* @package report_stats
* @copyright 2013 Ankit Agarwal
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class user_report_viewed extends \core\event\base {
/**
* Init method.
*
* @return void
*/
protected function init() {
$this->data['crud'] = 'r';
$this->data['edulevel'] = self::LEVEL_TEACHING;
}
/**
* Return localised event name.
*
* @return string
*/
public static function get_name() {
return get_string('eventuserreportviewed', 'report_stats');
}
/**
* Returns description of what happened.
*
* @return string
*/
public function get_description() {
return 'The user with id ' . $this->userid . ' viewed user statistics report for user with id ' . $this->relateduserid;
}
/**
* Return the legacy event log data.
*
* @return array
*/
protected function get_legacy_logdata() {
$url = 'report/stats/user.php?id=' . $this->relateduserid . '&course=' . $this->courseid;
return (array($this->courseid, 'course', 'report stats', $url, $this->courseid));
}
/**
* Returns relevant URL.
*
* @return \moodle_url
*/
public function get_url() {
return new \moodle_url('report/stats/user.php', array('id' => $this->relateduserid, 'course' => $this->courseid));
}
/**
* Custom validation.
*
* @throws \coding_exception
* @return void
*/
protected function validate_data() {
if (empty($this->data['relateduserid'])) {
throw new \coding_exception('The property relateduserid must be set.');
}
}
}