diff --git a/mod/quiz/classes/dates.php b/mod/quiz/classes/dates.php new file mode 100644 index 00000000000..ce0f6058406 --- /dev/null +++ b/mod/quiz/classes/dates.php @@ -0,0 +1,68 @@ +. + +/** + * Contains the class for fetching the important dates in mod_quiz for a given module instance and a user. + * + * @package mod_quiz + * @copyright 2021 Shamim Rezaie + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ + +declare(strict_types=1); + +namespace mod_quiz; + +use core\activity_dates; + +/** + * Class for fetching the important dates in mod_quiz for a given module instance and a user. + * + * @copyright 2021 Shamim Rezaie + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ +class dates extends activity_dates { + + /** + * Returns a list of important dates in mod_quiz + * + * @return array + */ + protected function get_dates(): array { + $timeopen = $this->cm->customdata['timeopen'] ?? null; + $timeclose = $this->cm->customdata['timeclose'] ?? null; + $now = time(); + $dates = []; + + if ($timeopen) { + $openlabelid = $timeopen > $now ? 'activitydate:opens' : 'activitydate:opened'; + $dates[] = [ + 'label' => get_string($openlabelid, 'core_course'), + 'timestamp' => (int) $timeopen, + ]; + } + + if ($timeclose) { + $closelabelid = $timeclose > $now ? 'activitydate:closes' : 'activitydate:closed'; + $dates[] = [ + 'label' => get_string($closelabelid, 'core_course'), + 'timestamp' => (int) $timeclose, + ]; + } + + return $dates; + } +} diff --git a/mod/quiz/tests/dates_test.php b/mod/quiz/tests/dates_test.php new file mode 100644 index 00000000000..372ba729d14 --- /dev/null +++ b/mod/quiz/tests/dates_test.php @@ -0,0 +1,175 @@ +. + +/** + * Contains unit tests for mod_quiz\dates. + * + * @package mod_quiz + * @category test + * @copyright 2021 Shamim Rezaie + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ + +declare(strict_types=1); + +namespace mod_quiz; + +use advanced_testcase; +use cm_info; +use core\activity_dates; + +/** + * Class for unit testing mod_quiz\dates. + * + * @copyright 2021 Shamim Rezaie + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ +class dates_test extends advanced_testcase { + + /** + * Data provider for get_dates_for_module(). + * @return array[] + */ + public function get_dates_for_module_provider(): array { + $now = time(); + $before = $now - DAYSECS; + $earlier = $before - DAYSECS; + $after = $now + DAYSECS; + $later = $after + DAYSECS; + + return [ + 'without any dates' => [ + null, null, null, null, null, null, [] + ], + 'only with opening time' => [ + $after, null, null, null, null, null, [ + ['label' => get_string('activitydate:opens', 'course'), 'timestamp' => $after], + ] + ], + 'only with closing time' => [ + null, $after, null, null, null, null, [ + ['label' => get_string('activitydate:closes', 'course'), 'timestamp' => $after], + ] + ], + 'with both times' => [ + $after, $later, null, null, null, null, [ + ['label' => get_string('activitydate:opens', 'course'), 'timestamp' => $after], + ['label' => get_string('activitydate:closes', 'course'), 'timestamp' => $later], + ] + ], + 'between the dates' => [ + $before, $after, null, null, null, null, [ + ['label' => get_string('activitydate:opened', 'course'), 'timestamp' => $before], + ['label' => get_string('activitydate:closes', 'course'), 'timestamp' => $after], + ] + ], + 'dates are past' => [ + $earlier, $before, null, null, null, null, [ + ['label' => get_string('activitydate:opened', 'course'), 'timestamp' => $earlier], + ['label' => get_string('activitydate:closed', 'course'), 'timestamp' => $before], + ] + ], + 'with user override' => [ + $before, $after, $earlier, $later, null, null, [ + ['label' => get_string('activitydate:opened', 'course'), 'timestamp' => $earlier], + ['label' => get_string('activitydate:closes', 'course'), 'timestamp' => $later], + ] + ], + 'with group override' => [ + $before, $after, null, null, $earlier, $later, [ + ['label' => get_string('activitydate:opened', 'course'), 'timestamp' => $earlier], + ['label' => get_string('activitydate:closes', 'course'), 'timestamp' => $later], + ] + ], + 'with both user and group overrides' => [ + $before, $after, $earlier, $later, $earlier - DAYSECS, $later + DAYSECS, [ + ['label' => get_string('activitydate:opened', 'course'), 'timestamp' => $earlier], + ['label' => get_string('activitydate:closes', 'course'), 'timestamp' => $later], + ] + ], + ]; + } + + /** + * Test for get_dates_for_module(). + * + * @dataProvider get_dates_for_module_provider + * @param int|null $timeopen Time of opening the quiz. + * @param int|null $timeclose Time of closing the quiz. + * @param int|null $usertimeopen The user override for opening the quiz. + * @param int|null $usertimeclose The user override for closing the quiz. + * @param int|null $grouptimeopen The group override for opening the quiz. + * @param int|null $grouptimeclose The group override for closing the quiz. + * @param array $expected The expected value of calling get_dates_for_module() + */ + public function test_get_dates_for_module(?int $timeopen, ?int $timeclose, + ?int $usertimeopen, ?int $usertimeclose, + ?int $grouptimeopen, ?int $grouptimeclose, + array $expected) { + + $this->resetAfterTest(); + $generator = $this->getDataGenerator(); + /** @var \mod_quiz_generator $quizgenerator */ + $quizgenerator = $generator->get_plugin_generator('mod_quiz'); + + $course = $generator->create_course(); + $user = $generator->create_user(); + $generator->enrol_user($user->id, $course->id); + + $data = ['course' => $course->id]; + if ($timeopen) { + $data['timeopen'] = $timeopen; + } + if ($timeclose) { + $data['timeclose'] = $timeclose; + } + $quiz = $quizgenerator->create_instance($data); + + if ($usertimeopen || $usertimeclose || $grouptimeopen || $grouptimeclose) { + $generator->enrol_user($user->id, $course->id); + $group = $generator->create_group(['courseid' => $course->id]); + $generator->create_group_member(['groupid' => $group->id, 'userid' => $user->id]); + + if ($usertimeopen || $usertimeclose) { + $quizgenerator->create_override([ + 'quiz' => $quiz->id, + 'userid' => $user->id, + 'timeopen' => $usertimeopen, + 'timeclose' => $usertimeclose, + ]); + } + + if ($grouptimeopen || $grouptimeclose) { + $quizgenerator->create_override([ + 'quiz' => $quiz->id, + 'groupid' => $group->id, + 'timeopen' => $grouptimeopen, + 'timeclose' => $grouptimeclose, + ]); + } + } + + $this->setUser($user); + + $cm = get_coursemodule_from_instance('quiz', $quiz->id); + // Make sure we're using a cm_info object. + $cm = cm_info::create($cm); + + $dates = activity_dates::get_dates_for_module($cm, (int) $user->id); + + $this->assertEquals($expected, $dates); + } +}