forked from moodle/moodle
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
MDL-45752 Course: Add additional events
- Loading branch information
Showing
9 changed files
with
463 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,139 @@ | ||
| <?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/>. | ||
|
|
||
| /** | ||
| * This file contains the class that handles testing of course events. | ||
| * | ||
| * @package core | ||
| * @copyright 2016 Stephen Bourget | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
|
|
||
| defined('MOODLE_INTERNAL') || die(); | ||
|
|
||
| /** | ||
| * This file contains the class that handles testing of course events. | ||
| * | ||
| * @package core_course | ||
| * @copyright 2016 Stephen Bourget | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
| class core_course_events_testcase extends advanced_testcase { | ||
|
|
||
| /** | ||
| * Tests set up | ||
| */ | ||
| protected function setUp() { | ||
| global $CFG; | ||
| require_once($CFG->dirroot . '/course/lib.php'); | ||
| $this->resetAfterTest(); | ||
| } | ||
|
|
||
| /** | ||
| * Test the course category viewed. | ||
| * | ||
| * There is no external API for viewing a category, so the unit test will simply | ||
| * create and trigger the event and ensure data is returned as expected. | ||
| */ | ||
| public function test_course_category_viewed_event() { | ||
|
|
||
| // Create a category. | ||
| $category = $this->getDataGenerator()->create_category(); | ||
|
|
||
| // Trigger an event: course category viewed. | ||
| $eventparams = array( | ||
| 'objectid' => $category->id, | ||
| 'context' => context_system::instance(), | ||
| ); | ||
|
|
||
| $event = \core\event\course_category_viewed::create($eventparams); | ||
| // Trigger and capture the event. | ||
| $sink = $this->redirectEvents(); | ||
| $event->trigger(); | ||
| $events = $sink->get_events(); | ||
| $event = reset($events); | ||
|
|
||
| // Check that the event data is valid. | ||
| $this->assertInstanceOf('\core\event\course_category_viewed', $event); | ||
| $this->assertEquals($category->id, $event->objectid); | ||
| $this->assertDebuggingNotCalled(); | ||
| $sink->close(); | ||
|
|
||
| } | ||
|
|
||
| /** | ||
| * Test the course information viewed. | ||
| * | ||
| * There is no external API for viewing course information so the unit test will simply | ||
| * create and trigger the event and ensure data is returned as expected. | ||
| */ | ||
| public function test_course_information_viewed_event() { | ||
|
|
||
| // Create a course. | ||
| $data = new stdClass(); | ||
| $course = $this->getDataGenerator()->create_course($data); | ||
|
|
||
| // Trigger an event: course category viewed. | ||
| $eventparams = array( | ||
| 'objectid' => $course->id, | ||
| 'context' => context_course::instance($course->id), | ||
| ); | ||
|
|
||
| $event = \core\event\course_information_viewed::create($eventparams); | ||
| // Trigger and capture the event. | ||
| $sink = $this->redirectEvents(); | ||
| $event->trigger(); | ||
| $events = $sink->get_events(); | ||
| $event = reset($events); | ||
|
|
||
| // Check that the event data is valid. | ||
| $this->assertInstanceOf('\core\event\course_information_viewed', $event); | ||
| $this->assertEquals($course->id, $event->objectid); | ||
| $this->assertDebuggingNotCalled(); | ||
| $sink->close(); | ||
|
|
||
| } | ||
|
|
||
| /** | ||
| * Test the courses searched. | ||
| * | ||
| * There is no external API for viewing course information so the unit test will simply | ||
| * create and trigger the event and ensure data is returned as expected. | ||
| */ | ||
| public function test_courses_searched_event() { | ||
|
|
||
| // Trigger an event: courses searched. | ||
| $search = 'mysearch'; | ||
| $eventparams = array( | ||
| 'context' => context_system::instance(), | ||
| 'other' => array('query' => $search) | ||
| ); | ||
|
|
||
| $event = \core\event\courses_searched::create($eventparams); | ||
| // Trigger and capture the event. | ||
| $sink = $this->redirectEvents(); | ||
| $event->trigger(); | ||
| $events = $sink->get_events(); | ||
| $event = reset($events); | ||
|
|
||
| // Check that the event data is valid. | ||
| $this->assertInstanceOf('\core\event\courses_searched', $event); | ||
| $this->assertEquals($search, $event->other['query']); | ||
| $this->assertDebuggingNotCalled(); | ||
| $sink->close(); | ||
|
|
||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| <?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/>. | ||
|
|
||
| /** | ||
| * Course category viewed event. | ||
| * | ||
| * @package core | ||
| * @copyright 2016 Stephen Bourget | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
|
|
||
| namespace core\event; | ||
| defined('MOODLE_INTERNAL') || die(); | ||
|
|
||
| /** | ||
| * Course category viewed event class. | ||
| * | ||
| * @package core | ||
| * @since Moodle 3.2 | ||
| * @copyright 2016 Stephen Bourget | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
| class course_category_viewed extends base { | ||
|
|
||
| /** | ||
| * Initialise the event data. | ||
| */ | ||
| protected function init() { | ||
| $this->data['objecttable'] = 'course_categories'; | ||
| $this->data['crud'] = 'r'; | ||
| $this->data['edulevel'] = self::LEVEL_OTHER; | ||
| } | ||
|
|
||
| /** | ||
| * Returns localised general event name. | ||
| * | ||
| * @return string | ||
| */ | ||
| public static function get_name() { | ||
| return get_string('eventcoursecategoryviewed'); | ||
| } | ||
|
|
||
| /** | ||
| * Returns relevant URL. | ||
| * | ||
| * @return \moodle_url | ||
| */ | ||
| public function get_url() { | ||
| return new \moodle_url('/course/index.php', array('categoryid' => $this->objectid)); | ||
| } | ||
|
|
||
| /** | ||
| * Returns non-localised description of what happened. | ||
| * | ||
| * @return string | ||
| */ | ||
| public function get_description() { | ||
| return "The user with id '$this->userid' viewed the course category with id '$this->objectid'."; | ||
| } | ||
|
|
||
| /** | ||
| * Used for maping events on restore | ||
| * | ||
| * @return bool | ||
| */ | ||
| public static function get_objectid_mapping() { | ||
| // Categories are not backed up, so no need to map them on restore. | ||
| return array('db' => 'course_categories', 'restore' => base::NOT_MAPPED); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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/>. | ||
|
|
||
| /** | ||
| * Course information viewed event. | ||
| * | ||
| * @package core | ||
| * @copyright 2016 Stephen Bourget | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
|
|
||
| namespace core\event; | ||
| defined('MOODLE_INTERNAL') || die(); | ||
|
|
||
| /** | ||
| * Course information viewed event class. | ||
| * | ||
| * Class for event to be triggered when a course information is viewed. | ||
| * | ||
| * @package core | ||
| * @since Moodle 3.2 | ||
| * @copyright 2016 Stephen Bourget | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
| class course_information_viewed extends base { | ||
|
|
||
| /** | ||
| * Init method. | ||
| * | ||
| * @return void | ||
| */ | ||
| protected function init() { | ||
| $this->data['crud'] = 'r'; | ||
| $this->data['edulevel'] = self::LEVEL_PARTICIPATING; | ||
| $this->data['objecttable'] = 'course'; | ||
|
|
||
| } | ||
|
|
||
| /** | ||
| * Returns description of what happened. | ||
| * | ||
| * @return string | ||
| */ | ||
| public function get_description() { | ||
|
|
||
| return "The user with id '$this->userid' viewed the course information for the course with id '$this->courseid'."; | ||
| } | ||
|
|
||
| /** | ||
| * Return localised event name. | ||
| * | ||
| * @return string | ||
| */ | ||
| public static function get_name() { | ||
| return get_string('eventcourseinformationviewed', 'core'); | ||
| } | ||
|
|
||
| /** | ||
| * Get URL related to the action. | ||
| * | ||
| * @return \moodle_url|null | ||
| */ | ||
| public function get_url() { | ||
| return new \moodle_url('/course/info.php', array('id' => $this->objectid)); | ||
| } | ||
|
|
||
| /** | ||
| * Custom validation. | ||
| * | ||
| * @throws \coding_exception | ||
| * @return void | ||
| */ | ||
| protected function validate_data() { | ||
| parent::validate_data(); | ||
|
|
||
| if ($this->contextlevel != CONTEXT_COURSE) { | ||
| throw new \coding_exception('Context level must be CONTEXT_COURSE.'); | ||
| } | ||
| } | ||
|
|
||
| } |
Oops, something went wrong.