Configure subscriptions to discussions like in forum activity.

rwthmoodle · Dec 6, 2024 · ce680e6 · ce680e6
1 parent feb05cc
commit ce680e6
Show file tree

Hide file tree

Showing 15 changed files with 1,325 additions and 29 deletions.
diff --git a/backup/moodle2/backup_pdfannotator_stepslib.php b/backup/moodle2/backup_pdfannotator_stepslib.php
@@ -55,7 +55,7 @@ protected function define_structure() {
         // 2. Define each element separately.
         $pdfannotator = new backup_nested_element('pdfannotator', array('id'), array(
             'name', 'intro', 'introformat', 'usevotes', 'useprint', 'useprintcomments', 'use_studenttextbox', 'use_studentdrawing',
-            'useprivatecomments', 'useprotectedcomments', 'timecreated', 'timemodified'));
+            'useprivatecomments', 'useprotectedcomments', 'forcesubscribe', 'timecreated', 'timemodified'));
 
             $annotations = new backup_nested_element('annotations');
             $annotation = new backup_nested_element('annotation', array('id'), array('page', 'userid', 'annotationtypeid',

diff --git a/classes/output/comment.php b/classes/output/comment.php
@@ -83,7 +83,7 @@ public function __construct($data, $cm, $context) {
             $this->addeditbutton($comment, $editanypost);
             $this->addhidebutton($comment, $seehiddencomments, $hidecomments);
             $this->adddeletebutton($comment, $deleteown, $deleteany);
-            $this->addsubscribebutton($comment, $subscribe);
+            $this->addsubscribebutton($comment, $subscribe, $cm);
             $this->addforwardbutton($comment, $forwardquestions, $cm);
             $this->addmarksolvedbutton($comment, $solve);
 
@@ -270,15 +270,26 @@ private function adddeletebutton($comment, $deleteown, $deleteany) {
         }
     }
 
-    private function addsubscribebutton($comment, $subscribe) {
+    /**
+     * Add a subscribe button
+     *
+     * @param object $comment
+     * @param bool $subscribe
+     * @param stdClass $cm course module object
+     * @throws \coding_exception
+     */
+    private function addsubscribebutton($comment, $subscribe, $cm) {
         if (!isset($comment->type) && $comment->isquestion && $subscribe && $comment->visibility != 'private') {
-            // Only set for textbox and drawing.
-            if (!empty($comment->issubscribed)) {
-                $comment->buttons[] = ["classes" => "comment-subscribe-a", "faicon" => ["class" => "fa-bell-slash"],
-                    "text" => get_string('unsubscribeQuestion', 'pdfannotator')];
-            } else {
-                $comment->buttons[] = ["classes" => "comment-subscribe-a", "faicon" => ["class" => "fa-bell"],
-                    "text" => get_string('subscribeQuestion', 'pdfannotator')];
+            // Only set for textbox and drawing, and only if subscription mode is not disabled or forced.
+            if ((pdfannotator_get_subscriptionmode($cm->instance) == PDFANNOTATOR_CHOOSESUBSCRIBE) ||
+                (pdfannotator_get_subscriptionmode($cm->instance) == PDFANNOTATOR_INITIALSUBSCRIBE)) {
+                if (!empty($comment->issubscribed)) {
+                    $comment->buttons[] = ["classes" => "comment-subscribe-a", "faicon" => ["class" => "fa-bell-slash"],
+                        "text" => get_string('unsubscribeQuestion', 'pdfannotator')];
+                } else {
+                    $comment->buttons[] = ["classes" => "comment-subscribe-a", "faicon" => ["class" => "fa-bell"],
+                        "text" => get_string('subscribeQuestion', 'pdfannotator')];
+                }
             }
         }
     }