Webservice: Add support service to get social groups/classes of a given user - refs BT#20460

Author: ywarnier

main/inc/lib/webservices/Rest.php

@@ -101,6 +101,7 @@ class Rest extends WebService
     public const DELETE_USER = 'delete_user';
     public const GET_USERS_API_KEYS = 'get_users_api_keys';
     public const GET_USER_API_KEY = 'get_user_api_key';
+    public const GET_USER_SUB_GROUP = 'get_user_sub_group';
 
     public const GET_COURSES = 'get_courses';
     public const GET_COURSES_FROM_EXTRA_FIELD = 'get_courses_from_extra_field';
@@ -4076,6 +4077,8 @@ public function getGroupSubscribedSessions(int $groupId): array
     /**
      * Add a new user to the given group/class.
      *
+     * @param int $groupId
+     * @param int $userId
      * @param int $relationType (1:admin, 2:reader, etc. See GROUP_USER_PERMISSION_ constants in api.lib.php)
      *
      * @return array One item array containing true on success, false otherwise
@@ -4087,6 +4090,21 @@ public function addGroupSubscribedUser(int $groupId, int $userId, int $relationT
         return [$userGroup->add_user_to_group($userId, $groupId, $relationType)];
     }
 
+    /**
+     * Get the list of group/class IDs to which the user belongs.
+     *
+     * @param int $userId
+     *
+     * @return array Array containing the group IDs like ['groups' => [1, 2, 3]]
+     */
+    public function getUserSubGroup(int $userId): array
+    {
+        $userGroup = new UserGroup();
+
+        $res = $userGroup->get_usergroup_by_user($userId);
+        return ['groups' => $res];
+    }
+
     /**
      * Add a new course to which the given group/class is subscribed.
      *

main/webservices/api/v2.php

@@ -627,6 +627,16 @@
                 )
             );
             break;
+        case Rest::GET_USER_SUB_GROUP:
+            $userId = isset($_POST['user_id']) ? (int) $_POST['user_id'] : 0;
+            if (empty($userId)) {
+                throw new Exception('user_id not provided');
+            }
+
+            Event::addEvent(LOG_WS.$action, 'user_id', $userId);
+            $data = $restApi->getUserSubGroup($userId);
+            $restResponse->setData($data);
+            break;
         case Rest::GET_COURSES:
             $campusId = api_get_current_access_url_id();
             if (!empty($_POST['id_campus'])) {