Webservice: #add a new get_user_progress_and_time_in_session ws - refs BT#22409

Author: NicoDucou

main/inc/lib/webservices/Rest.php

@@ -104,6 +104,7 @@ class Rest extends WebService
     public const GET_USER_API_KEY = 'get_user_api_key';
     public const GET_USER_LAST_CONNEXION = 'get_user_last_connexion';
     public const GET_USER_TOTAL_CONNEXION_TIME = 'get_user_total_connexion_time';
+    public const GET_USER_PROGRESS_AND_TIME_IN_SESSION = 'get_user_progress_and_time_in_session';
     public const GET_USER_SUB_GROUP = 'get_user_sub_group';
 
     public const GET_COURSES = 'get_courses';
@@ -4392,4 +4393,41 @@ private function generateUrl(array $additionalParams = []): string
         return api_get_self().'?'
             .http_build_query(array_merge($queryParams, $additionalParams));
     }
+
+    /**
+     * Returns the progress and time spent by the user in the session
+     * @throws Exception
+     */
+    public function getUserProgressAndTimeInSession(int $userId, int $sessionId): array
+    {
+        $totalProgress = 0;
+        $totalTime = 0;
+        $nbCourses = 0;
+        $courses = SessionManager::getCoursesInSession($sessionId);
+        foreach ($courses as $courseId) {
+            $nbCourses++;
+            $totalTime += Tracking::get_time_spent_on_the_course(
+                $userId,
+                $courseId,
+                $sessionId
+            );
+            $courseInfo = api_get_course_info_by_id($courseId);
+            $totalProgress += Tracking::get_avg_student_progress(
+                $userId,
+                $courseInfo['code'],
+                [],
+                $sessionId
+            );
+        }
+        $userAverageCoursesTime = 0;
+        $userAverageProgress = 0;
+        if ($nbCourses != 0) {
+            $userAverageCoursesTime = $totalTime/$nbCourses;
+            $userAverageProgress = $totalProgress/$nbCourses;
+        }
+        return [
+            'userAverageCoursesTime' => $userAverageCoursesTime,
+            'userAverageProgress' => $userAverageProgress,
+        ];
+    }
 }

main/webservices/api/v2.php

@@ -680,6 +680,25 @@
                 )
             );
             break;
+        case Rest::GET_USER_PROGRESS_AND_TIME_IN_SESSION:
+            $userId = (string) $_REQUEST['user_id'];
+            $sessionId = (string) $_REQUEST['session_id'];
+
+            if (empty($userId)) {
+                throw new Exception('user_id not provided');
+            }
+            if (empty($sessionId)) {
+                throw new Exception('session_id not provided');
+            }
+
+            Event::addEvent(LOG_WS.$action, 'user_id', $userId);
+            $restResponse->setData(
+                $restApi->getUserProgressAndTimeInSession(
+                    $userId,
+                    $sessionId
+                )
+            );
+            break;
         case Rest::GET_USER_SUB_GROUP:
             $userId = isset($_POST['user_id']) ? (int) $_POST['user_id'] : 0;
             if (empty($userId)) {