From ec55d63ca061ee5e8cfba3d2a1eb2568b47189c9 Mon Sep 17 00:00:00 2001 From: Shamim Rezaie Date: Fri, 26 Feb 2021 02:51:46 +1100 Subject: [PATCH] MDL-70818 mod_data: implement activity_dates for the database module --- mod/data/classes/dates.php | 68 +++++++++++++++++++++++ mod/data/tests/dates_test.php | 122 ++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 190 insertions(+) create mode 100644 mod/data/classes/dates.php create mode 100644 mod/data/tests/dates_test.php diff --git a/mod/data/classes/dates.php b/mod/data/classes/dates.php new file mode 100644 index 00000000000..908662c5ad7 --- /dev/null +++ b/mod/data/classes/dates.php @@ -0,0 +1,68 @@ +. + +/** + * Contains the class for fetching the important dates in mod_data for a given module instance and a user. + * + * @package mod_data + * @copyright 2021 Shamim Rezaie + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ + +declare(strict_types=1); + +namespace mod_data; + +use core\activity_dates; + +/** + * Class for fetching the important dates in mod_data 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_data + * + * @return array + */ + protected function get_dates(): array { + $timeopen = $this->cm->customdata['timeavailablefrom'] ?? null; + $timeclose = $this->cm->customdata['timeavailableto'] ?? null; + $now = time(); + $dates = []; + + if ($timeopen) { + $openlabelid = $timeopen > $now ? 'activitydate:opens' : 'activitydate:opened'; + $dates[] = [ + 'label' => get_string($openlabelid, 'course'), + 'timestamp' => (int) $timeopen, + ]; + } + + if ($timeclose) { + $closelabelid = $timeclose > $now ? 'activitydate:closes' : 'activitydate:closed'; + $dates[] = [ + 'label' => get_string($closelabelid, 'course'), + 'timestamp' => (int) $timeclose, + ]; + } + + return $dates; + } +} diff --git a/mod/data/tests/dates_test.php b/mod/data/tests/dates_test.php new file mode 100644 index 00000000000..62f841eca0e --- /dev/null +++ b/mod/data/tests/dates_test.php @@ -0,0 +1,122 @@ +. + +/** + * Contains unit tests for mod_data\dates. + * + * @package mod_data + * @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_data; + +use advanced_testcase; +use cm_info; +use core\activity_dates; + +/** + * Class for unit testing mod_data\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, [] + ], + 'only with opening time' => [ + $after, null, [ + ['label' => 'Opens:', 'timestamp' => $after], + ] + ], + 'only with closing time' => [ + null, $after, [ + ['label' => 'Closes:', 'timestamp' => $after], + ] + ], + 'with both times' => [ + $after, $later, [ + ['label' => 'Opens:', 'timestamp' => $after], + ['label' => 'Closes:', 'timestamp' => $later], + ] + ], + 'between the dates' => [ + $before, $after, [ + ['label' => 'Opened:', 'timestamp' => $before], + ['label' => 'Closes:', 'timestamp' => $after], + ] + ], + 'dates are past' => [ + $earlier, $before, [ + ['label' => 'Opened:', 'timestamp' => $earlier], + ['label' => 'Closed:', 'timestamp' => $before], + ] + ], + ]; + } + + /** + * Test for get_dates_for_module(). + * + * @dataProvider get_dates_for_module_provider + * @param int|null $availablefrom The "available from" time in the database activity. + * @param int|null $availableto The "available to" time in the database activity. + * @param array $expected The expected value of calling get_dates_for_module() + */ + public function test_get_dates_for_module(?int $availablefrom, ?int $availableto, array $expected) { + $this->resetAfterTest(); + + $course = $this->getDataGenerator()->create_course(); + $user = $this->getDataGenerator()->create_user(); + $this->getDataGenerator()->enrol_user($user->id, $course->id); + + $data = ['course' => $course->id]; + if ($availablefrom) { + $data['timeavailablefrom'] = $availablefrom; + } + if ($availableto) { + $data['timeavailableto'] = $availableto; + } + $moddata = $this->getDataGenerator()->create_module('data', $data); + + $this->setUser($user); + + $cm = get_coursemodule_from_instance('data', $moddata->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); + } +} -- 2.11.4.GIT