Bitrix API

Preset implements RestConvertible

Table of Contents

Interfaces

RestConvertible

Constants

BIND_GENERAL  = 'toGeneral'
BIND_NOTIFY  = 'toNotify'

Properties

$general  : General|null
$notify  : Notify|null

Methods

bindToUser()  : Result
getDefaultPreset()  : Preset
getId()  : int|null
getInstance()  : Preset
getName()  : string|null
getPersonal()  : Preset
getPersonalUserId()  : int|null
getRestEntityName()  : string
Returns the name of the entity that will be used in the rest response
getSort()  : int|null
initPersonal()  : Preset
isExist()  : bool
isPersonal()  : bool
load()  : Result
toRestFormat()  : array<string|int, mixed>|null
Returns an array in JSON like format to return the entity as a rest response.

Constants

BIND_GENERAL

public mixed BIND_GENERAL = 'toGeneral'

BIND_NOTIFY

public mixed BIND_NOTIFY = 'toNotify'

Properties

Methods

bindToUser()

public bindToUser(int $userId, array<string|int, mixed> $bindingConfiguration) : Result
Parameters
$userId : int
$bindingConfiguration : array<string|int, mixed>
Tags
throws
Exception
Return values
Result

getId()

public getId() : int|null
Return values
int|null

getInstance()

public static getInstance([int|null $id = null ]) : Preset
Parameters
$id : int|null = null
Return values
Preset

getName()

public getName() : string|null
Return values
string|null

getPersonal()

public static getPersonal(int $userId) : Preset
Parameters
$userId : int
Return values
Preset

getPersonalUserId()

public getPersonalUserId() : int|null
Return values
int|null

getRestEntityName()

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

public static getRestEntityName() : string
Return values
string

getSort()

public getSort() : int|null
Return values
int|null

initPersonal()

public initPersonal(int $userId) : Preset
Parameters
$userId : int
Return values
Preset

isExist()

public isExist() : bool
Return values
bool

isPersonal()

public isPersonal(int $userId) : bool
Parameters
$userId : int
Return values
bool

load()

public load(int $presetId) : Result
Parameters
$presetId : 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 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results