Bitrix API

UserCollection extends EntityCollection

Tags
implements

Table of Contents

Methods

__construct()  : mixed
fillOnlineData()  : void
filter()  : $this
filterExtranet()  : self
filterOnlineUserId()  : array<string|int, mixed>
getAny()  : T|null
getById()  : User
getContext()  : Context
Returns the local or global context for the action.
getIds()  : array<string|int, mixed>
getPopupData()  : PopupData
Returns the data to be raised to the top of the REST response. Works on the principle of the composite pattern.
getRestEntityName()  : string
Returns the name of the entity that will be used in the rest response
getUnique()  : static
initByArray()  : static
merge()  : static
offsetGet()  : User
offsetSet()  : void
Collect only existing users
setContext()  : self
Sets new context for operations.
setContextUser()  : self
toRestFormat()  : array<string|int, mixed>|null
Returns an array in JSON like format to return the entity as a rest response.
unsetByKeys()  : void
withContext()  : static
Provides local context for the action.
withContextUser()  : static
Provides local context for the action.

Methods

__construct()

public __construct([array<string|int, mixed> $usersIds = [] ]) : mixed
Parameters
$usersIds : array<string|int, mixed> = []

fillOnlineData()

public fillOnlineData([bool $withStatus = false ]) : void
Parameters
$withStatus : bool = false

filter()

public filter(callable $predicate) : $this
Parameters
$predicate : callable
Return values
$this

filterExtranet()

public filterExtranet() : self
Return values
self

filterOnlineUserId()

public static filterOnlineUserId(array<string|int, mixed> $userIds) : array<string|int, mixed>
Parameters
$userIds : array<string|int, mixed>
Return values
array<string|int, mixed>

getAny()

public getAny() : T|null
Return values
T|null

getIds()

public getIds() : array<string|int, mixed>
Return values
array<string|int, mixed>

getPopupData()

Returns the data to be raised to the top of the REST response. Works on the principle of the composite pattern.

public getPopupData([array<string|int, mixed> $excludedList = [] ]) : PopupData
Parameters
$excludedList : array<string|int, mixed> = []
Return values
PopupData

getRestEntityName()

Returns the name of the entity that will be used in the rest response

public static getRestEntityName() : string
Return values
string

merge()

public merge(Registry<string|int, T> $registry) : static
Parameters
$registry : Registry<string|int, T>
Return values
static

offsetSet()

Collect only existing users

public offsetSet(mixed $offset, mixed $value) : void
Parameters
$offset : mixed
$value : mixed

setContext()

Sets new context for operations.

public setContext(Context|null $context) : self
Parameters
$context : Context|null
Return values
self

setContextUser()

public setContextUser(mixed $user) : self
Parameters
$user : mixed
Return values
self

toRestFormat()

Returns an array in JSON like format to return the entity as a rest response.

public toRestFormat([array<string|int, mixed> $option = [] ]) : array<string|int, mixed>|null
Parameters
$option : array<string|int, mixed> = []
Return values
array<string|int, mixed>|null

unsetByKeys()

public unsetByKeys(array<string|int, mixed> $keys) : void
Parameters
$keys : array<string|int, mixed>

withContext()

Provides local context for the action.

public withContext(Context|null $context) : static
Parameters
$context : Context|null
Return values
static

withContextUser()

Provides local context for the action.

public withContextUser(int|User|User $user) : static
Parameters
$user : int|User|User
Return values
static 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results