Review changes

Author: abias

CHANGES.md

@@ -6,6 +6,7 @@ Changes
 
 ### Unreleased
 
+* 2024-04-20 - Improvement: Add hint that notifications don't work within forums for hidden courses, resolves #98.
 * 2024-04-20 - Cleanup: Add proper JS promise error handling, resolves #435.
 
 ### v4.3-r11

README.md

@@ -545,6 +545,10 @@ In this tab there are the following settings:
 
 With this setting a hint will appear in the course header if the user has switched the role in the course.
 
+###### Show hint for forum notifications in hidden courses
+
+With this setting a hint will not only appear in the course header but also in forums as long as the visibility of the course is hidden.
+
 ###### Show hint in hidden courses
 
 With this setting a hint will appear in the course header as long as the visibility of the course is hidden.

lang/en/theme_boost_union.php

@@ -933,10 +933,10 @@
 $string['showhintcoursehiddensetting_desc'] = 'With this setting a hint will appear in the course header as long as the visibility of the course is hidden. This helps to identify the visibility state of a course at a glance without the need for looking at the course settings.';
 $string['showhintcoursehiddengeneral'] = 'This course is currently <strong>hidden</strong>. Only enrolled teachers can access this course when hidden.';
 $string['showhintcoursehiddensettingslink'] = 'You can change the visibility in the <a href="{$a->url}">course settings</a>.';
-// ... ... Setting: Show hint that notifications don't work within forums for hidden courses.
-$string['showhintforumnotificationssetting'] = 'Show hint regarding notifications in hidden courses';
-$string['showhintforumnotificationssetting_desc'] = 'When a course is hidden notifications within a forum are not send to students. To clarify this a hint will appear on forums within a hidden course to help the teachers understand this circumstance.';
-$string['showhintforumnotifications'] = 'This course is currently <strong>hidden</strong>. Please note that this means that <strong>students will not be notified</strong> online or by email of any messages you post in this forum.';
+// ... ... Setting: Show hint for forum notifications in hidden courses.
+$string['showhintforumnotificationssetting'] = 'Show hint for forum notifications in hidden courses';
+$string['showhintforumnotificationssetting_desc'] = 'With this setting a hint will not only appear in the course header but also in forums as long as the visibility of the course is hidden. This is to clarify that notifications within a forum are not send to students and to help the teachers understand this circumstance.';
+$string['showhintforumnotifications'] = 'This course is currently <strong>hidden</strong>. This means that <strong>students will not be notified</strong> online or by email of any messages you post in this forum.';
 // ... ... Setting: Show hint for guest access.
 $string['showhintcoursguestaccesssetting'] = 'Show hint for guest access';
 $string['showhintcourseguestaccesssetting_desc'] = 'With this setting a hint will appear in the course header when a user is accessing it with the guest access feature. If the course provides an active self enrolment, a link to that page is also presented to the user.';

locallib.php

@@ -59,7 +59,9 @@ function theme_boost_union_get_course_related_hints() {
         // If the setting showhintcoursehiddennotifications is set too and we view a forum (e.g. announcement) within a hidden
         // course a hint will be shown that no notifications via forums will be sent out to students.
         if (get_config('theme_boost_union', 'showhintforumnotifications') == THEME_BOOST_UNION_SETTING_SELECT_YES
-                && $PAGE->url->compare(new moodle_url('/mod/forum/view.php'), URL_MATCH_BASE)) {
+                && ($PAGE->url->compare(new moodle_url('/mod/forum/view.php'), URL_MATCH_BASE) ||
+                        $PAGE->url->compare(new moodle_url('/mod/forum/discuss.php'), URL_MATCH_BASE) ||
+                        $PAGE->url->compare(new moodle_url('/mod/forum/post.php'), URL_MATCH_BASE))) {
             // Use the specialized hint text for hidden courses on forum pages.
             $hintcoursehiddentext = get_string('showhintforumnotifications', 'theme_boost_union');
         }

settings.php

@@ -2527,14 +2527,14 @@
         $setting = new admin_setting_configselect($name, $title, $description, THEME_BOOST_UNION_SETTING_SELECT_NO, $yesnooption);
         $tab->add($setting);
 
-        // Setting: Show hint at forums within hidden courses that notifications are not send.
+        // Setting: Show hint for forum notifications in hidden courses.
         $name = 'theme_boost_union/showhintforumnotifications';
         $title = get_string('showhintforumnotificationssetting', 'theme_boost_union', null, true);
         $description = get_string('showhintforumnotificationssetting_desc', 'theme_boost_union', null, true);
         $setting = new admin_setting_configselect($name, $title, $description, THEME_BOOST_UNION_SETTING_SELECT_NO, $yesnooption);
         $tab->add($setting);
         $page->hide_if('theme_boost_union/showhintforumnotifications', 'theme_boost_union/showhintcoursehidden', 'neq',
-            THEME_BOOST_UNION_SETTING_SELECT_YES);
+                THEME_BOOST_UNION_SETTING_SELECT_YES);
 
         // Setting: Show hint guest for access.
         $name = 'theme_boost_union/showhintcourseguestaccess';

tests/behat/theme_boost_union_functionalitysettings_courses.feature

@@ -16,11 +16,6 @@ Feature: Configuring the theme_boost_union plugin for the "Courses" tab on the "
       | user     | course | role           |
       | teacher1 | C1     | editingteacher |
       | student1 | C1     | student        |
-    And the following "activity" exists:
-      | course   | C1            |
-      | activity | forum         |
-      | idnumber | Announcements |
-      | name     | Announcements |
 
   Scenario: Setting: Show hint for switched role - Enable the setting
     Given the following config values are set as admin:
@@ -41,38 +36,43 @@ Feature: Configuring the theme_boost_union plugin for the "Courses" tab on the "
       | showhintcoursehidden | yes   | theme_boost_union |
     When I log in as "teacher1"
     And I am on "Course 1" course homepage
-    When I navigate to "Settings" in current page administration
+    And I navigate to "Settings" in current page administration
     And I set the following fields to these values:
       | Course visibility | Hide |
     And I click on "Save and display" "button"
     Then I should see "This course is currently hidden. Only enrolled teachers can access this course when hidden." in the ".course-hint-hidden" "css_element"
     When I am on "Course 1" course homepage
-    When I navigate to "Settings" in current page administration
+    And I navigate to "Settings" in current page administration
     And I set the following fields to these values:
       | Course visibility | Show |
     And I click on "Save and display" "button"
     Then I should not see "This course is currently hidden. Only enrolled teachers can access this course when hidden."
     And ".course-hint-hidden" "css_element" should not exist
 
-  Scenario: Setting: Show hint at forums in hidden courses that notifications do not work - Enable the setting
-    Given the following config values are set as admin:
+  Scenario: Setting: Show hint for forum notifications in hidden courses - Enable the setting
+    Given the following "activity" exists:
+      | course   | C1            |
+      | activity | forum         |
+      | idnumber | Announcements |
+      | name     | Announcements |
+    And the following config values are set as admin:
       | config                     | value | plugin            |
       | showhintcoursehidden       | yes   | theme_boost_union |
       | showhintforumnotifications | yes   | theme_boost_union |
     When I log in as "teacher1"
     And I am on "Course 1" course homepage
-    When I navigate to "Settings" in current page administration
+    And I navigate to "Settings" in current page administration
     And I set the following fields to these values:
       | Course visibility | Hide |
     And I click on "Save and display" "button"
-    When I am on the "Announcements" "forum activity" page
-    Then I should see "This course is currently hidden. Please note that this means that students will not be notified online or by email of any messages you post in this forum." in the ".course-hint-hidden" "css_element"
+    And I am on the "Announcements" "forum activity" page
+    Then I should see "This course is currently hidden. This means that students will not be notified online or by email of any messages you post in this forum." in the ".course-hint-hidden" "css_element"
     When I am on "Course 1" course homepage
-    When I navigate to "Settings" in current page administration
+    And I navigate to "Settings" in current page administration
     And I set the following fields to these values:
       | Course visibility | Show |
     And I click on "Save and display" "button"
-    Then I should not see "This course is currently hidden. Please note that this means that students will not be notified online or by email of any messages you post in this forum."
+    Then I should not see "This course is currently hidden. This means that students will not be notified online or by email of any messages you post in this forum."
     And ".course-hint-hidden" "css_element" should not exist
 
   Scenario: Setting: Show hint guest for access - Enable the setting

version.php

@@ -25,7 +25,7 @@
 defined('MOODLE_INTERNAL') || die();
 
 $plugin->component = 'theme_boost_union';
-$plugin->version = 2023102033;
+$plugin->version = 2023102034;
 $plugin->release = 'v4.3-r11';
 $plugin->requires = 2023100900;
 $plugin->supported = [403, 403];