mirror of
https://github.com/moodle/moodle.git
synced 2025-08-08 02:16:41 +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:
Rajesh Taneja
parent
0a489777fc
commit
e1b16f9773
39 changed files with 1291 additions and 453 deletions
|
|
@ -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);
|
||||
}
|
||||
}
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue