New feature: restricted time for participation for moodleoverflow forums

backup/moodle2/backup_moodleoverflow_stepslib.php

@@ -48,7 +48,7 @@ protected function define_structure() {
             'name', 'intro', 'introformat', 'maxbytes', 'maxattachments', 'timecreated', 'timemodified',
             'forcesubscribe', 'trackingtype', 'ratingpreference', 'coursewidereputation', 'allowrating',
             'allowreputation', 'allownegativereputation', 'grademaxgrade', 'gradescalefactor', 'gradecat',
-            'anonymous', 'allowmultiplemarks', ]);
+            'anonymous', 'allowmultiplemarks', 'la_starttime', 'la_endtime', ]);
 
         // Define each element separated.
         $discussions = new backup_nested_element('discussions');

classes/output/helpicon.php

@@ -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/>.
+
+/**
+ * Use of the Helpicon from Moodle core.
+ * @package   mod_moodleoverflow
+ * @copyright 2023 Tamaro Walter
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_moodleoverflow\output;
+
+/**
+ * Builds a Helpicon, that shows a String when hovering over it.
+ * @package   mod_moodleoverflow
+ * @copyright 2023 Tamaro Walter
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class helpicon {
+
+    /** @var object The Helpicon*/
+    private $helpobject;
+
+    /**
+     * Builds a Helpicon and stores it in helpobject.
+     *
+     * @param string $htmlclass     The classname in which the icon will be.
+     * @param string $content       A string that shows the information that the icon has.
+     */
+    public function __construct($htmlclass, $content) {
+        global $CFG;
+        $iconurl = $CFG->wwwroot . '/pix/a/help.png';
+        $icon = \html_writer::img($iconurl, $content);
+        $class = $htmlclass;
+        $iconattributes = ['role' => 'button',
+                                    'data-container' => 'body',
+                                    'data-toggle' => 'popover',
+                                    'data-placement' => 'right',
+                                    'data-action' => 'showhelpicon',
+                                    'data-html' => 'true',
+                                    'data-trigger' => 'focus',
+                                    'tabindex' => '0',
+                                    'data-content' => '<div class=&quot;no-overflow&quot;><p>' . $content . '</p> </div>', ];
+        $this->helpobject = \html_writer::span($icon, $class, $iconattributes);
+    }
+
+    /**
+     * Returns the Helpicon, so that it can be used.
+     *
+     * @return object The Helpicon
+     */
+    public function get_helpicon() {
+        return $this->helpobject;
+    }
+}

classes/output/moodleoverflow_email.php

@@ -73,13 +73,13 @@ class moodleoverflow_email implements \renderable, \templatable {
     /**
      * Whether the user can reply to this post.
      *
-     * @var boolean $canreply
+     * @var bool $canreply
      */
     protected $canreply = false;
 
     /**
      * Whether to override forum display when displaying usernames.
-     * @var boolean $viewfullnames
+     * @var bool $viewfullnames
      */
     protected $viewfullnames = false;
 

classes/privacy/provider.php

@@ -50,7 +50,7 @@ class provider implements
      *
      * @return collection the updated collection of metadata items.
      */
-    public static function get_metadata(collection $collection) : collection {
+    public static function get_metadata(collection $collection): collection {
         $collection->add_database_table('moodleoverflow_discussions',
             [
                 'name' => 'privacy:metadata:moodleoverflow_discussions:name',
@@ -135,7 +135,7 @@ public static function get_metadata(collection $collection) : collection {
      *
      * @return contextlist $contextlist The list of contexts used in this plugin.
      */
-    public static function get_contexts_for_userid(int $userid) : contextlist {
+    public static function get_contexts_for_userid(int $userid): contextlist {
         // Fetch all Moodleoverflow discussions, moodleoverflow posts, ratings, tracking settings and subscriptions.
         $sql = "SELECT c.id
                 FROM {context} c

classes/tables/userstats_table.php

@@ -28,6 +28,7 @@
 use mod_moodleoverflow\ratings;
 require_once($CFG->dirroot . '/mod/moodleoverflow/lib.php');
 require_once($CFG->libdir . '/tablelib.php');
+use mod_moodleoverflow\output\helpicon;
 
 /**
  * Table listing all user statistics of a course
@@ -262,6 +263,9 @@ public function get_usertable() {
      */
     public function set_helpactivity() {
         global $CFG;
+        $htmlclass = 'helpactivityclass btn btn-link';
+        $content = get_string('helpamountofactivity', 'moodleoverflow');
+        $helpobject = new helpicon($htmlclass, $content);
         $this->helpactivity = new \stdClass();
         $this->helpactivity->iconurl = $CFG->wwwroot . '/pix/a/help.png';
         $this->helpactivity->icon = \html_writer::img($this->helpactivity->iconurl,

db/install.xml

@@ -28,6 +28,8 @@
         <FIELD NAME="anonymous" TYPE="int" LENGTH="2" NOTNULL="true" DEFAULT="0" SEQUENCE="false"/>
         <FIELD NAME="needsreview" TYPE="int" LENGTH="2" NOTNULL="true" DEFAULT="0" SEQUENCE="false"/>
         <FIELD NAME="allowmultiplemarks" TYPE="int" LENGTH="1" NOTNULL="true" DEFAULT="0" SEQUENCE="false"/>
+        <FIELD NAME="la_starttime" TYPE="int" LENGTH="10" NOTNULL="false" DEFAULT="0" SEQUENCE="false"/>
+        <FIELD NAME="la_endtime" TYPE="int" LENGTH="10" NOTNULL="false" DEFAULT="0" SEQUENCE="false"/>
       </FIELDS>
       <KEYS>
         <KEY NAME="primary" TYPE="primary" FIELDS="id"/>

db/upgrade.php

@@ -292,5 +292,35 @@ function xmldb_moodleoverflow_upgrade($oldversion) {
         upgrade_mod_savepoint(true, 2023040400, 'moodleoverflow');
     }
 
+    if ($oldversion < 2024031105) {
+        // Define table moodleoverflow to be edited.
+        $table = new xmldb_table('moodleoverflow');
+
+        // Define field limitedanswer to be added to moodleoverflow.
+        $field = new xmldb_field('limitedanswer', XMLDB_TYPE_INTEGER, '10', null, null, null, null, 'allowmultiplemarks');
+
+        // Conditionally launch add field limitedanswer.
+        if (!$dbman->field_exists($table, $field)) {
+            $dbman->add_field($table, $field);
+        }
+
+        // Moodleoverflow savepoint reached.
+        upgrade_mod_savepoint(true, 2024031105, 'moodleoverflow');
+    }
+    if ($oldversion < 2024061700) {
+        // Rename the first setting, to have a start and endtime for the limited answer mode.
+        $table = new xmldb_table('moodleoverflow');
+        $field = new xmldb_field('limitedanswer', XMLDB_TYPE_INTEGER, '10', null, null, null, 0, 'allowmultiplemarks');
+        if ($dbman->field_exists($table, $field)) {
+            $dbman->rename_field($table, $field, 'la_starttime');
+        }
+        // Create the field for the end time.
+        $field = new xmldb_field('la_endtime', XMLDB_TYPE_INTEGER, '10', null, null, null, 0, 'la_starttime');
+        if (!$dbman->field_exists($table, $field)) {
+            $dbman->add_field($table, $field);
+        }
+        upgrade_mod_savepoint(true, 2024061700, 'moodleoverflow');
+    }
+
     return true;
 }

discussion.php

@@ -59,6 +59,8 @@
 if ($marksetting->allowmultiplemarks == 1) {
     $multiplemarks = true;
 }
+// Setting of limitedanswer. Limitedanswertime saves the timestamp, until the limitedanswer is on (0 if off).
+$limitedanswersetting = $DB->get_record('moodleoverflow', ['id' => $moodleoverflow->id], 'la_starttime, la_endtime');
 
 // Get the related coursemodule and its context.
 if (!$cm = get_coursemodule_from_instance('moodleoverflow', $moodleoverflow->id, $course->id)) {
@@ -160,7 +162,7 @@
 
 echo '<div id="moodleoverflow-posts"><div id="moodleoverflow-root">';
 
-moodleoverflow_print_discussion($course, $cm, $moodleoverflow, $discussion, $post, $multiplemarks);
+moodleoverflow_print_discussion($course, $cm, $moodleoverflow, $discussion, $post, $multiplemarks, $limitedanswersetting);
 echo '</div></div>';
 
 echo $OUTPUT->footer();

lang/en/moodleoverflow.php

@@ -29,11 +29,11 @@
 
 // Default strings.
 $string['modulename'] = 'Moodleoverflow';
-$string['modulenameplural'] = 'Moodleoverflows';
 $string['modulename_help'] = 'The Moodleoverflow module enables participants to use a question-answer forum structure. The forum display is non-chronological as the ordering depends on collaborative voting instead of on time.';
+$string['modulenameplural'] = 'Moodleoverflows';
+$string['moodleoverflow'] = 'Moodleoverflow';
 $string['moodleoverflowfieldset'] = 'Custom example fieldset';
 $string['moodleoverflowname'] = 'Moodleoverflow name';
-$string['moodleoverflow'] = 'Moodleoverflow';
 $string['pluginadministration'] = 'Moodleoverflow administration';
 $string['pluginname'] = 'Moodleoverflow';
 
@@ -344,7 +344,17 @@
 $string['attachment_help'] = 'You can optionally attach one or more files to a forum post. If you attach an image, it will be displayed after the message.';
 $string['allowmultiplemarks'] = 'Multiple marks?';
 $string['allowmultiplemarks_help'] = 'A post can be marked as helpful or solved. Within a discussion, only one post can be marked as helpful/solved. Click the checkbox to mark multiple posts as helpful/solved.';
-
+$string['limitedanswerheading'] = 'Limited Answer Mode';
+$string['la_starttime'] = 'Start time students can answer';
+$string['la_endtime'] = 'End time students can answer';
+$string['limitedanswerwarning_answers'] = 'There are already answered posts in this Moodleoverflow.';
+$string['limitedanswerwarning_conclusion'] = 'Activating or changing limited answer mode might confuse users.';
+$string['la_starttime_help'] = 'Students can not answer to questions until the set up date';
+$string['la_endtime_help'] = 'Students can not answer to qustions after the set up date';
+$string['limitedanswer_info_start'] = 'This Moodleoverflow is in a limited answer mode.';
+$string['limitedanswer_info_starttime'] = 'Posts can not be answered until {$a->limitedanswerdate}.';
+$string['limitedanswer_info_endtime'] = 'Posts can not be answered after {$a->limitedanswerdate}.';
+$string['limitedanswer_helpicon_teacher'] = 'This can be changed in the settings of the Moodleoverflow.';
 // Templates.
 $string['reputation'] = 'Reputation';
 $string['action_remove_upvote'] = 'Click to remove upvote';