Add setting 'allow_user_course_category_collapsable' see BT#15126

Course list inside a user category can be set to be collapsed or not.

Requires a DB change.

main/auth/courses.php

@@ -56,6 +56,7 @@ $actions = [
     'subscribe_to_session',
     'search_tag',
     'search_session',
+    'set_collapsable',
 ];
 
 $action = CoursesAndSessionsCatalog::is(CATALOG_SESSIONS) ? 'display_sessions' : 'display_courses';
@@ -330,4 +331,29 @@ switch ($action) {
 
         $courseController->sessionListBySearch($limit);
         break;
+    case 'set_collapsable':
+        api_block_anonymous_users();
+
+        if (!api_get_configuration_value('allow_user_course_category_collapsable')) {
+            api_not_allowed(true);
+        }
+
+        $userId = api_get_user_id();
+        $categoryId = isset($_REQUEST['categoryid']) ? (int) $_REQUEST['categoryid'] : 0;
+        $option = isset($_REQUEST['option']) ? (int) $_REQUEST['option'] : 0;
+
+        if (empty($userId) || empty($categoryId)) {
+            api_not_allowed(true);
+        }
+
+        $table = Database::get_main_table(TABLE_USER_COURSE_CATEGORY);
+        $sql = "UPDATE $table 
+                SET collapsed = $option
+                WHERE user_id = $userId AND id = $categoryId";
+        Database::query($sql);
+        Display::addFlash(Display::return_message(get_lang('Updated')));
+        $url = api_get_path(WEB_CODE_PATH).'auth/courses.php?action=sortmycourses';
+        header('Location: '.$url);
+        exit;
+        break;
 }

main/auth/courses_list.php

@@ -27,6 +27,8 @@ if (!empty($message)) {
     echo Display::return_message($message, 'confirm', false);
 }
 
+$allowCollapsable = api_get_configuration_value('allow_user_course_category_collapsable');
+
 // COURSES WITH CATEGORIES
 if (!empty($user_course_categories)) {
     $counter = 0;
@@ -34,6 +36,7 @@ if (!empty($user_course_categories)) {
     foreach ($user_course_categories as $row) {
         echo Display::page_subheader($row['title']);
         echo '<a name="category'.$row['id'].'"></a>';
+        $url = api_get_path(WEB_CODE_PATH).'auth/courses.php?categoryid='.$row['id'].'&sec_token='.$stok;
         if (isset($_GET['categoryid']) && $_GET['categoryid'] == $row['id']) {
             ?>
         <!-- We display the edit form for the category -->
@@ -46,6 +49,21 @@ if (!empty($user_course_categories)) {
         <?php
         }
         if ($action != 'unsubscribe') {
+
+            if ($allowCollapsable) {
+                if ($row['collapsed'] == 0) {
+                    echo Display::url(
+                        '<i class="fa fa-folder-open"></i>',
+                        $url.'&action=set_collapsable&option=1'
+                    );
+                } else {
+                    echo Display::url(
+                        '<i class="fa fa-folder"></i>',
+                        $url.'&action=set_collapsable&option=0'
+                    );
+                }
+            }
+
             ?>
             <a href="courses.php?action=sortmycourses&amp;categoryid=<?php echo $row['id']; ?>&amp;sec_token=<?php echo $stok; ?>#category<?php echo $row['id']; ?>">
             <?php echo Display::display_icon('edit.png', get_lang('Edit'), '', 22); ?>
@@ -83,6 +101,7 @@ if (!empty($user_course_categories)) {
             </a>
         <?php
         }
+
         $counter++;
         echo '<br /><br />';
         // Show the courses inside this category

main/inc/lib/course.lib.php

@@ -3802,7 +3802,7 @@ class CourseManager
         }
         // Step 1: We get all the categories of the user
         $table = Database::get_main_table(TABLE_USER_COURSE_CATEGORY);
-        $sql = "SELECT id, title FROM $table
+        $sql = "SELECT * FROM $table
                 WHERE user_id = '".$user_id."'
                 ORDER BY sort ASC";
 
@@ -3811,6 +3811,7 @@ class CourseManager
             'in_category' => [],
             'not_category' => [],
         ];
+        $collapsable = api_get_configuration_value('allow_user_course_category_collapsable');
         while ($row = Database::fetch_array($result)) {
             // We simply display the title of the category.
             $courseInCategory = self::returnCoursesCategories(
@@ -3820,9 +3821,14 @@ class CourseManager
                 $useUserLanguageFilterIfAvailable
             );
 
+            $collapsed = 0;
+            if ($collapsable) {
+                $collapsed = isset($row['collapsed']) && $row['collapsed'] ? 1 : 0;
+            }
             $params = [
                 'id_category' => $row['id'],
                 'title_category' => $row['title'],
+                'collapsed' => $collapsed,
                 'courses' => $courseInCategory,
             ];
             $listItems['in_category'][] = $params;

main/install/configuration.dist.php

@@ -1047,6 +1047,10 @@ VALUES (2, 13, 'session_courses_read_only_mode', 'Lock Course In Session', 1, 1,
 // Improve speed when rendering gradebook student reports using Doctrine APCU cache
 // $_configuration['gradebook_use_apcu_cache'] = true;
 
+// Add collapsable option for user course categories
+// ALTER TABLE user_course_category ADD collapsed TINYINT(1) DEFAULT NULL;
+// $_configuration['allow_user_course_category_collapsable'] = true;
+
 // ------ Custom DB changes (keep this at the end)
 // Add user activation by confirmation email
 // This option prevents the new user to login in the platform if your account is not confirmed via email

main/template/default/user_portal/classic_courses_with_category.tpl

@@ -1,12 +1,11 @@
+{% import 'macro/macro.tpl'|get_template as display %}
+
 {% if not categories is empty %}
     <div class="classic-courses">
         {% for category in categories %}
             {% if category.courses %}
-                <div class="panel panel-default">
-                <div id="category-{{ category.id_category }}" class="panel-heading">
-                    {{ category.title_category }}
-                </div>
-                <div class="panel-body">
+                {% set course_content %}
+
                 {% for item in category.courses %}
                     <div class="row">
                         <div class="col-md-2">
@@ -94,8 +93,9 @@
                         </div>
                     </div>
                 {% endfor %}
-                </div>
-            </div>
+                {% endset %}
+
+                {{ display.collapse('course_category_' ~ category.id_category, category.title_category, course_content, false, category.collapsed == 0) }}
             {% endif %}
         {% endfor %}
     </div>