remove complexity and duplicated code

Author: Menrath

locallib.php

@@ -47,39 +47,35 @@ function theme_boost_union_get_course_related_hints() {
             && $PAGE->has_set_url()
             && $COURSE->visible == false) {
 
-        // The hint will only be shown when the course is viewed.
+        // Initialize hint text.
+        $hintcoursehiddentext = '';
+
+        // The general 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;
-            }
-
-            // Render template and add it to HTML code.
-            $html .= $OUTPUT->render_from_template('theme_boost_union/course-hint-hidden', $templatecontext);
+            $hintcoursehiddentext = get_string('showhintcoursehiddengeneral', 'theme_boost_union');
         }
 
         // 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];
+            $hintcoursehiddentext = get_string('showhintforumnotifications', 'theme_boost_union');
+        }
 
-            // 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 we show any kind of hint for the hidden course, construct the hint html item via mustache.
+        if ($hintcoursehiddentext) {
+            // Prepare the templates context.
+            $templatecontext = [
+                'courseid' => $COURSE->id,
+                'hintcoursehiddentext' => $hintcoursehiddentext,
+                // If the user has the capability to change the course settings, an additional link to the course settings is shown.
+                'showcoursesettingslink' => has_capability('moodle/course:update', context_course::instance($COURSE->id)),
+            ];
 
             // Render template and add it to HTML code.
-            $html .= $OUTPUT->render_from_template('theme_boost_union/course-hint-hidden-forum-notifications', $templatecontext);
+            $html .= $OUTPUT->render_from_template('theme_boost_union/course-hint-hidden', $templatecontext);
         }
     }
 

templates/course-hint-hidden-forum-notifications.mustache

@@ -21,7 +21,7 @@
 
     Context variables required for this template:
     * courseid - The course ID
-    * showhintcoursehiddengeneral - The info text shown on hidden courses below the course title,
+    * hintcoursehiddentext - The info text shown on hidden courses,
     * showcoursesettingslink - The fact if a link to the course settings should be shown or not
 
     Example context (json):
@@ -35,7 +35,7 @@
     <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}} showhintcoursehiddengeneral, theme_boost_union {{/str}}
+            {{{hintcoursehiddentext}}}
             {{#showcoursesettingslink}}
                 <br>{{#str}} showhintcoursehiddensettingslink, theme_boost_union, { "url": "{{config.wwwroot}}/course/edit.php?id={{courseid}}" } {{/str}}
             {{/showcoursesettingslink}}