Bitrix API

Application implements RestConvertible uses ContextCustomer

Table of Contents

Interfaces

RestConvertible

Methods

__construct()  : mixed
getApplications()  : array<string|int, Entity>
getContext()  : Context
Returns the local or global context for the action.
getLoadUri()  : string
getRestEntityName()  : string
Returns the name of the entity that will be used in the rest response
setContext()  : self
Sets new context for operations.
setContextUser()  : self
setOrder()  : Result
toRestFormat()  : array<string|int, mixed>|null
Returns an array in JSON like format to return the entity as a rest response.
withContext()  : static
Provides local context for the action.
withContextUser()  : static
Provides local context for the action.

Methods

__construct()

public __construct([int|null $userId = null ]) : mixed
Parameters
$userId : int|null = null

getLoadUri()

public getLoadUri() : string
Return values
string

getRestEntityName()

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

public static getRestEntityName() : string
Return values
string

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

setOrder()

public setOrder(int $applicationsId, int $order) : Result
Parameters
$applicationsId : int
$order : int
Return values
Result

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

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