/** * Mark the activity completed (if required) and trigger the course_module_viewed event. * * @param stdClass $book book object * @param stdClass $chapter chapter object * @param bool $islaschapter is the las chapter of the book? * @param stdClass $course course object * @param stdClass $cm course module object * @param stdClass $context context object * @since Moodle 3.0 */ function book_view($book, $chapter, $islastchapter, $course, $cm, $context) { // First case, we are just opening the book. if (empty($chapter)) { \mod_book\event\course_module_viewed::create_from_book($book, $context)->trigger(); } else { \mod_book\event\chapter_viewed::create_from_chapter($book, $context, $chapter)->trigger(); if ($islastchapter) { // We cheat a bit here in assuming that viewing the last page means the user viewed the whole book. $completion = new completion_info($course); $completion->set_module_viewed($cm); } } }
public function test_course_module_viewed() { // There is no proper API to call to trigger this event, so what we are // doing here is simply making sure that the events returns the right information. $course = $this->getDataGenerator()->create_course(); $book = $this->getDataGenerator()->create_module('book', array('course' => $course->id)); $params = array('context' => context_module::instance($book->cmid), 'objectid' => $book->id); $event = \mod_book\event\course_module_viewed::create($params); // Triggering and capturing the event. $sink = $this->redirectEvents(); $event->trigger(); $events = $sink->get_events(); $this->assertCount(1, $events); $event = reset($events); // Checking that the event contains the expected values. $this->assertInstanceOf('\\mod_book\\event\\course_module_viewed', $event); $this->assertEquals(context_module::instance($book->cmid), $event->get_context()); $this->assertEquals($book->id, $event->objectid); $expected = array($course->id, 'book', 'view', 'view.php?id=' . $book->cmid, $book->id, $book->cmid); $this->assertEventLegacyLogData($expected, $event); $this->assertEventContextNotUsed($event); }
/** * Tests for replace_placeholders method. */ public function test_replace_placeholders() { global $USER; $this->resetAfterTest(); $this->setAdminUser(); $msgsink = $this->redirectMessages(); // Generate data. $course = $this->getDataGenerator()->create_course(); $toolgenerator = $this->getDataGenerator()->get_plugin_generator('tool_monitor'); $context = \context_user::instance($USER->id, IGNORE_MISSING); // Creating book. $cm = new stdClass(); $cm->course = $course->id; $book = $this->getDataGenerator()->create_module('book', $cm); // Creating rule. $rulerecord = new stdClass(); $rulerecord->courseid = $course->id; $rulerecord->eventname = '\\mod_book\\event\\course_module_viewed'; $rulerecord->cmid = $book->cmid; $rulerecord->frequency = 1; $rulerecord->template = '## {link} ## * {modulelink} * __{rulename}__ * {description} * {eventname}'; $rulerecord->templateformat = FORMAT_MARKDOWN; $rule = $toolgenerator->create_rule($rulerecord); // Creating subscription. $subrecord = new stdClass(); $subrecord->courseid = $course->id; $subrecord->ruleid = $rule->id; $subrecord->userid = $USER->id; $toolgenerator->create_subscription($subrecord); // Now let us trigger the event. $params = array('context' => context_module::instance($book->cmid), 'objectid' => $book->id); $event = \mod_book\event\course_module_viewed::create($params); $event->trigger(); $this->run_adhock_tasks(); $msgs = $msgsink->get_messages(); $msg = array_pop($msgs); $modurl = new moodle_url('/mod/book/view.php', array('id' => $book->cmid)); $this->assertContains('<h2>' . $event->get_url()->out() . '</h2>', $msg->fullmessagehtml); $this->assertContains('<li>' . $modurl->out() . '</li>', $msg->fullmessagehtml); $this->assertContains('<li><strong>' . $rule->get_name($context) . '</strong></li>', $msg->fullmessagehtml); $this->assertContains('<li>' . $rule->get_description($context) . '</li>', $msg->fullmessagehtml); $this->assertContains('<li>' . $rule->get_event_name() . '</li>', $msg->fullmessagehtml); $this->assertEquals(FORMAT_PLAIN, $msg->fullmessageformat); $this->assertNotContains('<h2>', $msg->fullmessage); $this->assertNotContains('##', $msg->fullmessage); $this->assertContains(strtoupper($event->get_url()->out()), $msg->fullmessage); $this->assertContains('* ' . $modurl->out(), $msg->fullmessage); $this->assertContains('* ' . strtoupper($rule->get_name($context)), $msg->fullmessage); $this->assertContains('* ' . $rule->get_description($context), $msg->fullmessage); $this->assertContains('* ' . $rule->get_event_name(), $msg->fullmessage); }
/** * Tests the cleaning up of events. */ public function test_clean_events() { global $DB; // Create the necessary items for testing. $user = $this->getDataGenerator()->create_user(); $course = $this->getDataGenerator()->create_course(); $bookgenerator = $this->getDataGenerator()->get_plugin_generator('mod_book'); $book = $this->getDataGenerator()->create_module('book', array('course' => $course->id)); $bookcontext = context_module::instance($book->cmid); $bookchapter = $bookgenerator->create_chapter(array('bookid' => $book->id)); $course2 = $this->getDataGenerator()->create_course(); $book2 = $this->getDataGenerator()->create_module('book', array('course' => $course2->id)); $book2context = context_module::instance($book2->cmid); $book2chapter = $bookgenerator->create_chapter(array('bookid' => $book2->id)); $monitorgenerator = $this->getDataGenerator()->get_plugin_generator('tool_monitor'); // Let's set some data for the rules we need before we can generate them. $rule = new stdClass(); $rule->userid = $user->id; $rule->courseid = $course->id; $rule->plugin = 'mod_book'; $rule->eventname = '\\mod_book\\event\\course_module_viewed'; $rule->timewindow = 500; // Let's add a few rules we want to monitor. $rule1 = $monitorgenerator->create_rule($rule); $rule->eventname = '\\mod_book\\event\\course_module_instance_list_viewed'; $rule2 = $monitorgenerator->create_rule($rule); // Add the same rules for the same course, but this time with a lower timewindow (used to test that we do not // remove an event for a course if there is still a rule where the maximum timewindow has not been reached). $rule->eventname = '\\mod_book\\event\\course_module_viewed'; $rule->timewindow = 200; $rule3 = $monitorgenerator->create_rule($rule); $rule->eventname = '\\mod_book\\event\\course_module_instance_list_viewed'; $rule4 = $monitorgenerator->create_rule($rule); // Add another rule in a different course. $rule->courseid = $course2->id; $rule->eventname = '\\mod_book\\event\\chapter_viewed'; $rule->timewindow = 200; $rule5 = $monitorgenerator->create_rule($rule); // Add a site wide rule. $rule->courseid = 0; $rule->eventname = '\\mod_book\\event\\chapter_viewed'; $rule->timewindow = 500; $rule6 = $monitorgenerator->create_rule($rule); // Now let's populate the tool_monitor table with the events associated with those rules. \mod_book\event\course_module_viewed::create_from_book($book, $bookcontext)->trigger(); \mod_book\event\course_module_instance_list_viewed::create_from_course($course)->trigger(); \mod_book\event\chapter_viewed::create_from_chapter($book, $bookcontext, $bookchapter)->trigger(); // Let's trigger the viewed events again, but in another course. The rules created for these events are // associated with another course, so these events should get deleted when we trigger the cleanup task. \mod_book\event\course_module_viewed::create_from_book($book2, $book2context)->trigger(); \mod_book\event\course_module_instance_list_viewed::create_from_course($course2)->trigger(); // Trigger a chapter_viewed event in this course - this should not get deleted as the rule is site wide. \mod_book\event\chapter_viewed::create_from_chapter($book2, $book2context, $book2chapter)->trigger(); // Trigger a bunch of other events. $eventparams = array('context' => context_course::instance($course->id)); for ($i = 0; $i < 5; $i++) { \mod_quiz\event\course_module_instance_list_viewed::create($eventparams)->trigger(); \mod_scorm\event\course_module_instance_list_viewed::create($eventparams)->trigger(); } // Check that the events exist - there will be additional events for creating courses, modules and rules. $this->assertEquals(26, $DB->count_records('tool_monitor_events')); // Run the task and check that all the quiz, scorm and rule events are removed as well as the course_module_* // viewed events in the second course. $task = new \tool_monitor\task\clean_events(); $task->execute(); $events = $DB->get_records('tool_monitor_events'); $this->assertEquals(4, count($events)); $event1 = array_shift($events); $event2 = array_shift($events); $event3 = array_shift($events); $event4 = array_shift($events); $this->assertEquals('\\mod_book\\event\\course_module_viewed', $event1->eventname); $this->assertEquals($course->id, $event1->courseid); $this->assertEquals('\\mod_book\\event\\course_module_instance_list_viewed', $event2->eventname); $this->assertEquals($course->id, $event2->courseid); $this->assertEquals('\\mod_book\\event\\chapter_viewed', $event3->eventname); $this->assertEquals($course->id, $event3->courseid); $this->assertEquals('\\mod_book\\event\\chapter_viewed', $event4->eventname); $this->assertEquals($course2->id, $event4->courseid); // Update the timewindow for two of the rules. $updaterule = new stdClass(); $updaterule->id = $rule1->id; $updaterule->timewindow = 0; \tool_monitor\rule_manager::update_rule($updaterule); $updaterule->id = $rule2->id; \tool_monitor\rule_manager::update_rule($updaterule); // Run the task and check that the events remain as we still have not reached the maximum timewindow. $task = new \tool_monitor\task\clean_events(); $task->execute(); $this->assertEquals(4, $DB->count_records('tool_monitor_events')); // Now, remove the rules associated with course_module_* events so they get deleted. \tool_monitor\rule_manager::delete_rule($rule1->id); \tool_monitor\rule_manager::delete_rule($rule2->id); \tool_monitor\rule_manager::delete_rule($rule3->id); \tool_monitor\rule_manager::delete_rule($rule4->id); // Run the task and check all the course_module_* events are gone. $task = new \tool_monitor\task\clean_events(); $task->execute(); // We now should only have the chapter_viewed events. $events = $DB->get_records('tool_monitor_events'); $this->assertEquals(2, count($events)); $event1 = array_shift($events); $event2 = array_shift($events); $this->assertEquals('\\mod_book\\event\\chapter_viewed', $event1->eventname); $this->assertEquals($course->id, $event1->courseid); $this->assertEquals('\\mod_book\\event\\chapter_viewed', $event2->eventname); $this->assertEquals($course2->id, $event2->courseid); // Set the timewindow of the rule for the event chapter_viewed in the second course to 0. $updaterule->id = $rule5->id; \tool_monitor\rule_manager::update_rule($updaterule); // Run the task. $task = new \tool_monitor\task\clean_events(); $task->execute(); // Check that nothing was deleted as we still have a site wide rule for the chapter_viewed event. $this->assertEquals(2, $DB->count_records('tool_monitor_events')); // Set the timewindow back to 500. $updaterule->id = $rule5->id; $updaterule->timewindow = 500; \tool_monitor\rule_manager::update_rule($updaterule); // Set the site rule timewindow to 0. $updaterule->id = $rule6->id; $updaterule->timewindow = 0; \tool_monitor\rule_manager::update_rule($updaterule); // Run the task. $task = new \tool_monitor\task\clean_events(); $task->execute(); // We now should only have one chapter_viewed event for the second course. $events = $DB->get_records('tool_monitor_events'); $this->assertEquals(1, count($events)); $event1 = array_shift($events); $this->assertEquals('\\mod_book\\event\\chapter_viewed', $event1->eventname); $this->assertEquals($course2->id, $event1->courseid); // Remove the site rule. \tool_monitor\rule_manager::delete_rule($rule6->id); // Remove the last remaining rule. \tool_monitor\rule_manager::delete_rule($rule5->id); // Run the task. $task = new \tool_monitor\task\clean_events(); $task->execute(); // There should be no events left. $this->assertEquals(0, $DB->count_records('tool_monitor_events')); }
$edit = 0; } } } else { $edit = 0; } // read chapters $chapters = book_preload_chapters($book); if ($allowedit and !$chapters) { redirect('edit.php?cmid=' . $cm->id); // No chapters - add new one. } // Check chapterid and read chapter data if ($chapterid == '0') { // Go to first chapter if no given. \mod_book\event\course_module_viewed::create_from_book($book, $context)->trigger(); foreach ($chapters as $ch) { if ($edit) { $chapterid = $ch->id; break; } if (!$ch->hidden) { $chapterid = $ch->id; break; } } } $courseurl = new moodle_url('/course/view.php', array('id' => $course->id)); // No content in the book. if (!$chapterid) { $PAGE->set_url('/mod/book/view.php', array('id' => $id));
/** * Tests for replace_placeholders method. */ public function test_replace_placeholders() { global $USER; $this->resetAfterTest(); $this->setAdminUser(); $msgsink = $this->redirectMessages(); // Generate data. $course = $this->getDataGenerator()->create_course(); $toolgenerator = $this->getDataGenerator()->get_plugin_generator('tool_monitor'); $context = \context_user::instance($USER->id, IGNORE_MISSING); // Creating book. $cm = new stdClass(); $cm->course = $course->id; $book = $this->getDataGenerator()->create_module('book', $cm); // Creating rule. $rulerecord = new stdClass(); $rulerecord->courseid = $course->id; $rulerecord->eventname = '\\mod_book\\event\\course_module_viewed'; $rulerecord->cmid = $book->cmid; $rulerecord->frequency = 1; $rulerecord->template = '{link} {modulelink} {rulename} {description} {eventname}'; $rule = $toolgenerator->create_rule($rulerecord); // Creating subscription. $subrecord = new stdClass(); $subrecord->courseid = $course->id; $subrecord->ruleid = $rule->id; $subrecord->userid = $USER->id; $toolgenerator->create_subscription($subrecord); // Now let us trigger the event. $params = array('context' => context_module::instance($book->cmid), 'objectid' => $book->id); $event = \mod_book\event\course_module_viewed::create($params); $event->trigger(); $this->run_adhock_tasks(); $msgs = $msgsink->get_messages(); $msg = array_pop($msgs); $modurl = new moodle_url('/mod/book/view.php', array('id' => $book->cmid)); $expectedmsg = $event->get_url()->out() . ' ' . $modurl->out() . ' ' . $rule->get_name($context) . ' ' . $rule->get_description($context) . ' ' . $rule->get_event_name(); $this->assertEquals($expectedmsg, $msg->fullmessage); }
} } } else { $edit = 0; } // read chapters $chapters = book_preload_chapters($book); if ($allowedit and !$chapters) { redirect('edit.php?cmid=' . $cm->id); // No chapters - add new one. } // Check chapterid and read chapter data if ($chapterid == '0') { // Go to first chapter if no given. $params = array('context' => $context, 'objectid' => $book->id); $event = \mod_book\event\course_module_viewed::create($params); $event->add_record_snapshot('book', $book); $event->trigger(); foreach ($chapters as $ch) { if ($edit) { $chapterid = $ch->id; break; } if (!$ch->hidden) { $chapterid = $ch->id; break; } } } $courseurl = new moodle_url('/course/view.php', array('id' => $course->id)); // No content in the book.