MDL-65033 mod_forum: Move locked functionality into action menu

Moved the lock functionality into the menu which exposes it to the
discussion list

diff --git a/mod/forum/amd/build/discussion_list.min.js b/mod/forum/amd/build/discussion_list.min.js
index ebee587..dc8b9ff 100644 (file)
Binary files a/mod/forum/amd/build/discussion_list.min.js and b/mod/forum/amd/build/discussion_list.min.js differ

diff --git a/mod/forum/amd/src/discussion_list.js b/mod/forum/amd/src/discussion_list.js
index 02f1473..06ea7dc 100644 (file)
--- a/mod/forum/amd/src/discussion_list.js
+++ b/mod/forum/amd/src/discussion_list.js
@@ -23,11 +23,17 @@
  */
 define([
     'jquery',
+    'core/templates',
+    'core/str',
+    'core/notification',
     'mod_forum/subscription_toggle',
     'mod_forum/selectors',
     'mod_forum/repository',
 ], function(
     $,
+    Templates,
+    String,
+    Notification,
     SubscriptionToggle,
     Selectors,
     Repository
@@ -57,6 +63,34 @@ define([
                 })
                 .catch(Notification.exception);
         });
+
+        root.on('click', Selectors.lock.toggle, function(e) {
+            var toggleElement = $(this);
+            var forumId = toggleElement.data('forumid');
+            var discussionId = toggleElement.data('discussionid');
+            var state = toggleElement.data('state');
+
+            Repository.setDiscussionLockState(forumId, discussionId, state)
+                .then(function(context) {
+                    context.forumid = forumId;
+                    return Templates.render('mod_forum/discussion_lock_toggle', context);
+                })
+                .then(function(html, js) {
+                    return Templates.replaceNode(toggleElement, html, js);
+                })
+                .then(function() {
+                    return String.get_string('lockupdated', 'forum')
+                        .done(function(s) {
+                            return Notification.addNotification({
+                                message: s,
+                                type: "info"
+                            });
+                        });
+                })
+                .catch(Notification.exception);
+
+            e.preventDefault();
+        });
     };
 
     return {

diff --git a/mod/forum/externallib.php b/mod/forum/externallib.php
index 8a20dc3..47cf764 100644 (file)
--- a/mod/forum/externallib.php
+++ b/mod/forum/externallib.php
@@ -1642,6 +1642,36 @@ class mod_forum_external extends external_api {
         return $exporter->export($PAGE->get_renderer('mod_forum'));
     }
 
+    /**
+     * Returns description of method parameters.
+     *
+     * @return external_function_parameters
+     */
+    public static function set_lock_state_parameters() {
+        return new external_function_parameters(
+            [
+                'forumid' => new external_value(PARAM_INT, 'Forum that the discussion is in'),
+                'discussionid' => new external_value(PARAM_INT, 'The discussion to lock / unlock'),
+                'targetstate' => new external_value(PARAM_INT, 'The timestamp for the lock state')
+            ]
+        );
+    }
+
+    /**
+     * Returns description of method result value.
+     *
+     * @return external_description
+     */
+    public static function set_lock_state_returns() {
+        return new external_single_structure([
+            'id' => new external_value(PARAM_INT, 'The discussion we are locking.'),
+            'locked' => new external_value(PARAM_BOOL, 'The locked state of the discussion.'),
+            'times' => new external_single_structure([
+                'locked' => new external_value(PARAM_INT, 'The locked time of the discussion.'),
+            ])
+        ]);
+    }
+
     /**
      * Set the pin state.
      *
@@ -1672,29 +1702,13 @@ class mod_forum_external extends external_api {
         }
 
         $discussion->set_pinned($targetstate);
-        $discussionrecord = $legacydatamapperfactory->get_discussion_data_mapper()->to_legacy_object($discussion);
-        $discussionvault->update_discussion($discussionrecord);
+        $discussionvault->update_discussion($discussion);
 
         $exporterfactory = mod_forum\local\container::get_exporter_factory();
         $exporter = $exporterfactory->get_discussion_exporter($USER, $forum, $discussion);
         return $exporter->export($PAGE->get_renderer('mod_forum'));
     }
 
-    /**
-     * Returns description of method parameters.
-     *
-     * @return external_function_parameters
-     */
-    public static function set_lock_state_parameters() {
-        return new external_function_parameters(
-            [
-                'forumid' => new external_value(PARAM_INT, 'Forum that the discussion is in'),
-                'discussionid' => new external_value(PARAM_INT, 'The discussion to lock / unlock'),
-                'targetstate' => new external_value(PARAM_INT, 'The timestamp for the lock state')
-            ]
-        );
-    }
-
     /**
      * Returns description of method parameters.
      *
@@ -1711,21 +1725,6 @@ class mod_forum_external extends external_api {
         );
     }
 
-    /**
-     * Returns description of method result value.
-     *
-     * @return external_description
-     */
-    public static function set_lock_state_returns() {
-        return new external_single_structure([
-            'id' => new external_value(PARAM_INT, 'The discussion we are locking.'),
-            'locked' => new external_value(PARAM_BOOL, 'The locked state of the discussion.'),
-            'times' => new external_single_structure([
-                'locked' => new external_value(PARAM_INT, 'The locked time of the discussion.'),
-            ])
-        ]);
-    }
-
     /**
      * Returns description of method result value.
      *

diff --git a/mod/forum/lang/en/forum.php b/mod/forum/lang/en/forum.php
index f3bdd8d..c1827a2 100644 (file)
--- a/mod/forum/lang/en/forum.php
+++ b/mod/forum/lang/en/forum.php
@@ -325,6 +325,7 @@ $string['lockdiscussionafter_help'] = 'Discussions may be automatically locked a
 Users with the capability to reply to locked discussions can unlock a discussion by replying to it.';
 $string['longpost'] = 'Long post';
 $string['locked'] = 'Locked';
+$string['lockupdated'] = 'The lock option has been updated.';
 $string['mailnow'] = 'Send forum post notifications with no editing-time delay';
 $string['manydiscussions'] = 'Discussions per page';
 $string['managesubscriptionsoff'] = 'Finish managing subscriptions';

diff --git a/mod/forum/styles.css b/mod/forum/styles.css
index a58e70e..5a0334a 100644 (file)
--- a/mod/forum/styles.css
+++ b/mod/forum/styles.css
@@ -302,7 +302,6 @@ span.unread {
 }
 
 .path-mod-forum .discussionsubscription,
-.path-mod-forum .discussionlock,
 .path-mod-forum .discussion-settings-menu,
 .path-mod-forum .discussionsubscription {
     margin-top: -10px;

diff --git a/mod/forum/templates/discussion_lock_toggle.mustache b/mod/forum/templates/discussion_lock_toggle.mustache
index 396fafd..0a55e95 100644 (file)
--- a/mod/forum/templates/discussion_lock_toggle.mustache
+++ b/mod/forum/templates/discussion_lock_toggle.mustache
@@ -35,12 +35,12 @@
     }
 }}
 <a
-    class="iconsmall"
+    class="btn btn-link"
     data-type="lock-toggle"
     data-action="toggle"
     data-discussionid="{{id}}"
     data-forumid="{{forumid}}"
-    data-state="{{locked}}"
+    data-state="{{times.locked}}"
     href="#"
     {{#locked}}
         title="{{#str}}clicktounlockdiscussion, forum{{/str}}"
@@ -50,9 +50,9 @@
     {{/locked}}
 >
     {{#locked}}
-        {{#pix}}t/unlock, core, {{#str}}clicktounlockdiscussion, forum{{/str}}{{/pix}}{{#str}}locked, forum{{/str}}
+        {{#str}}locked, forum{{/str}}
     {{/locked}}
     {{^locked}}
-        {{#pix}}t/lock, core, {{#str}}clicktolockdiscussion, forum{{/str}}{{/pix}}{{#str}}notlocked, forum{{/str}}
+        {{#str}}notlocked, forum{{/str}}
     {{/locked}}
 </a>
\ No newline at end of file

diff --git a/mod/forum/templates/forum_action_menu.mustache b/mod/forum/templates/forum_action_menu.mustache
index dfa3654..09cf1c7 100644 (file)
--- a/mod/forum/templates/forum_action_menu.mustache
+++ b/mod/forum/templates/forum_action_menu.mustache
@@ -59,5 +59,12 @@
             {{> mod_forum/discussion_pin_toggle}}
         </div>
         {{/capabilities.pin}}
+        {{#capabilities.manage}}
+        {{^istimelocked}}
+        <div class="dropdown-item" role="menuitem">
+            {{> forum/discussion_lock_toggle }}
+        </div>
+        {{/istimelocked}}
+        {{/capabilities.manage}}
     </div>
 </div>
\ No newline at end of file

diff --git a/mod/forum/templates/forum_discussion.mustache b/mod/forum/templates/forum_discussion.mustache
index 3799616..f4d37ff 100644 (file)
--- a/mod/forum/templates/forum_discussion.mustache
+++ b/mod/forum/templates/forum_discussion.mustache
@@ -33,13 +33,7 @@
 <div id="discussion-container-{{uniqid}}" data-content="forum-discussion">
 {{#html}}
     <div class="d-flex flex-wrap flex-row-reverse m-b-1 text-right" data-container="discussion-tools">
-        {{#capabilities.manage}}
-        {{^istimelocked}}
-        <div class="pl-1 discussionlock">
-            {{> forum/discussion_lock_toggle }}
-        </div>
-        {{/istimelocked}}
-        {{/capabilities.manage}}
+
         <div class="pl-1">
             <div class="discussion-settings-menu">
                 {{> mod_forum/forum_action_menu}}

diff --git a/mod/forum/tests/behat/discussion_lock.feature b/mod/forum/tests/behat/discussion_lock.feature
index 0fcce46..8e2c550 100644 (file)
--- a/mod/forum/tests/behat/discussion_lock.feature
+++ b/mod/forum/tests/behat/discussion_lock.feature
@@ -34,11 +34,14 @@ Feature: As a teacher, you can manually lock individual discussions when viewing
     Given I log in as "admin"
     And I am on "Course 1" course homepage
     And I navigate to post "Discussion 1" in "Test forum name" forum
+    And I press "Settings"
     Then "Lock" "link" should be visible
     And I follow "Lock"
+    Then I should see "This discussion has been locked so you can no longer reply to it."
+    And I press "Settings"
     Then "a[@title='Lock']" "css_element" should not be visible
     Then "Locked" "link" should be visible
-    Then I should see "This discussion has been locked so you can no longer reply to it."
+    And I press "Settings"
     And I follow "Discussion 2"
     Then I should not see "This discussion has been locked so you can no longer reply to it."
     And I log out

diff --git a/theme/boost/scss/moodle/modules.scss b/theme/boost/scss/moodle/modules.scss
index 16015d5..e0e162e 100644 (file)
--- a/theme/boost/scss/moodle/modules.scss
+++ b/theme/boost/scss/moodle/modules.scss
@@ -69,7 +69,6 @@ select {
 
         thead .header th,
         tbody .discussion td {
-            &.discussionlock,
             &.discussionsubscription {
                 width: 16px;
                 padding-left: 0.5em;
@@ -84,14 +83,12 @@ select {
             }
 
             .discussionsubscription,
-            .discussionlock,
             .replies {
                 text-align: center;
             }
 
             .topic,
             .discussionsubscription,
-            .discussionlock,
             .topic.starter,
             .replies,
             .lastpost {

diff --git a/theme/boost/style/moodle.css b/theme/boost/style/moodle.css
index 0e6fadd..bda128b 100644 (file)
--- a/theme/boost/style/moodle.css
+++ b/theme/boost/style/moodle.css
@@ -15028,8 +15028,7 @@ select {
 .path-mod-forum .forumheaderlist thead .header.lastpost {
   text-align: right; }
 
-.path-mod-forum .forumheaderlist thead .header th.discussionlock, .path-mod-forum .forumheaderlist thead .header th.discussionsubscription,
-.path-mod-forum .forumheaderlist tbody .discussion td.discussionlock,
+.path-mod-forum .forumheaderlist thead .header th.discussionsubscription,
 .path-mod-forum .forumheaderlist tbody .discussion td.discussionsubscription {
   width: 16px;
   padding-left: 0.5em;
@@ -15040,13 +15039,11 @@ select {
   white-space: normal; }
 
 .path-mod-forum .forumheaderlist .discussion .discussionsubscription,
-.path-mod-forum .forumheaderlist .discussion .discussionlock,
 .path-mod-forum .forumheaderlist .discussion .replies {
   text-align: center; }
 
 .path-mod-forum .forumheaderlist .discussion .topic,
 .path-mod-forum .forumheaderlist .discussion .discussionsubscription,
-.path-mod-forum .forumheaderlist .discussion .discussionlock,
 .path-mod-forum .forumheaderlist .discussion .topic.starter,
 .path-mod-forum .forumheaderlist .discussion .replies,
 .path-mod-forum .forumheaderlist .discussion .lastpost {

diff --git a/theme/classic/style/moodle.css b/theme/classic/style/moodle.css
index 64dbcba..be05743 100644 (file)
--- a/theme/classic/style/moodle.css
+++ b/theme/classic/style/moodle.css
@@ -15285,8 +15285,7 @@ select {
 .path-mod-forum .forumheaderlist thead .header.lastpost {
   text-align: right; }
 
-.path-mod-forum .forumheaderlist thead .header th.discussionlock, .path-mod-forum .forumheaderlist thead .header th.discussionsubscription,
-.path-mod-forum .forumheaderlist tbody .discussion td.discussionlock,
+.path-mod-forum .forumheaderlist thead .header th.discussionsubscription,
 .path-mod-forum .forumheaderlist tbody .discussion td.discussionsubscription {
   width: 16px;
   padding-left: 0.5em;
@@ -15297,13 +15296,11 @@ select {
   white-space: normal; }
 
 .path-mod-forum .forumheaderlist .discussion .discussionsubscription,
-.path-mod-forum .forumheaderlist .discussion .discussionlock,
 .path-mod-forum .forumheaderlist .discussion .replies {
   text-align: center; }
 
 .path-mod-forum .forumheaderlist .discussion .topic,
 .path-mod-forum .forumheaderlist .discussion .discussionsubscription,
-.path-mod-forum .forumheaderlist .discussion .discussionlock,
 .path-mod-forum .forumheaderlist .discussion .topic.starter,
 .path-mod-forum .forumheaderlist .discussion .replies,
 .path-mod-forum .forumheaderlist .discussion .lastpost {