MDL-70818 mod_forum: implement activity_dates for the forum module

mod/forum/classes/dates.php

@@ -0,0 +1,57 @@
+<?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_forum for a given module instance and a user.
+ *
+ * @package   mod_forum
+ * @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_forum;
+
+use core\activity_dates;
+
+/**
+ * Class for fetching the important dates in mod_forum 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_forum
+     *
+     * @return array
+     */
+    protected function get_dates(): array {
+        $duedate = $this->cm->customdata['duedate'] ?? null;
+        $dates = [];
+
+        if ($duedate) {
+            $dates[] = [
+                'label' => get_string('activitydate:due', 'mod_forum'),
+                'timestamp' => (int) $duedate,
+            ];
+        }
+
+        return $dates;
+    }
+}

mod/forum/lang/en/forum.php

@@ -23,6 +23,7 @@
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+$string['activitydate:due'] = 'Due:';
 $string['activityoverview'] = 'There are new forum posts';
 $string['actionsforgraderinterface'] = 'Actions for the grader interface';
 $string['actionsforpost'] = 'Actions for post';

mod/forum/tests/dates_test.php

@@ -0,0 +1,100 @@
+<?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_forum\dates.
+ *
+ * @package   mod_forum
+ * @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_forum;
+
+use advanced_testcase;
+use cm_info;
+use core\activity_dates;
+
+/**
+ * Class for unit testing mod_forum\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;
+        $after = $now + DAYSECS;
+
+        return [
+            'without any dates' => [
+                null, []
+            ],
+            'future due date' => [
+                $after, [
+                    ['label' => 'Due:', 'timestamp' => $after],
+                ]
+            ],
+            'due date is past' => [
+                $before, [
+                    ['label' => 'Due:', 'timestamp' => $before],
+                ]
+            ],
+        ];
+    }
+
+    /**
+     * Test for get_dates_for_module().
+     *
+     * @dataProvider get_dates_for_module_provider
+     * @param int|null $duedate Forum's due date.
+     * @param array $expected The expected value of calling get_dates_for_module()
+     */
+    public function test_get_dates_for_module(?int $duedate, 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 ($duedate) {
+            $data['duedate'] = $duedate;
+        }
+
+        $this->setAdminUser();
+        $forum = $this->getDataGenerator()->create_module('forum', $data);
+
+        $this->setUser($user);
+
+        $cm = get_coursemodule_from_instance('forum', $forum->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);
+    }
+}