Skip to content

Commit

Permalink
MDL-45219 add course recent_activity_viewed event
Browse files Browse the repository at this point in the history
  • Loading branch information
skodak committed Apr 23, 2014
1 parent f40d61c commit dce7ec4
Show file tree
Hide file tree
Showing 4 changed files with 123 additions and 3 deletions.
5 changes: 2 additions & 3 deletions course/recent.php
Expand Up @@ -37,11 +37,10 @@
}

require_login($course);

add_to_log($course->id, "course", "recent", "recent.php?id=$course->id", $course->id);

$context = context_course::instance($course->id);

\core\event\recent_activity_viewed::create(array('context' => $context))->trigger();

$lastlogin = time() - COURSE_MAX_RECENT_PERIOD;
if (!isguestuser() and !empty($USER->lastcourseaccess[$COURSE->id])) {
if ($USER->lastcourseaccess[$COURSE->id] > $lastlogin) {
Expand Down
1 change: 1 addition & 0 deletions lang/en/moodle.php
Expand Up @@ -741,6 +741,7 @@
$string['eventcourseviewed'] = 'Course viewed';
$string['eventemailfailed'] = 'Email failed to send';
$string['eventname'] = 'Event name';
$string['eventrecentactivityviewed'] = 'Recent activity viewed';
$string['eventunknownlogged'] = 'Unknown event';
$string['eventusercreated'] = 'User created';
$string['eventuserdeleted'] = 'User deleted';
Expand Down
95 changes: 95 additions & 0 deletions lib/classes/event/recent_activity_viewed.php
@@ -0,0 +1,95 @@
<?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 recent activity page.
*
* @package core
* @copyright 2014 Petr Skoda
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace core\event;

/**
* Event for recent activity page.
*
* @package core
* @since Moodle 2.7
* @copyright 2014 Petr Skoda
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class recent_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('eventrecentactivityviewed', 'core');
}

/**
* Returns description of what happened.
*
* @return string
*/
public function get_description() {
return "The user with id " . $this->userid . " viewed recent activity report in course " . $this->courseid;
}

/**
* Return the legacy event log data.
*
* @return array
*/
protected function get_legacy_logdata() {
return array($this->courseid, "course", "recent", "recent.php?id=$this->courseid", $this->courseid);
}

/**
* Returns relevant URL.
*
* @return \moodle_url
*/
public function get_url() {
return new \moodle_url('/course/recent.php', array('id' => $this->courseid));
}

/**
* Custom validation.
*
* @throws \coding_exception
*/
protected function validate_data() {
parent::validate_data();

if ($this->contextlevel != CONTEXT_COURSE) {
throw new \coding_exception('recent_activity_viewed event expects only course contexts.');
}
}
}

25 changes: 25 additions & 0 deletions lib/tests/events_test.php
Expand Up @@ -262,4 +262,29 @@ public function test_course_viewed() {
$this->assertInstanceOf('\core\event\course_viewed', $restored);
$this->assertNull($restored->get_url());
}

public function test_recent_capability_viewed() {
$this->resetAfterTest();

$this->setAdminUser();
$course = $this->getDataGenerator()->create_course();
$context = context_course::instance($course->id);

$event = \core\event\recent_activity_viewed::create(array('context' => $context));

// Trigger and capture the event.
$sink = $this->redirectEvents();
$event->trigger();
$events = $sink->get_events();
$event = reset($events);

$this->assertInstanceOf('\core\event\recent_activity_viewed', $event);
$this->assertEquals($context, $event->get_context());
$expected = array($course->id, "course", "recent", "recent.php?id=$course->id", $course->id);
$this->assertEventLegacyLogData($expected, $event);
$this->assertEventContextNotUsed($event);
$url = new moodle_url('/course/recent.php', array('id' => $course->id));
$this->assertEquals($url, $event->get_url());
$event->get_name();
}
}

0 comments on commit dce7ec4

Please sign in to comment.