moodle/moodle
3
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-08-08 10:26:40 +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/participation/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 participation report is viewed.
*
* @package report_participation
* @copyright 2013 Ankit Agarwal
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace report_participation\event;
/**
* Event triggered, when some content in participation 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_participation
* @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/participation/index.php', array('id' => $this->courseid));
}
}

118
report/participation/classes/event/report_viewed.php Normal file
View file

@ -0,0 +1,118 @@
<?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 participation report is viewed.
*
* @package report_participation
* @copyright 2013 Ankit Agarwal
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace report_participation\event;
/**
* Event triggered, when some content in participation report is viewed.
*
* @property-read array $other Extra information about the event.
* -int instanceid: Id of instance.
* -int roleid: Role id for whom report is viewed.
* -int groupid: (optional) group id.
* -int timefrom: (optional) time from which report is viewed.
* -string action: (optional) action viewed.
*
* @package report_participation
* @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_participation');
}
/**
* Returns description of what happened.
*
* @return string
*/
public function get_description() {
return "The user with id " . $this->userid . " viewed course participation 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 participation", "report/participation/index.php?id=" . $this->courseid,
$this->courseid);
}
/**
* Returns relevant URL.
*
* @return \moodle_url
*/
public function get_url() {
return new \moodle_url('report/participation/index.php', array('id' => $this->courseid,
'instanceid' => $this->data['other']['instanceid'], 'roleid' => $this->data['other']['roleid']));
}
/**
* Custom validation.
*
* @throws \coding_exception
* @return void
*/
protected function validate_data() {
if (empty($this->data['other']['instanceid'])) {
throw new \coding_exception('The property instanceid must be set in other.');
}
if (empty($this->data['other']['roleid'])) {
throw new \coding_exception('The property roleid must be set in other.');
}
if (!isset($this->data['other']['groupid'])) {
throw new \coding_exception('The property groupid must be set in other.');
}
if (!isset($this->data['other']['timefrom'])) {
throw new \coding_exception('The property timefrom must be set in other.');
}
if (!isset($this->data['other']['action'])) {
throw new \coding_exception('The property action must be set in other.');
}
}
}

15
report/participation/index.php
View file

@ -83,14 +83,6 @@ $PAGE->set_title($course->shortname .': '. $strparticipation);
$PAGE->set_heading($course->fullname);
echo $OUTPUT->header();
// Trigger a content view event.
$event = \report_participation\event\content_viewed::create(array('courseid' => $course->id,
'other' => array('content' => 'participants')));
$event->set_page_detail();
$event->set_legacy_logdata(array($course->id, "course", "report participation",
"report/participation/index.php?id=$course->id", $course->id));
$event->trigger();
$modinfo = get_fast_modinfo($course);
$modules = $DB->get_records_select('modules', "visible = 1", null, 'name ASC');
@ -181,6 +173,13 @@ $groupmode = groups_get_course_groupmode($course);
$currentgroup = $SESSION->activegroup[$course->id][$groupmode][$course->defaultgroupingid];
if (!empty($instanceid) && !empty($roleid)) {
// Trigger a report viewed event.
$event = \report_participation\event\report_viewed::create(array('context' => $context,
'other' => array('instanceid' => $instanceid, 'groupid' => $currentgroup, 'roleid' => $roleid,
'timefrom' => $timefrom, 'action' => $action)));
$event->trigger();
// from here assume we have at least the module we're using.
$cm = $modinfo->cms[$instanceid];

1
report/participation/lang/en/report_participation.php
View file

@ -23,6 +23,7 @@
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
$string['eventreportviewed'] = 'Participation report viewed';
$string['participation:view'] = 'View course participation report';
$string['page-report-participation-x'] = 'Any participation report';
$string['page-report-participation-index'] = 'Course participation report';