Internal: Add session replication, reinscription logic, and child session hierarchy for course expiration - refs BT#22057

public/main/inc/ajax/model.ajax.php

@@ -677,7 +677,7 @@ function getWhereClause($col, $oper, $val)
         $count = ExerciseLib::get_count_exam_results(
             $exerciseId,
             $whereCondition,
-            '',
+            $courseId,
             false,
             true,
             $status
@@ -839,6 +839,7 @@ function getWhereClause($col, $oper, $val)
                     ['where' => $whereCondition, 'extra' => $extra_fields]
                 );
                 break;
+            case 'replication':
             case 'custom':
             case 'simple':
                 $count = SessionManager::getSessionsForAdmin(
@@ -1981,7 +1982,7 @@ function getWhereClause($col, $oper, $val)
                 break;
             case 'custom':
             case 'simple':
-            case 'all':
+            case 'replication':
                 $result = SessionManager::getSessionsForAdmin(
                     api_get_user_id(),
                     [
@@ -2000,6 +2001,7 @@ function getWhereClause($col, $oper, $val)
                 break;
             case 'active':
             case 'close':
+            case 'all':
                 $result = SessionManager::formatSessionsAdminForGrid(
                     [
                         'where' => $whereCondition,

public/main/inc/lib/sessionmanager.lib.php

@@ -159,7 +159,12 @@ public static function create_session(
         $sendSubscriptionNotification = false,
         $accessUrlId = 0,
         $status = 0,
-        $notifyBoss = false
+        $notifyBoss = false,
+        $parentId = null,
+        $daysBeforeFinishingForReinscription = null,
+        $lastRepetition = false,
+        $daysBeforeFinishingToCreateNewRepetition = null,
+        $validityInDays = null
     ) {
         global $_configuration;
 
@@ -188,42 +193,30 @@ public static function create_session(
         $endDate = Database::escape_string($endDate);
 
         if (empty($name)) {
-            $msg = get_lang('A title is required for the session');
-
-            return $msg;
+            return get_lang('A title is required for the session');
         } elseif (!empty($startDate) && !api_is_valid_date($startDate, 'Y-m-d H:i') &&
             !api_is_valid_date($startDate, 'Y-m-d H:i:s')
         ) {
-            $msg = get_lang('Invalid start date was given.');
-
-            return $msg;
+            return get_lang('Invalid start date was given.');
         } elseif (!empty($endDate) && !api_is_valid_date($endDate, 'Y-m-d H:i') &&
             !api_is_valid_date($endDate, 'Y-m-d H:i:s')
         ) {
-            $msg = get_lang('Invalid end date was given.');
-
-            return $msg;
+            return get_lang('Invalid end date was given.');
         } elseif (!empty($startDate) && !empty($endDate) && $startDate >= $endDate) {
-            $msg = get_lang('The first date should be before the end date');
-
-            return $msg;
+            return get_lang('The first date should be before the end date');
         } else {
             $ready_to_create = false;
             if ($fixSessionNameIfExists) {
                 $name = self::generateNextSessionName($name);
                 if ($name) {
                     $ready_to_create = true;
                 } else {
-                    $msg = get_lang('Session title already exists');
-
-                    return $msg;
+                    return get_lang('Session title already exists');
                 }
             } else {
                 $rs = Database::query("SELECT 1 FROM $tbl_session WHERE title='".$name."'");
                 if (Database::num_rows($rs)) {
-                    $msg = get_lang('Session title already exists');
-
-                    return $msg;
+                    return get_lang('Session title already exists');
                 }
                 $ready_to_create = true;
             }
@@ -239,7 +232,11 @@ public static function create_session(
                     ->setShowDescription(1 === $showDescription)
                     ->setSendSubscriptionNotification((bool) $sendSubscriptionNotification)
                     ->setNotifyBoss((bool) $notifyBoss)
-                ;
+                    ->setParentId($parentId)
+                    ->setDaysToReinscription((int) $daysBeforeFinishingForReinscription)
+                    ->setLastRepetition($lastRepetition)
+                    ->setDaysToNewRepetition((int) $daysBeforeFinishingToCreateNewRepetition)
+                    ->setValidityInDays((int) $validityInDays);
 
                 foreach ($coachesId as $coachId) {
                     $session->addGeneralCoach(api_get_user_entity($coachId));
@@ -288,18 +285,6 @@ public static function create_session(
                     $extraFields['item_id'] = $session_id;
                     $sessionFieldValue = new ExtraFieldValue('session');
                     $sessionFieldValue->saveFieldValues($extraFields);
-                    /*
-                      Sends a message to the user_id = 1
-
-                      $user_info = api_get_user_info(1);
-                      $complete_name = $user_info['firstname'].' '.$user_info['lastname'];
-                      $subject = api_get_setting('siteName').' - '.get_lang('A new session has been created');
-                      $message = get_lang('A new session has been created')." <br /> ".get_lang('Session name').' : '.$name;
-                      api_mail_html($complete_name, $user_info['email'], $subject, $message);
-                     *
-                     */
-                    // Adding to the correct URL
-                    //UrlManager::add_session_to_url($session_id, $accessUrlId);
 
                     // add event to system log
                     $user_id = api_get_user_id();
@@ -523,6 +508,10 @@ public static function getSessionsForAdmin(
             }
             $select .= ', status';
 
+            if ('replication' === $listType) {
+                $select .= ', parent_id';
+            }
+
             if (isset($options['order'])) {
                 $isMakingOrder = 0 === strpos($options['order'], 'category_name');
             }
@@ -654,6 +643,11 @@ public static function getSessionsForAdmin(
                     )
                 )";
                 break;
+            case 'replication':
+                $formatted = false;
+                $query .= "AND s.days_to_new_repetition IS NOT NULL
+               AND (SELECT COUNT(id) FROM session AS child WHERE child.parent_id = s.id) <= 1";
+                break;
         }
 
         $query .= $order;
@@ -668,6 +662,23 @@ public static function getSessionsForAdmin(
                     $session['users'] = Database::fetch_assoc($result)['nbr'];
                 }
             }
+
+            if ('replication' === $listType) {
+                $formattedSessions = [];
+                foreach ($sessions as $session) {
+                    $formattedSessions[] = $session;
+                    if (isset($session['id'])) {
+                        $childSessions = array_filter($sessions, fn($s) => isset($s['parent_id']) && $s['parent_id'] === $session['id']);
+                        foreach ($childSessions as $childSession) {
+                            $childSession['title'] = '-- ' . $childSession['title'];
+                            $formattedSessions[] = $childSession;
+                        }
+                    }
+                }
+
+                return $formattedSessions;
+            }
+
             if ('all' === $listType) {
                 if ($getCount) {
                     return $sessions[0]['total_rows'];
@@ -1793,7 +1804,12 @@ public static function edit_session(
         $sessionAdminId = 0,
         $sendSubscriptionNotification = false,
         $status = 0,
-        $notifyBoss = 0
+        $notifyBoss = 0,
+        $parentId = 0,
+        $daysBeforeFinishingForReinscription = null,
+        $daysBeforeFinishingToCreateNewRepetition = null,
+        $lastRepetition = false,
+        $validityInDays = null
     ) {
         $id = (int) $id;
         $status = (int) $status;
@@ -1863,6 +1879,11 @@ public static function edit_session(
                     ->setVisibility($visibility)
                     ->setSendSubscriptionNotification((bool) $sendSubscriptionNotification)
                     ->setNotifyBoss((bool) $notifyBoss)
+                    ->setParentId($parentId)
+                    ->setDaysToReinscription((int) $daysBeforeFinishingForReinscription)
+                    ->setLastRepetition($lastRepetition)
+                    ->setDaysToNewRepetition((int) $daysBeforeFinishingToCreateNewRepetition)
+                    ->setValidityInDays((int) $validityInDays)
                     ->setAccessStartDate(null)
                     ->setAccessStartDate(null)
                     ->setDisplayStartDate(null)
@@ -1871,6 +1892,16 @@ public static function edit_session(
                     ->setCoachAccessEndDate(null)
                 ;
 
+                if ($parentId) {
+                    $sessionEntity->setParentId($parentId);
+                } else {
+                    $sessionEntity->setParentId(null);
+                }
+
+                $sessionEntity->setDaysToReinscription($daysBeforeFinishingForReinscription);
+                $sessionEntity->setLastRepetition($lastRepetition);
+                $sessionEntity->setDaysToNewRepetition($daysBeforeFinishingToCreateNewRepetition);
+
                 $newGeneralCoaches = array_map(
                     fn($coachId) => api_get_user_entity($coachId),
                     $coachesId
@@ -8271,6 +8302,85 @@ public static function setForm(FormValidator $form, Session $session = null, $fr
         $extra_field = new ExtraFieldModel('session');
         $extra = $extra_field->addElements($form, $session ? $session->getId() : 0, ['image']);
 
+        if ('true' === api_get_setting('session.enable_auto_reinscription')) {
+            $form->addElement(
+                'text',
+                'days_before_finishing_for_reinscription',
+                get_lang('Days before finishing for reinscription'),
+                ['maxlength' => 5]
+            );
+            $form->addRule(
+                'days_before_finishing_for_reinscription',
+                get_lang('Days must be a positive number or empty'),
+                'regex',
+                '/^\d*$/'
+            );
+        }
+
+        if ('true' === api_get_setting('session.enable_session_replication')) {
+            $form->addElement(
+                'text',
+                'days_before_finishing_to_create_new_repetition',
+                get_lang('Days before finishing to create new repetition'),
+                ['maxlength' => 5]
+            );
+            $form->addRule(
+                'days_before_finishing_to_create_new_repetition',
+                get_lang('Days must be a positive number or empty'),
+                'regex',
+                '/^\d*$/'
+            );
+        }
+
+        if ('true' === api_get_setting('session.enable_auto_reinscription') || 'true' === api_get_setting('session.enable_session_replication')) {
+            $form->addElement(
+                'checkbox',
+                'last_repetition',
+                get_lang('Last repetition')
+            );
+
+            $form->addElement(
+                'number',
+                'validity_in_days',
+                get_lang('Validity in days'),
+                [
+                    'min' => 0,
+                    'max' => 365,
+                    'step' => 1,
+                    'placeholder' => get_lang('Enter the number of days'),
+                ]
+            );
+
+            $form->addRule(
+                'validity_in_days',
+                get_lang('The field must be a positive number'),
+                'numeric',
+                null,
+                'client'
+            );
+        }
+
+        /** @var HTML_QuickForm_select $element */
+        $element = $form->createElement(
+            'select',
+            'parent_id',
+            get_lang('Parent session'),
+            [],
+            ['class' => 'form-control']
+        );
+
+        $element->addOption(get_lang('None'), 0, []);
+        $sessions = SessionManager::getListOfParentSessions();
+        $currentSessionId = $session?->getId();
+        foreach ($sessions as $id => $title) {
+            if ($id !== $currentSessionId) {
+                $attributes = [];
+                $element->addOption($title, $id, $attributes);
+            }
+        }
+
+        $form->addElement($element);
+
         $form->addElement('html', '</div>');
 
         $js = $extra['jquery_ready_content'];
@@ -8791,7 +8901,7 @@ public static function getGridColumns(
                 ];
 
                 break;
-
+            case 'replication':
             case 'custom':
                 $columns = [
                     '#',
@@ -8810,6 +8920,7 @@ public static function getGridColumns(
                     [
                         'name' => 'title',
                         'index' => 's.title',
+                        'width' => '260px',
                         'width' => '300',
                         'align' => 'left',
                         'search' => 'true',
@@ -9805,9 +9916,9 @@ public static function getDefaultSessionTab()
     }
 
     /**
-     * @return array
+     * @return string
      */
-    public static function getSessionListTabs($listType)
+    public static function getSessionListTabs($listType): string
     {
         $tabs = [
             [
@@ -9826,10 +9937,10 @@ public static function getSessionListTabs($listType)
                 'content' => get_lang('Custom list'),
                 'url' => api_get_path(WEB_CODE_PATH).'session/session_list.php?list_type=custom',
             ],
-            /*[
-                'content' => get_lang('Complete'),
-                'url' => api_get_path(WEB_CODE_PATH).'session/session_list_simple.php?list_type=complete',
-            ],*/
+            [
+                'content' => get_lang('Replication'),
+                'url' => api_get_path(WEB_CODE_PATH).'session/session_list.php?list_type=replication',
+            ],
         ];
         $default = null;
         switch ($listType) {
@@ -9845,6 +9956,9 @@ public static function getSessionListTabs($listType)
             case 'custom':
                 $default = 4;
                 break;
+            case 'replication':
+                $default = 5;
+                break;
         }
 
         return Display::tabsOnlyLink($tabs, $default);
@@ -10227,6 +10341,24 @@ public static function getAllUserIdsInSession(int $sessionId): array
         return $users;
     }
 
+    /**
+     * Retrieves a list of parent sessions.
+     */
+    public static function getListOfParentSessions(): array
+    {
+        $sessions = [];
+        $tbl_session = Database::get_main_table(TABLE_MAIN_SESSION);
+        $sql = "SELECT id, title FROM $tbl_session WHERE parent_id IS NULL ORDER BY title";
+        $result = Database::query($sql);
+
+        while ($row = Database::fetch_array($result)) {
+            $sessions[$row['id']] = $row['title'];
+        }
+
+        return $sessions;
+    }
+
+
     /**
      * Method to export sessions data as CSV
      */
@@ -10413,5 +10545,4 @@ private static function generateSessionCourseReportData($sessionId, $courseId, $
 
         return [$csvHeaders, $csvContent];
     }
-
 }