Nextcloud PHP API (master)

ISearchableGroupBackend

Tags
since
27.0.0

Table of Contents

Methods

searchInGroup()  : array<string, IUser>

Methods

searchInGroup()

public searchInGroup(string $gid[, string $search = '' ][, int $limit = -1 ][, int $offset = 0 ]) : array<string, IUser>
Parameters
$gid : string

The group id of the user we want to search

$search : string = ''

The part of the display name or user id of the users we want to search. This can be empty to get all the users.

$limit : int = -1

The limit of results

$offset : int = 0

The offset of the results

Tags
brief

Get a list of users matching the given search parameters.

Implementations of this method should return lazy evaluated user objects and preload if possible the display name.

$users = $groupBackend->searchInGroup('admin', 'John', 10, 0);
since
27.0.0
Return values
array<string, IUser>

Users indexed by uid


        
On this page

Search results