Add subscription toggle to overview

User can now see if they are subscribed to a moodleoverflow and change the subscription mode via Ajax directly

Author: TamaroWalter

amd/build/toggle_subscription.min.js

@@ -0,0 +1,52 @@
+// 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/>.
+
+/**
+ * JavaScript to change the subscription status of a user.
+ * This module is used in the activity overview page where a user can change the subscription status of a moodleoverflow with
+ * a toggle button.
+ * @module     mod_moodleoverflow/toggle_subscription
+ * @copyright  2026 Tamaro Walter
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+import Ajax from 'core/ajax';
+
+
+/**
+ * Init function
+ * @param {string} itemid
+ */
+export function init(itemid) {
+    // Get the right subscription toggle element.
+    const element = document.getElementById(itemid);
+    element.addEventListener('change', function() {
+            const userid = parseInt(element.dataset.userid);
+            const cmid = parseInt(element.dataset.cmid);
+            const subscribed = element.dataset.subscribed === 'true';
+            const data = {
+                methodname: 'mod_moodleoverflow_change_subscription_mode',
+                args: {
+                    userid: userid,
+                    subscribed: subscribed,
+                    cmid: cmid
+                },
+            };
+            element.dataset.subscribed = Boolean(!subscribed);
+            // Call the AJAX function.
+            return Ajax.call([data]);
+        }
+    );
+}

amd/build/toggle_subscription.min.js.map

@@ -18,6 +18,7 @@
 
 
 use cm_info;
+use context_module;
 use core\output\action_link;
 use core\output\local\properties\button;
 use core\output\local\properties\text_align;
@@ -26,6 +27,7 @@
 use core_courseformat\activityoverviewbase;
 use core_courseformat\local\overview\overviewitem;
 use mod_moodleoverflow\readtracking;
+use mod_moodleoverflow\subscriptions;
 
 /**
  * Checklist overview integration (for Moodle 5.0+)
@@ -104,7 +106,43 @@ private function get_extra_unread_posts_overview(): ?overviewitem {
     * @return overviewitem|null
     */
     private function get_extra_subscriptions_overview(): ?overviewitem {
-        return null;
+        global $USER, $DB, $PAGE;
+        // Get important objects.
+        $moodleoverflow = $DB->get_record('moodleoverflow', ['id' => $this->cm->instance], '*', MUST_EXIST);
+        $modulecontext = context_module::instance($this->cm->id);
+        $itemid = 'moodleoverflow-subscription-toggle-' . $moodleoverflow->id;
+        debugging('CM object: ' . print_r($this->cm, true), DEBUG_DEVELOPER);
+
+        // Check the subscription status of the user and if it's changable.
+        $subscribed = subscriptions::is_subscribed($USER->id, $moodleoverflow, $modulecontext);
+        $changable = subscriptions::is_subscribable($moodleoverflow, $modulecontext);
+
+        // Build the content.
+        $renderer =  $PAGE->get_renderer('core_reportbuilder');
+        $content = $renderer->render_from_template(
+            'core/toggle',
+            [
+                'id' => $itemid,
+                'checked' => $subscribed,
+                'disabled' => !$changable,
+                'extraattributes' =>  [
+                    ['name' => 'data-type', 'value' => 'moodleoverflow-subscription-toggle'],
+                    ['name' => 'data-action', 'value' => 'toggle'],
+                    ['name' => 'data-cmid', 'value' => $this->cm->id],
+                    ['name' => 'data-userid', 'value' => $USER->id],
+                    ['name' => 'data-subscribed', 'value' => $subscribed ? 'true' : 'false'],
+                ],
+            ],
+        );
+
+        // Add js to change subscription.
+        $PAGE->requires->js_call_amd('mod_moodleoverflow/toggle_subscription', 'init', [$itemid]);
+
+        return new overviewitem(
+            name: get_string('subscribed', 'mod_moodleoverflow'),
+            value: 'hallo',
+            content: $content,
+        );
     }
 
     /**

amd/src/toggle_subscription.js

@@ -641,9 +641,9 @@ public static function reset_moodleoverflow_cache() {
      * @param context_module $context        The module context
      * @param bool            $userrequest    Whether the user requested this change themselves.
      *
-     * @return bool|int Returns true if the user is already subscribed or the subscription id if successfully subscribed.
+     * @return bool
      */
-    public static function subscribe_user($userid, $moodleoverflow, $context, $userrequest = false) {
+    public static function subscribe_user($userid, $moodleoverflow, $context, $userrequest = false): bool {
         global $DB;
 
         // Check if the user is already subscribed.
@@ -693,8 +693,8 @@ public static function subscribe_user($userid, $moodleoverflow, $context, $userr
         $event = event\subscription_created::create($params);
         $event->trigger();
 
-        // Return the subscription ID.
-        return $result;
+        // Return if the operation was successful. As insert_record returns true/false/id, a parse to a bool is made.
+        return (bool) $result;
     }
 
     /**

classes/courseformat/overview.php

@@ -50,4 +50,12 @@
         'type' => 'write',
         'ajax' => true,
     ],
+    'mod_moodleoverflow_change_subscription_mode' => [
+        'classname' => 'mod_moodleoverflow_external',
+        'methodname' => 'change_subscription_mode',
+        'classpath' => 'mod/moodleoverflow/externallib.php',
+        'description' => 'Rejects a post',
+        'type' => 'write',
+        'ajax' => true,
+    ],
 ];

classes/subscriptions.php

@@ -25,6 +25,7 @@
 use mod_moodleoverflow\anonymous;
 use mod_moodleoverflow\output\moodleoverflow_email;
 use mod_moodleoverflow\review;
+use mod_moodleoverflow\subscriptions;
 
 defined('MOODLE_INTERNAL') || die;
 
@@ -310,4 +311,47 @@ public static function review_reject_post($postid, $reason = null) {
 
         return $url;
     }
+
+    /**
+     * Returns description of method parameters for change_subscription_mode
+     * @return external_function_parameters
+     */
+    public static function change_subscription_mode_parameters(): external_function_parameters {
+        return new external_function_parameters(
+            [
+                'userid' => new external_value(PARAM_INT, 'the user id'),
+                'subscribed' => new external_value(PARAM_BOOL, 'current subscription status'),
+                'cmid' => new external_value(PARAM_INT, 'course module id that is targeted'),
+            ]
+        );
+    }
+
+    /**
+     * Return the result of the change_subscription_mode function
+     * @return external_value
+     */
+    public static function change_subscription_mode_returns(): external_value {
+        return new external_value(PARAM_BOOL, 'true if successful');
+    }
+
+    /**
+     * Changes the subscription mode on a moodleoverflow
+     * @param int $userid The user the setting will be changed for.
+     * @param bool $subscribed current subscription status. True if user is subscribed, false it user is not subscribed.
+     * @param int $cmid The moodleoverflow that is being targeted.
+     * @return bool
+     */
+    public static function change_subscription_mode(int $userid, bool $subscribed, int $cmid): bool {
+        global $DB;
+        // Get the moodleoverflow from the cmid.
+        $cm = get_coursemodule_from_id('moodleoverflow', $cmid, 0, false, MUST_EXIST);
+        $moodleoverflow = $DB->get_record('moodleoverflow', ['id' => $cm->instance], '*', MUST_EXIST);
+        $modulecontext = context_module::instance($cmid);
+
+        if ($subscribed) {
+            return subscriptions::unsubscribe_user($userid, $moodleoverflow, $modulecontext, true);
+        } else {
+            return subscriptions::subscribe_user($userid, $moodleoverflow, $modulecontext, true);
+        }
+    }
 }

db/services.php

@@ -26,7 +26,7 @@
 
 defined('MOODLE_INTERNAL') || die();
 
-$plugin->version = 2025112702;
+$plugin->version = 2025112703;
 $plugin->requires = 2024100700.00; // Require Moodle 4.5.
 $plugin->supported = [405, 501];
 $plugin->component = 'mod_moodleoverflow';