moodle/moodle
3
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-08-05 17:06:53 +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.');
}
}
}

8
report/stats/graph.php
View file

@ -62,14 +62,6 @@ if (!empty($userid)) {
require_capability('report/stats:view', $coursecontext);
}
// Trigger a content view event.
$event = \report_stats\event\content_viewed::create(array('courseid' => $course->id,
'other' => array('content' => 'stats graph')));
$event->set_page_detail();
$event->set_legacy_logdata(array($course->id, 'course', 'report stats',
"report/stats/graph.php?userid=$userid&id=$course->id&mode=$mode&roleid=$roleid", $course->id));
$event->trigger();
stats_check_uptodate($course->id);
$param = stats_get_parameters($time,$report,$course->id,$mode);

6
report/stats/index.php
View file

@ -69,10 +69,8 @@ $PAGE->set_url(new moodle_url('/report/stats/index.php', array('course' => $cour
navigation_node::override_active_url(new moodle_url('/report/stats/index.php', array('course' => $course->id)));
// Trigger a content view event.
$event = \report_stats\event\content_viewed::create(array('courseid' => $course->id,
'other' => array('content' => 'stats')));
$event->set_page_detail();
$event->set_legacy_logdata(array($course->id, "course", "report stats", "report/stats/index.php?course=$course->id", $course->id));
$event = \report_stats\event\report_viewed::create(array('context' => $context, 'relateduserid' => $userid,
'other' => array('report' => $report, 'time' => $time, 'mode' => $mode)));
$event->trigger();
stats_check_uptodate($course->id);

2
report/stats/lang/en/report_stats.php
View file

@ -23,6 +23,8 @@
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
$string['eventreportviewed'] = 'Statistics report viewed';
$string['eventuserreportviewed'] = 'User statistics report viewed';
$string['pluginname'] = 'Statistics';
$string['page-report-stats-x'] = 'Any statistics report';
$string['page-report-stats-index'] = 'Course statistics report';

151
report/stats/tests/events_test.php Normal file
View file

@ -0,0 +1,151 @@
<?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/>.
/**
* Tests for notes events.
*
* @package core_notes
* @copyright 2013 Ankit Agarwal
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later.
*/
defined('MOODLE_INTERNAL') || die();
/**
* Class core_notes_events_testcase
*
* Class for tests related to notes events.
*
* @package core_notes
* @copyright 2013 Ankit Agarwal
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later.
*/
class core_notes_events_testcase extends advanced_testcase {
/** @var stdClass A note object. */
private $eventnote;
/** @var stdClass A complete record from post table */
private $noterecord;
public function setUp() {
global $DB;
$this->resetAfterTest();
$this->setAdminUser();
$course = $this->getDataGenerator()->create_course();
$user = $this->getDataGenerator()->create_user();
$gen = $this->getDataGenerator()->get_plugin_generator('core_notes');
$this->eventnote = $gen->create_instance(array('courseid' => $course->id, 'userid' => $user->id));
// Get the full record, note_load doesn't return everything.
$this->noterecord = $DB->get_record('post', array('id' => $this->eventnote->id), '*', MUST_EXIST);
}
/**
* Tests for event note_deleted.
*/
public function test_note_deleted_event() {
// Delete a note.
$sink = $this->redirectEvents();
note_delete($this->eventnote);
$events = $sink->get_events();
$event = array_pop($events); // Delete note event.
$sink->close();
// Validate event data.
$this->assertInstanceOf('\core\event\note_deleted', $event);
$this->assertEquals($this->eventnote->id, $event->objectid);
$this->assertEquals($this->eventnote->usermodified, $event->userid);
$this->assertEquals($this->eventnote->userid, $event->relateduserid);
$this->assertEquals('post', $event->objecttable);
$this->assertEquals(null, $event->get_url());
$this->assertEquals($this->noterecord, $event->get_record_snapshot('post', $event->objectid));
$this->assertEquals(NOTES_STATE_SITE, $event->other['publishstate']);
// Test legacy data.
$logurl = new \moodle_url('index.php',
array('course' => $this->eventnote->courseid, 'user' => $this->eventnote->userid));
$logurl->set_anchor('note-' . $this->eventnote->id);
$arr = array($this->eventnote->courseid, 'notes', 'delete', $logurl, 'delete note');
$this->assertEventLegacyLogData($arr, $event);
$this->assertEventContextNotUsed($event);
}
/**
* Tests for event note_created.
*/
public function test_note_created_event() {
// Delete a note.
$sink = $this->redirectEvents();
$note = clone $this->eventnote;
unset($note->id);
note_save($note);
$events = $sink->get_events();
$event = array_pop($events); // Delete note event.
$sink->close();
// Validate event data.
$this->assertInstanceOf('\core\event\note_created', $event);
$this->assertEquals($note->id, $event->objectid);
$this->assertEquals($note->usermodified, $event->userid);
$this->assertEquals($note->userid, $event->relateduserid);
$this->assertEquals('post', $event->objecttable);
$this->assertEquals(NOTES_STATE_SITE, $event->other['publishstate']);
// Test legacy data.
$logurl = new \moodle_url('index.php',
array('course' => $note->courseid, 'user' => $note->userid));
$logurl->set_anchor('note-' . $note->id);
$arr = array($note->courseid, 'notes', 'add', $logurl, 'add note');
$this->assertEventLegacyLogData($arr, $event);
$this->assertEventContextNotUsed($event);
}
/**
* Tests for event note_updated.
*/
public function test_note_updated_event() {
// Delete a note.
$sink = $this->redirectEvents();
$note = clone $this->eventnote;
$note->publishstate = NOTES_STATE_DRAFT;
note_save($note);
$events = $sink->get_events();
$event = array_pop($events); // Delete note event.
$sink->close();
// Validate event data.
$this->assertInstanceOf('\core\event\note_updated', $event);
$this->assertEquals($note->id, $event->objectid);
$this->assertEquals($note->usermodified, $event->userid);
$this->assertEquals($note->userid, $event->relateduserid);
$this->assertEquals('post', $event->objecttable);
$this->assertEquals(NOTES_STATE_DRAFT, $event->other['publishstate']);
// Test legacy data.
$logurl = new \moodle_url('index.php',
array('course' => $note->courseid, 'user' => $note->userid));
$logurl->set_anchor('note-' . $note->id);
$arr = array($note->courseid, 'notes', 'update', $logurl, 'update note');
$this->assertEventLegacyLogData($arr, $event);
$this->assertEventContextNotUsed($event);
}
}

11
report/stats/user.php
View file

@ -59,12 +59,8 @@ $PAGE->set_title("$course->shortname: $stractivityreport");
$PAGE->set_heading($course->fullname);
echo $OUTPUT->header();
// Trigger a content view event.
$event = \report_stats\event\content_viewed::create(array('courseid' => $course->id,
'other' => array('content' => 'user stats')));
$event->set_page_detail();
$event->set_legacy_logdata(array($course->id, 'course', 'report stats',
"report/stats/user.php?id=$user->id&course=$course->id", $course->id));
// Trigger a user report viewed event.
$event = \report_stats\event\user_report_viewed::create(array('context' => $coursecontext, 'relateduserid' => $user->id));
$event->trigger();
if (empty($CFG->enablestats)) {
@ -101,7 +97,8 @@ if (empty($timeoptions)) {
}
// use the earliest.
$time = array_pop(array_keys($timeoptions));
$timekeys = array_keys($timeoptions);
$time = array_pop($timekeys);
$param = stats_get_parameters($time,STATS_REPORT_USER_VIEW,$course->id,STATS_MODE_DETAILED);
$params = $param->params;