*
* @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_label_core_calendar_provide_event_action(calendar_event $event,
- \core_calendar\action_factory $factory) {
- $cm = get_fast_modinfo($event->courseid)->instances['label'][$event->instance];
+ \core_calendar\action_factory $factory,
+ int $userid = 0) {
+ $cm = get_fast_modinfo($event->courseid, $userid)->instances['label'][$event->instance];
+
+ if (!$cm->uservisible) {
+ // The module is not visible to the user for any reason.
+ 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;
$this->assertTrue($actionevent->is_actionable());
}
+ public function test_label_core_calendar_provide_event_action_as_non_user() {
+ global $CFG;
+
+ // Create the activity.
+ $course = $this->getDataGenerator()->create_course();
+ $label = $this->getDataGenerator()->create_module('label', array('course' => $course->id));
+
+ // Create a calendar event.
+ $event = $this->create_action_event($course->id, $label->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.
+ $actionevent = mod_label_core_calendar_provide_event_action($event, $factory);
+
+ // Confirm the event is not shown at all.
+ $this->assertNull($actionevent);
+ }
+
+ public function test_label_core_calendar_provide_event_action_in_hidden_section() {
+ // Create the activity.
+ $course = $this->getDataGenerator()->create_course();
+ $label = $this->getDataGenerator()->create_module('label', array('course' => $course->id));
+
+ // Create a student.
+ $student = $this->getDataGenerator()->create_and_enrol($course, 'student');
+
+ // Create a calendar event.
+ $event = $this->create_action_event($course->id, $label->id,
+ \core_completion\api::COMPLETION_EVENT_TYPE_DATE_COMPLETION_EXPECTED);
+
+ // Set sections 0 as hidden.
+ set_section_visible($course->id, 0, 0);
+
+ // Create an action factory.
+ $factory = new \core_calendar\action_factory();
+
+ // Decorate action event for the student.
+ $actionevent = mod_label_core_calendar_provide_event_action($event, $factory, $student->id);
+
+ // Confirm the event is not shown at all.
+ $this->assertNull($actionevent);
+ }
+
+ public function test_label_core_calendar_provide_event_action_for_user() {
+ global $CFG;
+
+ // Create the activity.
+ $course = $this->getDataGenerator()->create_course();
+ $label = $this->getDataGenerator()->create_module('label', array('course' => $course->id));
+
+ // Enrol a student in the course.
+ $student = $this->getDataGenerator()->create_and_enrol($course, 'student');
+
+ // Create a calendar event.
+ $event = $this->create_action_event($course->id, $label->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_label_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_label_core_calendar_provide_event_action_already_completed() {
global $CFG;
$this->assertNull($actionevent);
}
+ public function test_label_core_calendar_provide_event_action_already_completed_for_user() {
+ global $CFG;
+
+ $CFG->enablecompletion = 1;
+
+ // Create the activity.
+ $course = $this->getDataGenerator()->create_course(array('enablecompletion' => 1));
+ $label = $this->getDataGenerator()->create_module('label', array('course' => $course->id),
+ array('completion' => 2, 'completionview' => 1, 'completionexpected' => time() + DAYSECS));
+
+ // Enrol a student in the course.
+ $student = $this->getDataGenerator()->create_and_enrol($course, 'student');
+
+ // Get some additional data.
+ $cm = get_coursemodule_from_instance('label', $label->id);
+
+ // Create a calendar event.
+ $event = $this->create_action_event($course->id, $label->id,
+ \core_completion\api::COMPLETION_EVENT_TYPE_DATE_COMPLETION_EXPECTED);
+
+ // Mark the activity as completed for the student.
+ $completion = new completion_info($course);
+ $completion->set_module_viewed($cm, $student->id);
+
+ // Create an action factory.
+ $factory = new \core_calendar\action_factory();
+
+ // Decorate action event for the student.
+ $actionevent = mod_label_core_calendar_provide_event_action($event, $factory, $student->id);
+
+ // Ensure result was null.
+ $this->assertNull($actionevent);
+ }
+
/**
* Creates an action event.
*