mirrored from git://git.moodle.org/moodle.git
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
MDL-70818 mod_data: implement activity_dates for the database module
- Loading branch information
Showing
2 changed files
with
190 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| <?php | ||
| // This file is part of Moodle - http://moodle.org/ | ||
| // | ||
| // Moodle is free software: you can redistribute it and/or modify | ||
| // it under the terms of the GNU General Public License as published by | ||
| // the Free Software Foundation, either version 3 of the License, or | ||
| // (at your option) any later version. | ||
| // | ||
| // Moodle is distributed in the hope that it will be useful, | ||
| // but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| // GNU General Public License for more details. | ||
| // | ||
| // You should have received a copy of the GNU General Public License | ||
| // along with Moodle. If not, see <http://www.gnu.org/licenses/>. | ||
|
|
||
| /** | ||
| * 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 <shamim@moodle.com> | ||
| * @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 <shamim@moodle.com> | ||
| * @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; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,122 @@ | ||
| <?php | ||
| // This file is part of Moodle - http://moodle.org/ | ||
| // | ||
| // Moodle is free software: you can redistribute it and/or modify | ||
| // it under the terms of the GNU General Public License as published by | ||
| // the Free Software Foundation, either version 3 of the License, or | ||
| // (at your option) any later version. | ||
| // | ||
| // Moodle is distributed in the hope that it will be useful, | ||
| // but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| // GNU General Public License for more details. | ||
| // | ||
| // You should have received a copy of the GNU General Public License | ||
| // along with Moodle. If not, see <http://www.gnu.org/licenses/>. | ||
|
|
||
| /** | ||
| * Contains unit tests for mod_data\dates. | ||
| * | ||
| * @package mod_data | ||
| * @category test | ||
| * @copyright 2021 Shamim Rezaie <shamim@moodle.com> | ||
| * @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 <shamim@moodle.com> | ||
| * @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); | ||
| } | ||
| } |