Clear up return types

usersInGroup index by int for BC, searchInGroup index by uid (string).

Signed-off-by: Côme Chilliet <come.chilliet@nextcloud.com>

Author: come-nc

apps/user_ldap/lib/Access.php

@@ -631,7 +631,7 @@ public function mapAndAnnounceIfApplicable(
 	 * gives back the user names as they are used ownClod internally
 	 *
 	 * @param array $ldapUsers as returned by fetchList()
-	 * @return array an array with the user names to use in Nextcloud
+	 * @return array<int,string> an array with the user names to use in Nextcloud
 	 *
 	 * gives back the user names as they are used ownClod internally
 	 * @throws \Exception
@@ -644,7 +644,7 @@ public function nextcloudUserNames($ldapUsers) {
 	 * gives back the group names as they are used ownClod internally
 	 *
 	 * @param array $ldapGroups as returned by fetchList()
-	 * @return array an array with the group names to use in Nextcloud
+	 * @return array<int,string> an array with the group names to use in Nextcloud
 	 *
 	 * gives back the group names as they are used ownClod internally
 	 * @throws \Exception
@@ -655,6 +655,7 @@ public function nextcloudGroupNames($ldapGroups) {
 
 	/**
 	 * @param array[] $ldapObjects as returned by fetchList()
+	 * @return array<int,string>
 	 * @throws \Exception
 	 */
 	private function ldap2NextcloudNames(array $ldapObjects, bool $isUsers): array {

apps/user_ldap/lib/Group_LDAP.php

@@ -466,7 +466,7 @@ private function prepareFilterForUsersHasGidNumber(string $groupDN, string $sear
 	}
 
 	/**
-	 * @return array A list of users that have the given group as gid number
+	 * @return array<int,string> A list of users that have the given group as gid number
 	 * @throws ServerNotAvailableException
 	 */
 	public function getUsersInGidNumber(
@@ -591,6 +591,7 @@ private function prepareFilterForUsersInPrimaryGroup(string $groupDN, string $se
 
 	/**
 	 * @throws ServerNotAvailableException
+	 * @return array<int,string>
 	 */
 	public function getUsersInPrimaryGroup(
 		string $groupDN,
@@ -840,7 +841,7 @@ private function getGroupsByMember(string $dn, array &$seen = []): array {
 	 * @param string $search
 	 * @param int $limit
 	 * @param int $offset
-	 * @return array with user ids
+	 * @return array<int,string> user ids
 	 * @throws Exception
 	 * @throws ServerNotAvailableException
 	 */
@@ -909,7 +910,11 @@ public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0) {
 					if (empty($ldap_users)) {
 						break;
 					}
-					$groupUsers[] = $this->access->dn2username($ldap_users[0]['dn'][0]);
+					$uid = $this->access->dn2username($ldap_users[0]['dn'][0]);
+					if (!$uid) {
+						break;
+					}
+					$groupUsers[] = $uid;
 					break;
 				default:
 					//we got DNs, check if we need to filter by search or we can give back all of them

apps/user_ldap/lib/Group_Proxy.php

@@ -171,7 +171,7 @@ public function getUserGroups($uid) {
 	/**
 	 * get a list of all users in a group
 	 *
-	 * @return string[] with user ids
+	 * @return array<int,string> user ids
 	 */
 	public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0) {
 		$this->setup();

lib/private/Group/Backend.php

@@ -126,7 +126,7 @@ public function groupExists($gid) {
 	 * @param string $search
 	 * @param int $limit
 	 * @param int $offset
-	 * @return array an array of user ids
+	 * @return array<int,string> an array of user ids
 	 */
 	public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0) {
 		return [];

lib/private/Group/Database.php

@@ -333,10 +333,10 @@ public function groupExists($gid) {
 	 * @param string $search
 	 * @param int $limit
 	 * @param int $offset
-	 * @return array<string> an array of user ids
+	 * @return array<int,string> an array of user ids
 	 */
 	public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0): array {
-		return array_map(fn ($user) => $user->getUid(), $this->searchInGroup($gid, $search, $limit, $offset));
+		return array_values(array_map(fn ($user) => $user->getUid(), $this->searchInGroup($gid, $search, $limit, $offset)));
 	}
 
 	public function searchInGroup(string $gid, string $search = '', int $limit = -1, int $offset = 0): array {

lib/private/Group/Group.php

@@ -251,7 +251,7 @@ public function searchUsers(string $search, ?int $limit = null, ?int $offset = n
 		$users = [];
 		foreach ($this->backends as $backend) {
 			if ($backend instanceof ISearchableGroupBackend) {
-				$users = array_merge($users, $backend->searchInGroup($this->gid, $search, $limit ?? -1, $offset ?? 0));
+				$users = array_merge($users, array_values($backend->searchInGroup($this->gid, $search, $limit ?? -1, $offset ?? 0)));
 			} else {
 				$userIds = $backend->usersInGroup($this->gid, $search, $limit ?? -1, $offset ?? 0);
 				$userManager = \OCP\Server::get(IUserManager::class);

lib/public/Group/Backend/ISearchableGroupBackend.php

@@ -29,7 +29,6 @@
  * @since 26.0.0
  */
 interface ISearchableGroupBackend {
-
 	/**
 	 * @brief Get a list of users matching the given search parameters.
 	 *
@@ -45,7 +44,7 @@ interface ISearchableGroupBackend {
 	 *                       want to search. This can be empty to get all the users.
 	 * @param int $limit     The limit of results
 	 * @param int $offset    The offset of the results
-	 * @return IUser[]
+	 * @return array<string,IUser> Users indexed by uid
 	 * @since 26.0.0
 	 */
 	public function searchInGroup(string $gid, string $search = '', int $limit = -1, int $offset = 0): array;

lib/public/GroupInterface.php

@@ -112,7 +112,7 @@ public function groupExists($gid);
 	 * @param string $search
 	 * @param int $limit
 	 * @param int $offset
-	 * @return array an array of user ids
+	 * @return array<int,string> an array of user ids
 	 * @since 4.5.0
 	 * @deprecated 26.0.0 Use searchInGroup instead, for performance reasons
 	 */

tests/lib/Group/ManagerTest.php

@@ -737,7 +737,7 @@ public function testDisplayNamesInGroupWithOneUserBackendAndSearchEmpty() {
 		$backend->expects($this->once())
 			->method('searchInGroup')
 			->with('testgroup', '', -1, 0)
-			->willReturn([$this->getTestUser('user2'), $this->getTestUser('user33')]);
+			->willReturn(['user2' => $this->getTestUser('user2'), 'user33' => $this->getTestUser('user33')]);
 
 		$this->userManager->expects($this->never())->method('get');
 
@@ -793,7 +793,7 @@ public function testDisplayNamesInGroupWithOneUserBackendAndSearchEmptyAndLimitA
 		$backend->expects($this->once())
 			->method('searchInGroup')
 			->with('testgroup', '', 1, 1)
-			->willReturn([$this->getTestUser('user33')]);
+			->willReturn(['user33' => $this->getTestUser('user33')]);
 
 		$this->userManager->expects($this->never())->method('get');
 

tests/lib/Util/Group/Dummy.php

@@ -208,7 +208,7 @@ public function searchInGroup(string $gid, string $search = '', int $limit = -1,
 			$result = [];
 			foreach ($this->groups[$gid] as $user) {
 				if (stripos($user, $search) !== false) {
-					$result[] = new DummyUser($user, '');
+					$result[$user] = new DummyUser($user, '');
 				}
 			}
 			return $result;