weekly release 4.0dev
[moodle.git] / mod / forum / amd / src / subscription_toggle.js
1 // This file is part of Moodle - http://moodle.org/
2 //
3 // Moodle is free software: you can redistribute it and/or modify
4 // it under the terms of the GNU General Public License as published by
5 // the Free Software Foundation, either version 3 of the License, or
6 // (at your option) any later version.
7 //
8 // Moodle is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11 // GNU General Public License for more details.
12 //
13 // You should have received a copy of the GNU General Public License
14 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
16 /**
17  * Handle discussion subscription toggling on a discussion list in
18  * the forum view.
19  *
20  * @module     mod_forum/subscription_toggle
21  * @package    mod_forum
22  * @copyright  2019 Andrew Nicols <andrew@nicols.co.uk>
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
25 define([
26         'jquery',
27         'core/templates',
28         'core/notification',
29         'mod_forum/repository',
30         'mod_forum/selectors',
31         'core/pubsub',
32         'mod_forum/forum_events',
33     ], function(
34         $,
35         Templates,
36         Notification,
37         Repository,
38         Selectors,
39         PubSub,
40         ForumEvents
41     ) {
43     /**
44      * Register event listeners for the subscription toggle.
45      *
46      * @param {object} root The discussion list root element
47      * @param {boolean} preventDefault Should the default action of the event be prevented
48      * @param {function} callback Success callback
49      */
50     var registerEventListeners = function(root, preventDefault, callback) {
51         root.on('click', Selectors.subscription.toggle, function(e) {
52             var toggleElement = $(this);
53             var forumId = toggleElement.data('forumid');
54             var discussionId = toggleElement.data('discussionid');
55             var subscriptionState = toggleElement.data('targetstate');
57             Repository.setDiscussionSubscriptionState(forumId, discussionId, subscriptionState)
58                 .then(function(context) {
59                     PubSub.publish(ForumEvents.SUBSCRIPTION_TOGGLED, {
60                         discussionId: discussionId,
61                         subscriptionState: subscriptionState
62                     });
63                     return callback(toggleElement, context);
64                 })
65                 .catch(Notification.exception);
67             if (preventDefault) {
68                 e.preventDefault();
69             }
70         });
71     };
73     return {
74         init: registerEventListeners
75     };
76 });