moodle/moodle
3
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-08-08 10:26:40 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

MDL-44017 Events: Deprecated content_viewed event

Browse source 
Replaced content_viewed event with appropriate events and deprecated
content_viewed event
This commit is contained in:
Rajesh Taneja 2014-03-04 16:13:28 +08:00
parent 0a489777fc
commit e1b16f9773
39 changed files with 1291 additions and 453 deletions
Download patch file Download diff file Expand all files Collapse all files

24
lib/classes/event/content_viewed.php
View file

@ -16,8 +16,11 @@
/**
* Abstract event for content viewing.
*
* This class has been deprecated, please extend base event or other relevent abstract class.
*
* @package core
* @copyright 2013 Ankit Agarwal
* @deprecated since Moodle 2.7
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
@ -25,28 +28,17 @@ namespace core\event;
defined('MOODLE_INTERNAL') || die();
debugging('core\event\content_viewed has been deprecated. Please extend base event or other relevant abstract class.',
DEBUG_DEVELOPER);
/**
* Class content_viewed.
*
* Base class for a content view event. Each plugin must extend this to create their own content view event.
*
* An example usage:-
* $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();
* where \report_participation\event\content_viewed extends \core\event\content_viewed
*
* @property-read array $other {
* Extra information about event.
*
* @type string content viewed content identifier.
* }
* This class has been deprecated, please extend base event or other relevent abstract class.
*
* @package core
* @copyright 2013 Ankit Agarwal
* @deprecated since Moodle 2.7
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
abstract class content_viewed extends base {

16
lib/classes/event/notes_viewed.php
View file

@ -31,17 +31,11 @@ defined('MOODLE_INTERNAL') || die();
*
* Class for event to be triggered when a note is viewed.
*
* @property-read array $other {
* Extra information about event.
*
* @type string content hard-coded to notes.
* }
*
* @package core
* @copyright 2013 Ankit Agarwal
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class notes_viewed extends \core\event\content_viewed {
class notes_viewed extends \core\event\base {
/**
* Set basic properties for the event.
@ -66,7 +60,11 @@ class notes_viewed extends \core\event\content_viewed {
* @return string
*/
public function get_description() {
return 'Note for user with id "'. $this->relateduserid . '" was viewed by user with id "'. $this->userid . '"';
if (!empty($this->relateduserid)) {
return 'Note for user with id "'. $this->relateduserid . '" was viewed by user with id "'. $this->userid . '"';
} else {
return 'Note for course with id "'. $this->courseid . '" was viewed by user with id "'. $this->userid . '"';
}
}
/**
@ -74,7 +72,7 @@ class notes_viewed extends \core\event\content_viewed {
* @return \moodle_url
*/
public function get_url() {
return new \moodle_url('/note/index.php', array('course' => $this->courseid, 'user' => $this->relateduserid));
return new \moodle_url('/notes/index.php', array('course' => $this->courseid, 'user' => $this->relateduserid));
}
/**

96
lib/tests/event_content_viewed_test.php
View file

@ -1,96 +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/>.
/**
* Tests for base content viewed event.
*
* @package core
* @category phpunit
* @copyright 2013 Ankit Agarwal
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
require_once(__DIR__.'/fixtures/event_fixtures.php');
/**
* Class core_event_page_viewed_testcase
*
* Tests for event \core\event\page_viewed
*/
class core_event_content_viewed_testcase extends advanced_testcase {
/**
* Set basic page properties.
*/
public function setUp() {
global $PAGE;
// Set page details.
$PAGE->set_url('/someurl.php');
$PAGE->set_pagelayout('somelayout');
}
/**
* Test event properties and methods.
*/
public function test_event_attributes() {
global $PAGE;
$this->resetAfterTest();
// Trigger the page view event.
$sink = $this->redirectEvents();
$pageevent = \core_tests\event\content_viewed::create(array('other' => array('content' => 'tests')));
$pageevent->set_page_detail(); // Set page details.
$legacydata = array(SITEID, 'site', 'view', 'view.php?id=' . SITEID, SITEID);
$pageevent->set_legacy_logdata($legacydata); // Set legacy data.
$pageevent->trigger();
$result = $sink->get_events();
$event = reset($result);
// Test page details.
$data = array( 'url' => $PAGE->url->out_as_local_url(false),
'heading' => $PAGE->heading,
'title' => $PAGE->title,
'content' => 'tests');
$this->assertEquals($data, $event->other);
// Test legacy stuff.
$this->assertEventLegacyLogData($legacydata, $event);
$pageevent = \core_tests\event\content_viewed::create(array('other' => array('content' => 'tests')));
$pageevent->trigger();
$result = $sink->get_events();
$event = $result[1];
$this->assertEventLegacyLogData(null, $event);
$this->assertEventContextNotUsed($event);
}
/**
* Test custom validations.
*/
public function test_event_context_exception() {
$this->resetAfterTest();
// Make sure content identifier is always set.
$this->setExpectedException('coding_exception');
$pageevent = \core_tests\event\content_viewed::create();
$pageevent->set_page_detail();
$pageevent->trigger();
$this->assertEventContextNotUsed($pageevent);
}
}

9
lib/tests/fixtures/event_fixtures.php vendored
View file

@ -228,15 +228,6 @@ class noname_event extends \core\event\base {
}
}
/**
* Class content_viewed.
*
* Wrapper for testing \core\event\content_viewed .
*/
class content_viewed extends \core\event\content_viewed {
}
/**
* Class course_module_viewed.
*

1
lib/upgrade.txt
View file

@ -9,6 +9,7 @@ DEPRECATIONS:
* $module uses in mod/xxx/version.php files is now deprecated. Please use $plugin instead. It will be removed in Moodle 2.10.
* Update init methods in all event classes - "level" property was renamed to "edulevel", the level property is now deprecated.
* Abstract class \core\event\course_module_instances_list_viewed is deprecated now, use \core\event\instances_list_viewed instead.
* Abstract class core\event\content_viewed has been deprecated. Please extend base event or other relevant abstract class.
* mod_book\event\instances_list_viewed has been deprecated. Please use mod_book\event\course_module_instance_list_viewed instead.
* mod_chat\event\instances_list_viewed has been deprecated. Please use mod_chat\event\course_module_instance_list_viewed instead.
* mod_choice\event\instances_list_viewed has been deprecated. Please use mod_choice\event\course_module_instance_list_viewed instead.