diff --git a/mod/resource/lib.php b/mod/resource/lib.php index 943985404e2..b91d1e1bb44 100644 --- a/mod/resource/lib.php +++ b/mod/resource/lib.php @@ -475,3 +475,31 @@ function resource_dndupload_handle($uploadinfo) { return resource_add_instance($data, null); } + +/** + * Mark the activity completed (if required) and trigger the course_module_viewed event. + * + * @param stdClass $resource resource object + * @param stdClass $course course object + * @param stdClass $cm course module object + * @param stdClass $context context object + * @since Moodle 3.0 + */ +function resource_view($resource, $course, $cm, $context) { + + // Trigger course_module_viewed event. + $params = array( + 'context' => $context, + 'objectid' => $resource->id + ); + + $event = \mod_resource\event\course_module_viewed::create($params); + $event->add_record_snapshot('course_modules', $cm); + $event->add_record_snapshot('course', $course); + $event->add_record_snapshot('resource', $resource); + $event->trigger(); + + // Completion. + $completion = new completion_info($course); + $completion->set_module_viewed($cm); +} diff --git a/mod/resource/tests/lib_test.php b/mod/resource/tests/lib_test.php new file mode 100644 index 00000000000..13855c3a1fd --- /dev/null +++ b/mod/resource/tests/lib_test.php @@ -0,0 +1,92 @@ +. + +/** + * Unit tests for mod_resource lib + * + * @package mod_resource + * @category external + * @copyright 2015 Juan Leyva + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @since Moodle 3.0 + */ + +defined('MOODLE_INTERNAL') || die(); + + +/** + * Unit tests for mod_resource lib + * + * @package mod_resource + * @category external + * @copyright 2015 Juan Leyva + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @since Moodle 3.0 + */ +class mod_resource_lib_testcase extends advanced_testcase { + + /** + * Prepares things before this test case is initialised + * @return void + */ + public static function setUpBeforeClass() { + global $CFG; + require_once($CFG->dirroot . '/mod/resource/lib.php'); + } + + /** + * Test resource_view + * @return void + */ + public function test_resource_view() { + global $CFG; + + $CFG->enablecompletion = 1; + $this->resetAfterTest(); + + $this->setAdminUser(); + // Setup test data. + $course = $this->getDataGenerator()->create_course(array('enablecompletion' => 1)); + $resource = $this->getDataGenerator()->create_module('resource', array('course' => $course->id), + array('completion' => 2, 'completionview' => 1)); + $context = context_module::instance($resource->cmid); + $cm = get_coursemodule_from_instance('resource', $resource->id); + + // Trigger and capture the event. + $sink = $this->redirectEvents(); + + resource_view($resource, $course, $cm, $context); + + $events = $sink->get_events(); + // 2 additional events thanks to completion. + $this->assertCount(3, $events); + $event = array_shift($events); + + // Checking that the event contains the expected values. + $this->assertInstanceOf('\mod_resource\event\course_module_viewed', $event); + $this->assertEquals($context, $event->get_context()); + $moodleurl = new \moodle_url('/mod/resource/view.php', array('id' => $cm->id)); + $this->assertEquals($moodleurl, $event->get_url()); + $this->assertEventContextNotUsed($event); + $this->assertNotEmpty($event->get_name()); + + // Check completion status. + $completion = new completion_info($course); + $completiondata = $completion->get_data($cm); + $this->assertEquals(1, $completiondata->completionstate); + + } +} diff --git a/mod/resource/view.php b/mod/resource/view.php index bc55f031870..74bf44d82e8 100644 --- a/mod/resource/view.php +++ b/mod/resource/view.php @@ -24,6 +24,7 @@ */ require('../../config.php'); +require_once($CFG->dirroot.'/mod/resource/lib.php'); require_once($CFG->dirroot.'/mod/resource/locallib.php'); require_once($CFG->libdir.'/completionlib.php'); @@ -52,19 +53,8 @@ require_course_login($course, true, $cm); $context = context_module::instance($cm->id); require_capability('mod/resource:view', $context); -$params = array( - 'context' => $context, - 'objectid' => $resource->id -); -$event = \mod_resource\event\course_module_viewed::create($params); -$event->add_record_snapshot('course_modules', $cm); -$event->add_record_snapshot('course', $course); -$event->add_record_snapshot('resource', $resource); -$event->trigger(); - -// Update 'viewed' state if required by completion system -$completion = new completion_info($course); -$completion->set_module_viewed($cm); +// Completion and trigger events. +resource_view($resource, $course, $cm, $context); $PAGE->set_url('/mod/resource/view.php', array('id' => $cm->id));