From a44fb747cf064145c21d9c24457d3d4bf0ae7972 Mon Sep 17 00:00:00 2001 From: Shamim Rezaie Date: Thu, 7 Mar 2019 17:28:02 +1100 Subject: [PATCH] MDL-63149 mod_survey: Add userid param to mod_survey calendar callbacks --- mod/survey/lib.php | 16 ++++++-- mod/survey/tests/lib_test.php | 76 +++++++++++++++++++++++++++++++++++ 2 files changed, 88 insertions(+), 4 deletions(-) diff --git a/mod/survey/lib.php b/mod/survey/lib.php index 0a6d0e34198..a43d319b374 100644 --- a/mod/survey/lib.php +++ b/mod/survey/lib.php @@ -1112,20 +1112,28 @@ function survey_check_updates_since(cm_info $cm, $from, $filter = array()) { * * @param calendar_event $event * @param \core_calendar\action_factory $factory + * @param int $userid User id to use for all capability checks, etc. Set to 0 for current user (default). * @return \core_calendar\local\event\entities\action_interface|null */ function mod_survey_core_calendar_provide_event_action(calendar_event $event, - \core_calendar\action_factory $factory) { - $cm = get_fast_modinfo($event->courseid)->instances['survey'][$event->instance]; + \core_calendar\action_factory $factory, + int $userid = 0) { + global $USER; + + if (empty($userid)) { + $userid = $USER->id; + } + + $cm = get_fast_modinfo($event->courseid, $userid)->instances['survey'][$event->instance]; $context = context_module::instance($cm->id); - if (!has_capability('mod/survey:participate', $context)) { + if (!has_capability('mod/survey:participate', $context, $userid)) { return null; } $completion = new \completion_info($cm->get_course()); - $completiondata = $completion->get_data($cm, false); + $completiondata = $completion->get_data($cm, false, $userid); if ($completiondata->completionstate != COMPLETION_INCOMPLETE) { return null; diff --git a/mod/survey/tests/lib_test.php b/mod/survey/tests/lib_test.php index e3994ab10ad..069e88d7acd 100644 --- a/mod/survey/tests/lib_test.php +++ b/mod/survey/tests/lib_test.php @@ -193,6 +193,41 @@ class mod_survey_lib_testcase extends advanced_testcase { $this->assertTrue($actionevent->is_actionable()); } + public function test_survey_core_calendar_provide_event_action_for_user() { + global $CFG; + + $this->resetAfterTest(); + $this->setAdminUser(); + + // Create the activity. + $course = $this->getDataGenerator()->create_course(); + $survey = $this->getDataGenerator()->create_module('survey', array('course' => $course->id)); + + // Create a student and enrol into the course. + $student = $this->getDataGenerator()->create_and_enrol($course, 'student'); + + // Create a calendar event. + $event = $this->create_action_event($course->id, $survey->id, + \core_completion\api::COMPLETION_EVENT_TYPE_DATE_COMPLETION_EXPECTED); + + // Now log out. + $CFG->forcelogin = true; // We don't want to be logged in as guest, as guest users might still have some capabilities. + $this->setUser(); + + // Create an action factory. + $factory = new \core_calendar\action_factory(); + + // Decorate action event for the student. + $actionevent = mod_survey_core_calendar_provide_event_action($event, $factory, $student->id); + + // Confirm the event was decorated. + $this->assertInstanceOf('\core_calendar\local\event\value_objects\action', $actionevent); + $this->assertEquals(get_string('view'), $actionevent->get_name()); + $this->assertInstanceOf('moodle_url', $actionevent->get_url()); + $this->assertEquals(1, $actionevent->get_item_count()); + $this->assertTrue($actionevent->is_actionable()); + } + public function test_survey_core_calendar_provide_event_action_as_non_user() { global $CFG; @@ -255,6 +290,47 @@ class mod_survey_lib_testcase extends advanced_testcase { $this->assertNull($actionevent); } + public function test_survey_core_calendar_provide_event_action_already_completed_for_user() { + global $CFG; + + $this->resetAfterTest(); + $this->setAdminUser(); + + $CFG->enablecompletion = 1; + + // Create the activity. + $course = $this->getDataGenerator()->create_course(array('enablecompletion' => 1)); + $survey = $this->getDataGenerator()->create_module('survey', array('course' => $course->id), + array('completion' => 2, 'completionview' => 1, 'completionexpected' => time() + DAYSECS)); + + // Create 2 students and enrol them into the course. + $student1 = $this->getDataGenerator()->create_and_enrol($course, 'student'); + $student2 = $this->getDataGenerator()->create_and_enrol($course, 'student'); + + // Get some additional data. + $cm = get_coursemodule_from_instance('survey', $survey->id); + + // Create a calendar event. + $event = $this->create_action_event($course->id, $survey->id, + \core_completion\api::COMPLETION_EVENT_TYPE_DATE_COMPLETION_EXPECTED); + + // Mark the activity as completed for the $student1. + $completion = new completion_info($course); + $completion->set_module_viewed($cm, $student1->id); + + // Now log in as $student2. + $this->setUser($student2); + + // Create an action factory. + $factory = new \core_calendar\action_factory(); + + // Decorate action event for $student1. + $actionevent = mod_survey_core_calendar_provide_event_action($event, $factory, $student1->id); + + // Ensure result was null. + $this->assertNull($actionevent); + } + /** * Creates an action event. *