Exercise: Add exercise_subscribe_session_when_finished_failure conf setting to allow subscribing a user a session when the user has failed - refs BT#22403

Author: AngelFQC

main/exercise/exercise.class.php

@@ -2616,6 +2616,7 @@ public function createForm($form, $type = 'full')
                     'notifications',
                     'remedialcourselist',
                     'advancedcourselist',
+                    'subscribe_session_when_finished_failure',
                 ], //exclude
                 false, // filter
                 false, // tag as select
@@ -2676,6 +2677,25 @@ public function createForm($form, $type = 'full')
                 }
             }
 
+            if (true === api_get_configuration_value('exercise_subscribe_session_when_finished_failure')) {
+                $optionSessionWhenFailure = [];
+
+                if ($failureSession = ExerciseLib::getSessionWhenFinishedFailure($this->iid)) {
+                    $defaults['subscribe_session_when_finished_failure'] = $failureSession->getId();
+                    $optionSessionWhenFailure[$failureSession->getId()] = $failureSession->getName();
+                }
+
+                $form->addSelectAjax(
+                    'extra_subscribe_session_when_finished_failure',
+                    get_lang('SubscribeSessionWhenFinishedFailure'),
+                    $optionSessionWhenFailure,
+                    [
+                        'url' => api_get_path(WEB_AJAX_PATH).'session.ajax.php?'
+                            .http_build_query(['a' => 'search_session']),
+                    ]
+                );
+            }
+
             $settings = api_get_configuration_value('exercise_finished_notification_settings');
             if (!empty($settings)) {
                 $options = [];

main/inc/lib/exercise.lib.php

@@ -3,6 +3,7 @@
 /* For licensing terms, see /license.txt */
 
 use Chamilo\CoreBundle\Component\Utils\ChamiloApi;
+use Chamilo\CoreBundle\Entity\Session as SessionEntity;
 use Chamilo\CoreBundle\Entity\TrackEExercises;
 use Chamilo\CourseBundle\Entity\CQuizQuestion;
 use ChamiloSession as Session;
@@ -5792,6 +5793,13 @@ public static function displayQuestionListByAttempt(
             $total_weight
         );
 
+        if ($save_user_result
+            && !$passed
+            && true === api_get_configuration_value('exercise_subscribe_session_when_finished_failure')
+        ) {
+            self::subscribeSessionWhenFinishedFailure($objExercise->iid);
+        }
+
         $percentage = 0;
         if (!empty($total_weight)) {
             $percentage = ($total_score / $total_weight) * 100;
@@ -5812,6 +5820,40 @@ public static function displayQuestionListByAttempt(
         ];
     }
 
+    public static function getSessionWhenFinishedFailure(int $exerciseId): ?SessionEntity
+    {
+        $objExtraField = new ExtraField('exercise');
+        $objExtraFieldValue = new ExtraFieldValue('exercise');
+
+        $subsSessionWhenFailureField = $objExtraField->get_handler_field_info_by_field_variable(
+            'subscribe_session_when_finished_failure'
+        );
+        $subsSessionWhenFailureValue = $objExtraFieldValue->get_values_by_handler_and_field_id(
+            $exerciseId,
+            $subsSessionWhenFailureField['id']
+        );
+
+        if (!empty($subsSessionWhenFailureValue['value'])) {
+            return api_get_session_entity((int) $subsSessionWhenFailureValue['value']);
+        }
+
+        return null;
+    }
+
+    private static function subscribeSessionWhenFinishedFailure(int $exerciseId): void
+    {
+        $failureSession = self::getSessionWhenFinishedFailure($exerciseId);
+
+        if ($failureSession) {
+            SessionManager::subscribeUsersToSession(
+                $failureSession->getId(),
+                [api_get_user_id()],
+                SESSION_VISIBLE_READ_ONLY,
+                false
+            );
+        }
+    }
+
     /**
      * It validates unique score when all user answers are correct by question.
      * It is used for global questions.

main/install/configuration.dist.php

@@ -2562,6 +2562,12 @@
 // Then add the "@" symbol to the CQuiz class in the ORM\Column() line for its $textWhenFinishedFailure property.
 //$_configuration['exercise_text_when_finished_failure'] = false;
 
+// Add an option to subscribe the user at the end of test when the user has failed. Requires DB changes.
+/*
+INSERT INTO extra_field (extra_field_type, field_type, variable, display_text, default_value, field_order, visible_to_self, visible_to_others, changeable, filter, created_at) VALUES (17, 5, 'subscribe_session_when_finished_failure', 'SubscribeSessionWhenFinishedFailure', '', 0, 1, 0, 1, 0, NOW());
+*/
+//$_configuration['exercise_subscribe_session_when_finished_failure'] = false;
+
 //hide copy icon in LP's authoring options
 //$_configuration['lp_hide_copy_option'] = false;