From ca5bccff169e8fd0172b8efefda5fa4ed3e71e21 Mon Sep 17 00:00:00 2001 From: Josh Date: Wed, 6 May 2026 11:59:22 -0400 Subject: [PATCH 1/3] docs(group): fix and clarity public getGroups contract Signed-off-by: Josh --- lib/public/GroupInterface.php | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/lib/public/GroupInterface.php b/lib/public/GroupInterface.php index cbfd74a068af0..95578462b4eb5 100644 --- a/lib/public/GroupInterface.php +++ b/lib/public/GroupInterface.php @@ -95,15 +95,15 @@ public function inGroup($uid, $gid); public function getUserGroups($uid); /** - * @brief Get a list of all groups + * Get a list of groups matching the search criteria. * - * @param string $search - * @param int $limit - * @param int $offset - * @return array an array of group names - * @since 4.5.0 + * An empty search returns all groups. * - * Returns a list with all groups + * @param string $search Search term used to filter group names + * @param int $limit Maximum number of results to return, or -1 for no limit + * @param int $offset Offset for paginated results + * @return list An array of group names + * @since 4.5.0 */ public function getGroups(string $search = '', int $limit = -1, int $offset = 0); From f9b6fc2958b9691706eaea16085484a3a96f1c60 Mon Sep 17 00:00:00 2001 From: Josh Date: Wed, 6 May 2026 12:01:59 -0400 Subject: [PATCH 2/3] docs(group): remove redundant database getGroups docblock Signed-off-by: Josh --- lib/private/Group/Database.php | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/lib/private/Group/Database.php b/lib/private/Group/Database.php index fff9cef31f7ca..ca5afc46e5db3 100644 --- a/lib/private/Group/Database.php +++ b/lib/private/Group/Database.php @@ -240,13 +240,7 @@ public function getUserGroups($uid) { } /** - * get a list of all groups - * @param string $search - * @param int $limit - * @param int $offset - * @return array an array of group names - * - * Returns a list with all groups + * Search for groups by gid or display name. */ #[\Override] public function getGroups(string $search = '', int $limit = -1, int $offset = 0) { From 0c096fd71a11f1dd3cfac221e1e65190ab7d9b6a Mon Sep 17 00:00:00 2001 From: Josh Date: Wed, 6 May 2026 12:05:21 -0400 Subject: [PATCH 3/3] docs(ldap): trim backend-specific group listing docblock No need to repeat public API bits Signed-off-by: Josh --- apps/user_ldap/lib/Group_LDAP.php | 13 ++++--------- 1 file changed, 4 insertions(+), 9 deletions(-) diff --git a/apps/user_ldap/lib/Group_LDAP.php b/apps/user_ldap/lib/Group_LDAP.php index 3ca3089030680..86be8737445d7 100644 --- a/apps/user_ldap/lib/Group_LDAP.php +++ b/apps/user_ldap/lib/Group_LDAP.php @@ -1072,18 +1072,13 @@ public function countUsersInGroup($gid, $search = '') { } /** - * get a list of all groups using a paged search + * Get groups via LDAP search. * - * @param string $search - * @param int $limit - * @param int $offset - * @return array with group names + * Uses a paged search when available to override server-side search limits. + * Active Directory has a default limit of 1000 results. * - * Returns a list with all groups - * Uses a paged search if available to override a - * server side search limit. - * (active directory has a limit of 1000 by default) * @throws Exception + * @throws ServerNotAvailableException */ #[\Override] public function getGroups($search = '', $limit = -1, $offset = 0) {