Bitrix API

SessionCollection extends Collection implements RestConvertible, PopupDataAggregatable uses ContextCustomer

Tags
extends

Table of Contents

Interfaces

RestConvertible
PopupDataAggregatable
An interface for classes that have entities within them that should be taken to the top level of a REST response.

Methods

__construct()  : mixed
add()  : static
Append collection with new item.
delete()  : Result
Delete from the database all entities that are in the registry and have an id
filter()  : $this
find()  : static
getAny()  : T|null
getCollectionElementClass()  : string|ActiveRecord
Returns collection item's class name.
getContext()  : Context
Returns the local or global context for the action.
getDataClass()  : string|DataManager
Returns ORM tablet class name.
getDataEntityCollection()  : Collection
Before external call, call prepare method to update the state of the entity @see BaseLinkCollection::prepareFields()
getIds()  : array<string|int, mixed>
getOperatorsIds()  : 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.
getPrimaryIds()  : array<string|int, int>
getRestEntityName()  : string
Returns the name of the entity that will be used in the rest response
hasUnsaved()  : bool
load()  : Result
Restores object state from database.
merge()  : static
offsetSet()  : void
Alias to add method.
save()  : Result
Saves collection objects states into database.
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([mixed $source = null ]) : mixed
Parameters
$source : mixed = null

add()

Append collection with new item.

public add(ActiveRecord $entry) : static
Parameters
$entry : ActiveRecord
Tags
throws
ArgumentTypeException
Return values
static

delete()

Delete from the database all entities that are in the registry and have an id

public delete() : Result
Return values
Result

filter()

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

find()

public static find(array<string|int, mixed> $filter, array<string|int, mixed> $order[, int|null $limit = null ][, Context|null $context = null ][, array<string|int, mixed> $select = [] ]) : static
Parameters
$filter : array<string|int, mixed>
$order : array<string|int, mixed>
$limit : int|null = null
$context : Context|null = null
$select : array<string|int, mixed> = []
Return values
static

getAny()

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

getDataEntityCollection()

Before external call, call prepare method to update the state of the entity @see BaseLinkCollection::prepareFields()

public getDataEntityCollection() : Collection
Return values
Collection

getIds()

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

getOperatorsIds()

public getOperatorsIds() : 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

getPrimaryIds()

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

getRestEntityName()

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

public static getRestEntityName() : string
Return values
string

hasUnsaved()

public hasUnsaved() : bool
Return values
bool

load()

Restores object state from database.

public load(array<string|int, int>|array<string|int, mixed>|Collection $source) : Result
Parameters
$source : array<string|int, int>|array<string|int, mixed>|Collection
Return values
Result

merge()

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

offsetSet()

Alias to add method.

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

save()

Saves collection objects states into database.

public save([bool $isGroupSave = false ]) : Result
Parameters
$isGroupSave : bool = false
Return values
Result

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