mirror of
https://github.com/moodle/moodle.git
synced 2025-08-05 00:46:50 +02:00
MDL-44017 Events: Deprecated content_viewed event
Replaced content_viewed event with appropriate events and deprecated content_viewed event
This commit is contained in:
parent
0a489777fc
commit
e1b16f9773
39 changed files with 1291 additions and 453 deletions
|
@ -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 log report is viewed.
|
||||
*
|
||||
* @package report_log
|
||||
* @copyright 2013 Ankit Agarwal
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
namespace report_log\event;
|
||||
|
||||
/**
|
||||
* Event triggered, when some content in log 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_log
|
||||
* @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/log/index.php', array('id' => $this->courseid));
|
||||
}
|
||||
}
|
||||
|
120
report/log/classes/event/report_viewed.php
Normal file
120
report/log/classes/event/report_viewed.php
Normal file
|
@ -0,0 +1,120 @@
|
|||
<?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 log report is viewed.
|
||||
*
|
||||
* @package report_log
|
||||
* @copyright 2013 Ankit Agarwal
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
namespace report_log\event;
|
||||
|
||||
/**
|
||||
* Event triggered, when log report is viewed.
|
||||
*
|
||||
* @property-read array $other Extra information about the event.
|
||||
* -int groupid: Group to display.
|
||||
* -int date: Date to display logs from.
|
||||
* -int modid: Module id for which logs were displayed.
|
||||
* -string modaction: Module action.
|
||||
* -string logformat: Log format in which logs were displayed.
|
||||
*
|
||||
* @package report_log
|
||||
* @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_OTHER;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return localised event name.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public static function get_name() {
|
||||
return get_string('eventreportviewed', 'report_log');
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns description of what happened.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function get_description() {
|
||||
return "The user with id " . $this->userid . " viewed log 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 log", "report/log/index.php?id=$this->courseid", $this->courseid);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns relevant URL.
|
||||
*
|
||||
* @return \moodle_url
|
||||
*/
|
||||
public function get_url() {
|
||||
return new \moodle_url('report/log/index.php', array('id' => $this->courseid));
|
||||
}
|
||||
|
||||
/**
|
||||
* Custom validation.
|
||||
*
|
||||
* @throws \coding_exception
|
||||
* @return void
|
||||
*/
|
||||
protected function validate_data() {
|
||||
if (!isset($this->data['other']['groupid'])) {
|
||||
throw new \coding_exception('The property groupid must be set in other.');
|
||||
}
|
||||
|
||||
if (!isset($this->data['other']['date'])) {
|
||||
throw new \coding_exception('The property date must be set in other.');
|
||||
}
|
||||
|
||||
if (!isset($this->data['other']['modid'])) {
|
||||
throw new \coding_exception('The property modid must be set in other.');
|
||||
}
|
||||
|
||||
if (!isset($this->data['other']['modaction'])) {
|
||||
throw new \coding_exception('The property modaction must be set in other.');
|
||||
}
|
||||
|
||||
if (!isset($this->data['other']['logformat'])) {
|
||||
throw new \coding_exception('The property logformat must be set in other.');
|
||||
}
|
||||
|
||||
if (!isset($this->data['relateduserid'])) {
|
||||
throw new \coding_exception('The property relateduserid must be set.');
|
||||
}
|
||||
}
|
||||
}
|
||||
|
102
report/log/classes/event/user_report_viewed.php
Normal file
102
report/log/classes/event/user_report_viewed.php
Normal file
|
@ -0,0 +1,102 @@
|
|||
<?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 user log report is viewed.
|
||||
*
|
||||
* @package report_log
|
||||
* @copyright 2013 Ankit Agarwal
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
namespace report_log\event;
|
||||
|
||||
/**
|
||||
* Event triggered, when user log report is viewed.
|
||||
*
|
||||
* @property-read array $other Extra information about the event.
|
||||
* -string mode: display mode.
|
||||
*
|
||||
* @package report_log
|
||||
* @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_OTHER;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return localised event name.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public static function get_name() {
|
||||
return get_string('eventuserreportviewed', 'report_log');
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns description of what happened.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function get_description() {
|
||||
return 'The user with id ' . $this->userid . ' viewed user log report for user with id ' . $this->relateduserid;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the legacy event log data.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
protected function get_legacy_logdata() {
|
||||
$url = 'report/log/user.php?id=' . $this->relateduserid . '&course=' . $this->courseid . '&mode=' . $this->other['mode'];
|
||||
return array($this->courseid, 'course', 'report log', $url, $this->courseid);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns relevant URL.
|
||||
*
|
||||
* @return \moodle_url
|
||||
*/
|
||||
public function get_url() {
|
||||
return new \moodle_url('report/log/user.php', array('course' => $this->courseid, 'id' => $this->relateduserid,
|
||||
'mode' => $this->other['mode']));
|
||||
}
|
||||
|
||||
/**
|
||||
* Custom validation.
|
||||
*
|
||||
* @throws \coding_exception
|
||||
* @return void
|
||||
*/
|
||||
protected function validate_data() {
|
||||
if (empty($this->data['other']['mode'])) {
|
||||
throw new \coding_exception('The property mode must be set in other.');
|
||||
}
|
||||
|
||||
if (empty($this->data['relateduserid'])) {
|
||||
throw new \coding_exception('The property relateduserid must be set.');
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -67,14 +67,6 @@ if ($type === "userday.png") {
|
|||
}
|
||||
}
|
||||
|
||||
// Trigger a content view event.
|
||||
$event = \report_log\event\content_viewed::create(array('courseid' => $course->id,
|
||||
'other' => array('content' => 'log graph')));
|
||||
$event->set_page_detail();
|
||||
$event->set_legacy_logdata(array($course->id, 'course', 'report log',
|
||||
"report/log/graph.php?user=$user->id&id=$course->id&type=$type&date=$date", $course->id));
|
||||
$event->trigger();
|
||||
|
||||
$logs = array();
|
||||
|
||||
$timenow = time();
|
||||
|
|
|
@ -115,11 +115,10 @@ $context = context_course::instance($course->id);
|
|||
|
||||
require_capability('report/log:view', $context);
|
||||
|
||||
// Trigger a content view event.
|
||||
$event = \report_log\event\content_viewed::create(array('courseid' => $course->id,
|
||||
'other' => array('content' => 'logs')));
|
||||
$event->set_page_detail();
|
||||
$event->set_legacy_logdata(array($course->id, "course", "report log", "report/log/index.php?id=$course->id", $course->id));
|
||||
// Trigger a report viewed event.
|
||||
$event = \report_log\event\report_viewed::create(array('context' => $context, 'relateduserid' => $user,
|
||||
'other' => array('groupid' => $group, 'date' => $date, 'modid' => $modid, 'modaction' => $modaction,
|
||||
'logformat' => $logformat)));
|
||||
$event->trigger();
|
||||
|
||||
if (!empty($page)) {
|
||||
|
|
|
@ -24,6 +24,8 @@
|
|||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
|
||||
$string['eventreportviewed'] = 'Log report viewed';
|
||||
$string['eventuserreportviewed'] = 'User log report viewed';
|
||||
$string['log:view'] = 'View course logs';
|
||||
$string['log:viewtoday'] = 'View today\'s logs';
|
||||
$string['page'] = 'Page {$a}';
|
||||
|
|
151
report/log/tests/events_test.php
Normal file
151
report/log/tests/events_test.php
Normal 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);
|
||||
}
|
||||
}
|
||||
|
|
@ -71,12 +71,9 @@ $PAGE->navigation->set_userid_for_parent_checks($user->id); // see MDL-25805 for
|
|||
$PAGE->set_title("$course->shortname: $stractivityreport");
|
||||
$PAGE->set_heading($course->fullname);
|
||||
|
||||
// Trigger a content view event.
|
||||
$event = \report_log\event\content_viewed::create(array('courseid' => $course->id,
|
||||
'other' => array('content' => 'user logs')));
|
||||
$event->set_page_detail();
|
||||
$event->set_legacy_logdata(array($course->id, 'course', 'report log',
|
||||
"report/log/user.php?id=$user->id&course=$course->id&mode=$mode", $course->id));
|
||||
// Trigger a user logs viewed event.
|
||||
$event = \report_log\event\user_report_viewed::create(array('context' => $coursecontext, 'relateduserid' => $userid,
|
||||
'other' => array('mode' => $mode)));
|
||||
$event->trigger();
|
||||
|
||||
echo $OUTPUT->header();
|
||||
|
|
|
@ -15,7 +15,7 @@
|
|||
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
/**
|
||||
* Event for when some content in loglive report is viewed.
|
||||
* Event for when loglive report is viewed.
|
||||
*
|
||||
* @package report_loglive
|
||||
* @copyright 2013 Ankit Agarwal
|
||||
|
@ -24,20 +24,50 @@
|
|||
namespace report_loglive\event;
|
||||
|
||||
/**
|
||||
* Event triggered, when some content in loglive 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.
|
||||
* }
|
||||
* Event triggered, when loglive report is viewed.
|
||||
*
|
||||
* @package report_loglive
|
||||
* @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 {
|
||||
class report_viewed extends \core\event\base {
|
||||
|
||||
/**
|
||||
* Init method.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
protected function init() {
|
||||
$this->data['crud'] = 'r';
|
||||
$this->data['edulevel'] = self::LEVEL_OTHER;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return localised event name.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public static function get_name() {
|
||||
return get_string('eventreportviewed', 'report_loglive');
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns description of what happened.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function get_description() {
|
||||
return "The user with id " . $this->userid . " viewed live log 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 live', "report/loglive/index.php?id=$this->courseid", $this->courseid);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns relevant URL.
|
||||
|
@ -45,9 +75,6 @@ class content_viewed extends \core\event\content_viewed {
|
|||
* @return \moodle_url
|
||||
*/
|
||||
public function get_url() {
|
||||
if (!empty($this->other['url'])) {
|
||||
return new \moodle_url($this->other['url']);
|
||||
}
|
||||
return new \moodle_url('report/loglive/index.php', array('id' => $this->courseid));
|
||||
}
|
||||
}
|
|
@ -73,11 +73,8 @@ if ($inpopup) {
|
|||
$PAGE->set_heading($strlivelogs);
|
||||
echo $OUTPUT->header();
|
||||
|
||||
// Trigger a content view event.
|
||||
$event = \report_loglive\event\content_viewed::create(array('courseid' => $course->id,
|
||||
'other' => array('content' => 'loglive')));
|
||||
$event->set_page_detail();
|
||||
$event->set_legacy_logdata(array($course->id, 'course', 'report live', "report/loglive/index.php?id=$course->id", $course->id));
|
||||
// Trigger a logs viewed event.
|
||||
$event = \report_loglive\event\report_viewed::create(array('context' => $context));
|
||||
$event->trigger();
|
||||
|
||||
print_log($course, 0, $date, "l.time DESC", $page, 500, $url);
|
||||
|
|
|
@ -24,6 +24,7 @@
|
|||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
|
||||
$string['eventreportviewed'] = 'Live log report viewed';
|
||||
$string['loglive:view'] = 'View live logs';
|
||||
$string['pluginname'] = 'Live logs';
|
||||
$string['livelogs'] = 'Live logs from the past hour';
|
||||
|
|
151
report/loglive/tests/events_test.php
Normal file
151
report/loglive/tests/events_test.php
Normal 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);
|
||||
}
|
||||
}
|
||||
|
80
report/outline/classes/event/activity_viewed.php
Normal file
80
report/outline/classes/event/activity_viewed.php
Normal file
|
@ -0,0 +1,80 @@
|
|||
<?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 activity report is viewed.
|
||||
*
|
||||
* @package report_outline
|
||||
* @copyright 2014 Rajesh Taneja <rajesh@moodle.com>
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
namespace report_outline\event;
|
||||
|
||||
/**
|
||||
* Event when activity report is viewed.
|
||||
*
|
||||
* @package report_outline
|
||||
* @copyright 2014 Rajesh Taneja <rajesh@moodle.com>
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
class activity_viewed extends \core\event\base {
|
||||
|
||||
/**
|
||||
* Init method.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
protected function init() {
|
||||
$this->data['crud'] = 'r';
|
||||
$this->data['edulevel'] = self::LEVEL_OTHER;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return localised event name.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public static function get_name() {
|
||||
return get_string('eventactivityreportviewed', 'report_outline');
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns description of what happened.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function get_description() {
|
||||
return "The user with id " . $this->userid . " viewed activity 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 outline', "report/outline/index.php?id=$this->courseid", $this->courseid);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns relevant URL.
|
||||
*
|
||||
* @return \moodle_url
|
||||
*/
|
||||
public function get_url() {
|
||||
return new \moodle_url('report/outline/index.php', array('course' => $this->courseid));
|
||||
}
|
||||
}
|
|
@ -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 outline report is viewed.
|
||||
*
|
||||
* @package report_outline
|
||||
* @copyright 2013 Ankit Agarwal
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
namespace report_outline\event;
|
||||
|
||||
/**
|
||||
* Event for when some content in outline 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_outline
|
||||
* @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/outline/index.php', array('id' => $this->courseid));
|
||||
}
|
||||
}
|
||||
|
101
report/outline/classes/event/outline_viewed.php
Normal file
101
report/outline/classes/event/outline_viewed.php
Normal file
|
@ -0,0 +1,101 @@
|
|||
<?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 outline report is viewed.
|
||||
*
|
||||
* @package report_outline
|
||||
* @copyright 2013 Ankit Agarwal
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
namespace report_outline\event;
|
||||
|
||||
/**
|
||||
* Event when outline report is viewed.
|
||||
*
|
||||
* @property-read array $other Extra information about the event.
|
||||
* -string mode: display mode.
|
||||
*
|
||||
* @package report_outline
|
||||
* @copyright 2013 Ankit Agarwal
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
class outline_viewed extends \core\event\base {
|
||||
|
||||
/**
|
||||
* Init method.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
protected function init() {
|
||||
$this->data['crud'] = 'r';
|
||||
$this->data['edulevel'] = self::LEVEL_OTHER;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return localised event name.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public static function get_name() {
|
||||
return get_string('eventoutlinereportviewed', 'report_outline');
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns description of what happened.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function get_description() {
|
||||
return "The user with id " . $this->userid . " viewed outline report for user with id " . $this->relateduserid .
|
||||
", for course " . $this->courseid;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the legacy event log data.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
protected function get_legacy_logdata() {
|
||||
$url = "report/outline/user.php?id=". $this->userid . "&course=" . $this->courseid . "&mode=" . $this->other['mode'];
|
||||
return array($this->courseid, 'course', 'report outline', $url, $this->courseid);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns relevant URL.
|
||||
*
|
||||
* @return \moodle_url
|
||||
*/
|
||||
public function get_url() {
|
||||
return new \moodle_url('report/outline/user.php', array('course' => $this->courseid, 'id' => $this->relateduserid,
|
||||
'mode' => $this->other['mode']));
|
||||
}
|
||||
|
||||
/**
|
||||
* Custom validation.
|
||||
*
|
||||
* @throws \coding_exception
|
||||
* @return void
|
||||
*/
|
||||
protected function validate_data() {
|
||||
if (empty($this->data['other']['mode'])) {
|
||||
throw new \coding_exception('The property mode must be set in other.');
|
||||
}
|
||||
if (empty($this->data['relateduserid'])) {
|
||||
throw new \coding_exception('The property relateduserid must be set.');
|
||||
}
|
||||
}
|
||||
}
|
|
@ -38,10 +38,7 @@ $context = context_course::instance($course->id);
|
|||
require_capability('report/outline:view', $context);
|
||||
|
||||
// Trigger a content view event.
|
||||
$event = \report_outline\event\content_viewed::create(array('courseid' => $course->id,
|
||||
'other' => array('content' => 'outline')));
|
||||
$event->set_page_detail();
|
||||
$event->set_legacy_logdata(array($course->id, 'course', 'report outline', "report/outline/index.php?id=$course->id", $course->id));
|
||||
$event = \report_outline\event\activity_viewed::create(array('context' => $context));
|
||||
$event->trigger();
|
||||
|
||||
$showlastaccess = true;
|
||||
|
|
|
@ -23,6 +23,8 @@
|
|||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
|
||||
$string['eventactivityreportviewed'] = 'Activity report viewed';
|
||||
$string['eventoutlinereportviewed'] = 'Outline report viewed';
|
||||
$string['outline:view'] = 'View activity report';
|
||||
$string['page-report-outline-x'] = 'Any outline report';
|
||||
$string['page-report-outline-index'] = 'Course outline report';
|
||||
|
|
|
@ -63,12 +63,9 @@ $PAGE->navigation->set_userid_for_parent_checks($user->id); // see MDL-25805 for
|
|||
$PAGE->set_title("$course->shortname: $stractivityreport");
|
||||
$PAGE->set_heading($course->fullname);
|
||||
|
||||
// Trigger a content view event.
|
||||
$event = \report_outline\event\content_viewed::create(array('courseid' => $course->id,
|
||||
'other' => array('content' => 'user outline')));
|
||||
$event->set_page_detail();
|
||||
$event->set_legacy_logdata(array($course->id, 'course', 'report outline',
|
||||
"report/outline/user.php?id=$user->id&course=$course->id&mode=$mode", $course->id));
|
||||
// Trigger a report viewed event.
|
||||
$event = \report_outline\event\outline_viewed::create(array('context' => context_course::instance($course->id),
|
||||
'relateduserid' => $userid, 'other' => array('mode' => $mode)));
|
||||
$event->trigger();
|
||||
|
||||
echo $OUTPUT->header();
|
||||
|
|
|
@ -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
118
report/participation/classes/event/report_viewed.php
Normal 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.');
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -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];
|
||||
|
||||
|
|
|
@ -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';
|
||||
|
|
|
@ -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
111
report/stats/classes/event/report_viewed.php
Normal 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
94
report/stats/classes/event/user_report_viewed.php
Normal 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.');
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -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);
|
||||
|
|
|
@ -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);
|
||||
|
||||
|
|
|
@ -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
151
report/stats/tests/events_test.php
Normal 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);
|
||||
}
|
||||
}
|
||||
|
|
@ -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;
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue