fix moodle-an-hochschulen#98-further-hints-on-hidden-courses

Menrath · Menrath · commit 877925ee9801 · 2024-04-09T10:07:08.000+02:00
diff --git a/lang/en/theme_boost_union.php b/lang/en/theme_boost_union.php
@@ -933,6 +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 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.';
diff --git a/locallib.php b/locallib.php
@@ -40,26 +40,47 @@ function theme_boost_union_get_course_related_hints() {
     // Initialize HTML code.
     $html = '';
 
-    // If the setting showhintcoursehidden is set and the visibility of the course is hidden and
+    // If the setting showhintcoursehidden is set and the visibility of the course is hidden
     // a hint for the visibility will be shown.
     if (get_config('theme_boost_union', 'showhintcoursehidden') == THEME_BOOST_UNION_SETTING_SELECT_YES
             && has_capability('theme/boost_union:viewhintinhiddencourse', \context_course::instance($COURSE->id))
             && $PAGE->has_set_url()
-            && $PAGE->url->compare(new moodle_url('/course/view.php'), URL_MATCH_BASE)
             && $COURSE->visible == false) {
 
-        // Prepare template context.
-        $templatecontext = ['courseid' => $COURSE->id];
+        // The hint will only be shown when the course is viewed.
+        if ($PAGE->url->compare(new moodle_url('/course/view.php'), URL_MATCH_BASE)) {
+            // Prepare template context.
+            $templatecontext = ['courseid' => $COURSE->id];
 
-        // If the user has the capability to change the course settings, an additional link to the course settings is shown.
-        if (has_capability('moodle/course:update', context_course::instance($COURSE->id))) {
-            $templatecontext['showcoursesettingslink'] = true;
-        } else {
-            $templatecontext['showcoursesettingslink'] = false;
+            // If the user has the capability to change the course settings, an additional link to the course settings is shown.
+            if (has_capability('moodle/course:update', context_course::instance($COURSE->id))) {
+                $templatecontext['showcoursesettingslink'] = true;
+            } else {
+                $templatecontext['showcoursesettingslink'] = false;
+            }
+
+            // Render template and add it to HTML code.
+            $html .= $OUTPUT->render_from_template('theme_boost_union/course-hint-hidden', $templatecontext);
         }
 
-        // Render template and add it to HTML code.
-        $html .= $OUTPUT->render_from_template('theme_boost_union/course-hint-hidden', $templatecontext);
+        // 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)) {
+
+            // Prepare template context.
+            $templatecontext = ['courseid' => $COURSE->id];
+
+            // If the user has the capability to change the course settings, an additional link to the course settings is shown.
+            if (has_capability('moodle/course:update', context_course::instance($COURSE->id))) {
+                $templatecontext['showcoursesettingslink'] = true;
+            } else {
+                $templatecontext['showcoursesettingslink'] = false;
+            }
+
+            // Render template and add it to HTML code.
+            $html .= $OUTPUT->render_from_template('theme_boost_union/course-hint-hidden-forum-notifications', $templatecontext);
+        }
     }
 
     // If the setting showhintcourseguestaccess is set and the user is accessing the course with guest access,
diff --git a/settings.php b/settings.php
@@ -2527,6 +2527,15 @@
         $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.
+        $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);
+
         // Setting: Show hint guest for access.
         $name = 'theme_boost_union/showhintcourseguestaccess';
         $title = get_string('showhintcoursguestaccesssetting', 'theme_boost_union', null, true);
diff --git a/templates/course-hint-hidden-forum-notifications.mustache b/templates/course-hint-hidden-forum-notifications.mustache
@@ -0,0 +1,44 @@
+{{!
+    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/>.
+}}
+{{!
+    @template theme_boost_union/course-hint-hidden-forum-notifications
+
+    Boost Union template for outputting the hidden course hint on forum pages.
+
+    Context variables required for this template:
+    * courseid - The course ID
+    * showhintforumnotifications - The info text shown at forum pages inside hidden courses
+    * showcoursesettingslink - The fact if a link to the course settings should be shown or not
+
+    Example context (json):
+    {
+        "courseid": "123",
+        "showcoursesettingslink": true,
+        "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."
+    }
+}}
+<div class="course-hint-hidden alert alert-warning">
+    <div class="media">
+        <div class="mr-3 icon-size-5"><i class="fa fa-exclamation-circle fa-3x"></i></div>
+        <div class="media-body align-self-center">
+            {{#str}} showhintforumnotifications, theme_boost_union {{/str}}
+            {{#showcoursesettingslink}}
+                <br />{{#str}} showhintcoursehiddensettingslink, theme_boost_union, { "url": "{{config.wwwroot}}/course/edit.php?id={{courseid}}" } {{/str}}
+            {{/showcoursesettingslink}}
+        </div>
+    </div>
+</div>
diff --git a/templates/course-hint-hidden.mustache b/templates/course-hint-hidden.mustache
@@ -21,11 +21,13 @@
 
     Context variables required for this template:
     * courseid - The course ID
+    * showhintcoursehiddengeneral - The info text shown on hidden courses below the course title,
     * showcoursesettingslink - The fact if a link to the course settings should be shown or not
 
     Example context (json):
     {
         "courseid": "123",
+        "showhintcoursehiddengeneral: "This course is currently <strong>hidden</strong>. Only enrolled teachers can access this course when hidden.",
         "showcoursesettingslink": true
     }
 }}
diff --git a/tests/behat/theme_boost_union_functionalitysettings_courses.feature b/tests/behat/theme_boost_union_functionalitysettings_courses.feature
@@ -16,10 +16,15 @@ 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:
-      | config                   | value | plugin             |
+      | config                   | value | plugin            |
       | showswitchedroleincourse | yes   | theme_boost_union |
     When I log in as "teacher1"
     And I am on "Course 1" course homepage
@@ -32,7 +37,7 @@ Feature: Configuring the theme_boost_union plugin for the "Courses" tab on the "
 
   Scenario: Setting: Show hint in hidden courses - Enable the setting
     Given the following config values are set as admin:
-      | config               | value | plugin             |
+      | config               | value | plugin            |
       | showhintcoursehidden | yes   | theme_boost_union |
     When I log in as "teacher1"
     And I am on "Course 1" course homepage
@@ -49,9 +54,30 @@ Feature: Configuring the theme_boost_union plugin for the "Courses" tab on the "
     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:
+      | 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 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"
+    When I am on "Course 1" course homepage
+    When 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."
+    And ".course-hint-hidden" "css_element" should not exist
+
   Scenario: Setting: Show hint guest for access - Enable the setting
     Given the following config values are set as admin:
-      | config                    | value | plugin             |
+      | config                    | value | plugin            |
       | showhintcourseguestaccess | yes   | theme_boost_union |
     And the following "users" exist:
       | username |
@@ -93,7 +119,7 @@ Feature: Configuring the theme_boost_union plugin for the "Courses" tab on the "
 
   Scenario: Setting: Show hint for self enrolment without enrolment key - Enable the setting
     Given the following config values are set as admin:
-      | config                  | value | plugin             |
+      | config                  | value | plugin            |
       | showhintcourseselfenrol | yes   | theme_boost_union |
     When I log in as "teacher1"
     And I am on "Course 1" course homepage
@@ -112,7 +138,7 @@ Feature: Configuring the theme_boost_union plugin for the "Courses" tab on the "
 
   Scenario: Setting: Show hint for self enrolment without enrolment key - Enable the setting and check that the call for action is shown
     Given the following config values are set as admin:
-      | config                  | value | plugin             |
+      | config                  | value | plugin            |
       | showhintcourseselfenrol | yes   | theme_boost_union |
     And the following "users" exist:
       | username |
@@ -146,7 +172,7 @@ Feature: Configuring the theme_boost_union plugin for the "Courses" tab on the "
 
   Scenario: Setting: Show hint for self enrolment without an enrolment key - Enable the setting and check that it is hidden when new enrolments are disabled
     Given the following config values are set as admin:
-      | config                  | value | plugin             |
+      | config                  | value | plugin            |
       | showhintcourseselfenrol | yes   | theme_boost_union |
     When I log in as "teacher1"
     And I am on "Course 1" course homepage
@@ -167,7 +193,7 @@ Feature: Configuring the theme_boost_union plugin for the "Courses" tab on the "
 
   Scenario: Setting: Show hint for self enrolment without an enrolment key - Enable the setting and check that it is hidden when a password is set
     Given the following config values are set as admin:
-      | config                  | value | plugin             |
+      | config                  | value | plugin            |
       | showhintcourseselfenrol | yes   | theme_boost_union |
     When I log in as "teacher1"
     And I am on "Course 1" course homepage
@@ -188,7 +214,7 @@ Feature: Configuring the theme_boost_union plugin for the "Courses" tab on the "
 
   Scenario: Setting: Show hint for self enrolment without an enrolment key - Enable the setting and check the hints depending on the configured start and / or end dates
     Given the following config values are set as admin:
-      | config                  | value | plugin             |
+      | config                  | value | plugin            |
       | showhintcourseselfenrol | yes   | theme_boost_union |
     When I log in as "teacher1"
     And I am on "Course 1" course homepage
diff --git a/version.php b/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];

Original file line number	Diff line number	Diff line change
`@@ -21,11 +21,13 @@`
`21`	`21`
`22`	`22`	`Context variables required for this template:`
`23`	`23`	`* courseid - The course ID`
	`24`	`+ * showhintcoursehiddengeneral - The info text shown on hidden courses below the course title,`
`24`	`25`	`* showcoursesettingslink - The fact if a link to the course settings should be shown or not`
`25`	`26`
`26`	`27`	`Example context (json):`
`27`	`28`	`{`
`28`	`29`	`"courseid": "123",`
	`30`	`+ "showhintcoursehiddengeneral: "This course is currently <strong>hidden</strong>. Only enrolled teachers can access this course when hidden.",`
`29`	`31`	`"showcoursesettingslink": true`
`30`	`32`	`}`
`31`	`33`	`}}`