/** * If section is not visible, display the message about that ('Not available * until...', that sort of thing). Otherwise, returns blank. * * For users with the ability to view hidden sections, it shows the * information even though you can view the section and also may include * slightly fuller information (so that teachers can tell when sections * are going to be unavailable etc). This logic is the same as for * activities. * * @param stdClass $section The course_section entry from DB * @param bool $canviewhidden True if user can view hidden sections * @return string HTML to output */ protected function section_availability_message($section, $canviewhidden) { global $CFG; $o = ''; if (!$section->uservisible) { $o .= html_writer::start_tag('div', array('class' => 'availabilityinfo')); // Note: We only get to this function if availableinfo is non-empty, // so there is definitely something to print. $o .= $section->availableinfo; $o .= html_writer::end_tag('div'); } else { if ($canviewhidden && !empty($CFG->enableavailability) && $section->visible) { $ci = new condition_info_section($section); $fullinfo = $ci->get_full_information(); if ($fullinfo) { $o .= html_writer::start_tag('div', array('class' => 'availabilityinfo')); $o .= get_string($section->showavailability ? 'userrestriction_visible' : 'userrestriction_hidden', 'condition', $fullinfo); $o .= html_writer::end_tag('div'); } } } return $o; }
public function test_section_is_available() { global $DB, $USER; $courseid = $this->make_course(); // Enrol user (needed for groups) $enrolplugin = enrol_get_plugin('manual'); $course = $DB->get_record('course', array('id' => $courseid)); $enrolplugin->add_instance($course); $enrolinstances = enrol_get_instances($courseid, false); foreach ($enrolinstances as $enrolinstance) { if ($enrolinstance->enrol === 'manual') { break; } } $enrolplugin->enrol_user($enrolinstance, $USER->id); // Module for conditions later $cmid = $this->make_course_module($courseid); // No conditions $sectionid = $this->make_section($courseid, array($cmid), 1); $ci = new condition_info_section((object)array('id' => $sectionid), CONDITION_MISSING_EVERYTHING); $this->assertTrue($ci->is_available($text, false, 0)); $this->assertEquals('', $text); // Time (from) $time = time() + 100; $sectionid = $this->make_section($courseid, array(), 2, array('availablefrom' => $time)); $ci = new condition_info_section((object)array('id' => $sectionid), CONDITION_MISSING_EVERYTHING); $this->assertFalse($ci->is_available($text)); $timetext = userdate($time, get_string('strftimedate', 'langconfig')); $this->assertRegExp('~' . preg_quote($timetext) . '~', $text); $time=time()-100; $sectionid = $this->make_section($courseid, array(), 3, array('availablefrom' => $time)); $ci = new condition_info_section((object)array('id' => $sectionid), CONDITION_MISSING_EVERYTHING); $this->assertTrue($ci->is_available($text)); $this->assertEquals('', $text); $timetext = userdate($time, get_string('strftimedate', 'langconfig')); $this->assertRegExp('~' . preg_quote($timetext) . '~', $ci->get_full_information()); // Time (until) $sectionid = $this->make_section($courseid, array(), 4, array('availableuntil' => time() - 100)); $ci = new condition_info_section((object)array('id' => $sectionid), CONDITION_MISSING_EVERYTHING); $this->assertFalse($ci->is_available($text)); $this->assertEquals('', $text); // Completion: first set up cm $sectionid = $this->make_section($courseid, array(), 5); $cm = $DB->get_record('course_modules', array('id' => $cmid)); $cm->completion = COMPLETION_TRACKING_MANUAL; $DB->update_record('course_modules', $cm); // Completion: Reset modinfo after changing the options rebuild_course_cache($courseid); $reset = 'reset'; get_fast_modinfo($reset); // Completion: Add condition $ci = new condition_info_section((object)array('id' => $sectionid), CONDITION_MISSING_EVERYTHING); $ci->add_completion_condition($cmid, COMPLETION_COMPLETE); condition_info_section::wipe_session_cache(); // Completion: Check $this->assertFalse($ci->is_available($text, false)); $this->assertEquals(get_string('requires_completion_1', 'condition', 'xxx'), $text); completion_info::wipe_session_cache(); $completion = new completion_info($DB->get_record('course', array('id' => $courseid))); $completion->update_state($cm, COMPLETION_COMPLETE); completion_info::wipe_session_cache(); condition_info_section::wipe_session_cache(); $this->assertTrue($ci->is_available($text)); $this->assertFalse($ci->is_available($text, false, $USER->id + 1)); // Completion: Uncheck completion_info::wipe_session_cache(); condition_info_section::wipe_session_cache(); $completion = new completion_info($DB->get_record('course', array('id' => $courseid))); $completion->update_state($cm, COMPLETION_INCOMPLETE); $this->assertFalse($ci->is_available($text)); // Completion: Incomplete condition $ci->wipe_conditions(); $ci->add_completion_condition($cmid, COMPLETION_INCOMPLETE); condition_info_section::wipe_session_cache(); $this->assertTrue($ci->is_available($text)); $this->assertTrue($ci->is_available($text, false, $USER->id + 1)); condition_info_section::wipe_session_cache(); $this->assertTrue($ci->is_available($text, true)); // Grade: Add a fake grade item $gradeitemid = $DB->insert_record('grade_items', (object)array( 'courseid' => $courseid, 'itemname' => 'frog')); // Grade: Add a condition on a value existing $ci->wipe_conditions(); $ci->add_grade_condition($gradeitemid, null, null, true); $this->assertFalse($ci->is_available($text)); $this->assertEquals(get_string('requires_grade_any', 'condition', 'frog'), $text); // Grade: Fake it existing $DB->insert_record('grade_grades', (object)array( 'itemid' => $gradeitemid, 'userid' => $USER->id, 'finalgrade' => 3.78)); condition_info_section::wipe_session_cache(); $this->assertTrue($ci->is_available($text)); condition_info_section::wipe_session_cache(); $this->assertTrue($ci->is_available($text, true)); // Grade: Now require that user gets more than 3.78001 $ci->wipe_conditions(); $ci->add_grade_condition($gradeitemid, 3.78001, null, true); condition_info_section::wipe_session_cache(); $this->assertFalse($ci->is_available($text)); $this->assertEquals(get_string('requires_grade_min', 'condition', 'frog'), $text); // Grade: ...just on 3.78... $ci->wipe_conditions(); $ci->add_grade_condition($gradeitemid, 3.78, null, true); condition_info_section::wipe_session_cache(); $this->assertTrue($ci->is_available($text)); // Grade: ...less than 3.78 $ci->wipe_conditions(); $ci->add_grade_condition($gradeitemid, null, 3.78, true); condition_info_section::wipe_session_cache(); $this->assertFalse($ci->is_available($text)); $this->assertEquals(get_string('requires_grade_max', 'condition', 'frog'), $text); // Grade: ...less than 3.78001 $ci->wipe_conditions(); $ci->add_grade_condition($gradeitemid, null, 3.78001, true); condition_info_section::wipe_session_cache(); $this->assertTrue($ci->is_available($text)); // Grade: ...in a range that includes it $ci->wipe_conditions(); $ci->add_grade_condition($gradeitemid, 3, 4, true); condition_info_section::wipe_session_cache(); $this->assertTrue($ci->is_available($text)); // Grade: ...in a range that doesn't include it $ci->wipe_conditions(); $ci->add_grade_condition($gradeitemid, 4, 5, true); condition_info_section::wipe_session_cache(); $this->assertFalse($ci->is_available($text)); $this->assertEquals(get_string('requires_grade_range', 'condition', 'frog'), $text); // Grouping: Not member $groupingid = $this->make_grouping($courseid, 'Grouping'); $groupid = $this->make_group($courseid, 'Group', $groupingid); $sectionid = $this->make_section($courseid, array(), 6, array('groupingid' => $groupingid)); $ci = new condition_info_section((object)array('id' => $sectionid), CONDITION_MISSING_EVERYTHING); $this->assertFalse($ci->is_available($text)); $this->assertEquals(trim(get_string('groupingnoaccess', 'condition')), $text); // Grouping: Member $this->assertTrue(groups_add_member($groupid, $USER->id)); condition_info_section::init_global_cache(); $this->assertTrue($ci->is_available($text)); $this->assertEquals('', $text); $this->assertTrue($ci->is_available($text, true)); // Grouping: Somebody else $this->assertFalse($ci->is_available($text, false, $USER->id + 1)); $this->assertFalse($ci->is_available($text, true, $USER->id + 1)); }
/** * Tests the is_available function for sections. */ public function test_section_is_available() { global $DB; // Create course. $generator = $this->getDataGenerator(); $course = $generator->create_course(array('numsections' => 2), array('createsections' => true)); // Set one of the sections unavailable. $time = time() + 100; $avail = '{"op":"|","show":true,"c":[{"type":"date","d":">=","t":' . $time . '}]}'; $DB->set_field('course_sections', 'availability', $avail, array('course' => $course->id, 'section' => 2)); $modinfo = get_fast_modinfo($course); // No conditions. $ci = new condition_info_section($modinfo->get_section_info(1)); $this->assertDebuggingCalled(); $this->assertTrue($ci->is_available($text, false, 0)); $this->assertDebuggingCalled(); $this->assertEquals('', $text); // Date condition. $ci = new condition_info_section($modinfo->get_section_info(2)); $this->assertDebuggingCalled(); $this->assertFalse($ci->is_available($text)); $this->assertDebuggingCalled(); $expectedtime = userdate($time, get_string('strftimedate', 'langconfig')); $this->assertContains($expectedtime, $text); // Full information display. $text = $ci->get_full_information(); $this->assertDebuggingCalled(); $expectedtime = userdate($time, get_string('strftimedate', 'langconfig')); $this->assertContains($expectedtime, $text); }
/** * If section is not visible, display the message about that ('Not available * until...', that sort of thing). Otherwise, returns blank. * * For users with the ability to view hidden sections, it shows the * information even though you can view the section and also may include * slightly fuller information (so that teachers can tell when sections * are going to be unavailable etc). This logic is the same as for * activities. * * @param stdClass $section The course_section entry from DB * @param bool $canviewhidden True if user can view hidden sections * @return string HTML to output */ protected function section_availability_message($section, $canviewhidden) { global $CFG; $o = ''; if (!$section->uservisible) { $o .= html_writer::start_tag('div', array('class' => 'availabilityinfo')); // Note: We only get to this function if availableinfo is non-empty, // so there is definitely something to print. $o .= $section->availableinfo; $o .= html_writer::end_tag('div'); } else if ($canviewhidden && !empty($CFG->enableavailability) && $section->visible) { // The CONDITION_MISSING_EXTRATABLE is to hide a performance warning that // only applies in 2.3 because of the way we construct section objects on // the FIRST view of a course. In future views, we shouldn't have anything // missing. $ci = new condition_info_section($section, CONDITION_MISSING_EXTRATABLE); $fullinfo = $ci->get_full_information(); if ($fullinfo) { $o .= html_writer::start_tag('div', array('class' => 'availabilityinfo')); $o .= get_string( ($section->showavailability ? 'userrestriction_visible' : 'userrestriction_hidden'), 'condition', $fullinfo); $o .= html_writer::end_tag('div'); } } return $o; }