Bitrix API

Session implements RegistryEntry, ActiveRecord, PopupDataItem, RestEntity, PopupDataAggregatable uses FieldAccessImplementation, ActiveRecordImplementation, RegistryEntryImplementation, ContextCustomer

Table of Contents

Interfaces

RegistryEntry
ActiveRecord
PopupDataItem
RestEntity
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
delete()  : Result
fill()  : static
Fills object's fields with provided values.
fillActual()  : self
getCategoryId()  : int|null
getChat()  : Chat|null
getChatId()  : int|null
getConfigId()  : int|null
getContext()  : Context
Returns the local or global context for the action.
getCrmActivityId()  : int|null
getDataClass()  : string
Returns ORM tablet class name.
getDataEntity()  : EntityObject
getDateClose()  : DateTime|null
getDateCloseVote()  : DateTime|null
getDateCreate()  : DateTime|null
getDateFirstAnswer()  : DateTime|null
getDateFirstLastUserAction()  : DateTime|null
getDateLastMessage()  : DateTime|null
getDateModify()  : DateTime|null
getDateOperator()  : DateTime|null
getDateOperatorAnswer()  : DateTime|null
getDateOperatorClose()  : DateTime|null
getEndId()  : int|null
getId()  : int|null
Returns the id of the entity
getInstance()  : self|null
getInstanceByChatId()  : self|null
getLikeCount()  : int|null
getMessageCount()  : int|null
getMode()  : string|null
getOperatorId()  : int|null
getParentId()  : int
getPinMode()  : bool
getPopupData()  : PopupData
Returns the data to be raised to the top of the REST response. Works on the principle of the composite pattern.
getPrimaryId()  : int|null
getRegistry()  : Registry|null
Return link of the object's registry.
getRestEntityName()  : string
Returns the name of the entity that will be used in the rest response
getSendForm()  : string|null
getSessionId()  : int|null
getSource()  : string|null
getStartId()  : int|null
getStatus()  : int|null
getStatusGroup()  : StatusGroup|null
getTimeAnswer()  : int|null
getTimeBot()  : int|null
getTimeClose()  : int|null
getTimeDialog()  : int|null
getTimeFirstAnswer()  : int|null
getUserCode()  : string|null
getUserId()  : int|null
isChanged()  : bool
Tells true if object has been changed.
isClosed()  : bool
isCrm()  : bool
isCrmCreate()  : bool
isCrmCreateCompany()  : bool
isCrmCreateContact()  : bool
isCrmCreateDeal()  : bool
isCrmCreateLead()  : bool
isDeleted()  : bool
Tells true if object marked to drop.
isOperatorFromCrm()  : bool
isPause()  : bool
isSendHistory()  : bool
isSpam()  : bool
isWaitAction()  : bool
isWaitAnswer()  : bool
isWaitVote()  : bool
isWorktime()  : bool
load()  : Result
markChanged()  : static
Marks object changed.
markDrop()  : static
Marks object to drop on save.
merge()  : $this
offsetExists()  : bool
offsetGet()  : mixed
offsetSet()  : void
offsetUnset()  : void
onAfterOrmUpdate()  : self
prepareFields()  : Result
save()  : Result
setCategoryId()  : void
setChat()  : self
setChatId()  : self
setConfigId()  : self
setContext()  : self
Sets new context for operations.
setContextUser()  : self
setCrm()  : void
setCrmActivityId()  : void
setCrmCreate()  : void
setCrmCreateCompany()  : void
setCrmCreateContact()  : void
setCrmCreateDeal()  : void
setCrmCreateLead()  : void
setDateClose()  : void
setDateCloseVote()  : void
setDateCreate()  : void
setDateFirstAnswer()  : void
setDateFirstLastUserAction()  : void
setDateLastMessage()  : void
setDateModify()  : void
setDateOperator()  : void
setDateOperatorAnswer()  : void
setDateOperatorClose()  : void
setEndId()  : void
setIsClosed()  : self
setLikeCount()  : void
setMessageCount()  : void
setMode()  : void
setOperatorFromCrm()  : void
setOperatorId()  : self
setParentId()  : void
setPause()  : void
setPinMode()  : self
setPrimaryId()  : self
setRegistry()  : self
setSendForm()  : void
setSendHistory()  : void
setSessionId()  : self
setSource()  : void
setSpam()  : void
setStartId()  : void
setStatus()  : self
setTimeAnswer()  : void
setTimeBot()  : void
setTimeClose()  : void
setTimeDialog()  : void
setTimeFirstAnswer()  : void
setUserCode()  : void
setUserId()  : void
setWaitAction()  : void
setWaitAnswer()  : void
setWaitVote()  : void
setWorktime()  : void
toArray()  : array<string|int, mixed>
Returns object state as array.
toRestFormat()  : array<string|int, mixed>|null
Returns an array in JSON like format to return the entity as a rest response.
updateStateAfterOrmEvent()  : 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

fill()

Fills object's fields with provided values.

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

fillActual()

public fillActual(array<string|int, mixed> $fieldsToFill) : self
Parameters
$fieldsToFill : array<string|int, mixed>
Return values
self

getCategoryId()

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

getChatId()

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

getConfigId()

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

getCrmActivityId()

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

getDataClass()

Returns ORM tablet class name.

public static getDataClass() : string
Return values
string

getEndId()

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

getId()

Returns the id of the entity

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

getInstance()

public static getInstance(int|null $sessionId) : self|null
Parameters
$sessionId : int|null
Return values
self|null

getInstanceByChatId()

public static getInstanceByChatId(int|null $chatId) : self|null
Parameters
$chatId : int|null
Return values
self|null

getLikeCount()

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

getMessageCount()

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

getMode()

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

getOperatorId()

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

getParentId()

public getParentId() : int
Return values
int

getPinMode()

public getPinMode() : bool
Return values
bool

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

getPrimaryId()

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

getSendForm()

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

getSessionId()

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

getSource()

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

getStartId()

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

getStatus()

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

getTimeAnswer()

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

getTimeBot()

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

getTimeClose()

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

getTimeDialog()

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

getTimeFirstAnswer()

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

getUserCode()

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

getUserId()

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

isClosed()

public isClosed() : bool
Return values
bool

isCrm()

public isCrm() : bool
Return values
bool

isCrmCreate()

public isCrmCreate() : bool
Return values
bool

isCrmCreateCompany()

public isCrmCreateCompany() : bool
Return values
bool

isCrmCreateContact()

public isCrmCreateContact() : bool
Return values
bool

isCrmCreateDeal()

public isCrmCreateDeal() : bool
Return values
bool

isCrmCreateLead()

public isCrmCreateLead() : bool
Return values
bool

isOperatorFromCrm()

public isOperatorFromCrm() : bool
Return values
bool

isPause()

public isPause() : bool
Return values
bool

isSendHistory()

public isSendHistory() : bool
Return values
bool

isSpam()

public isSpam() : bool
Return values
bool

isWaitAction()

public isWaitAction() : bool
Return values
bool

isWaitAnswer()

public isWaitAnswer() : bool
Return values
bool

isWaitVote()

public isWaitVote() : bool
Return values
bool

isWorktime()

public isWorktime() : bool
Return values
bool

markChanged()

Marks object changed.

public markChanged([bool|null $state = null ]) : static
Parameters
$state : bool|null = null
Return values
static

offsetSet()

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

onAfterOrmUpdate()

public onAfterOrmUpdate(array<string|int, mixed> $fields) : self
Parameters
$fields : array<string|int, mixed>
Return values
self

setCategoryId()

public setCategoryId(int|null $categoryId) : void
Parameters
$categoryId : int|null

setChat()

public setChat(Chat|null $chat) : self
Parameters
$chat : Chat|null
Return values
self

setChatId()

public setChatId(int|null $chatId) : self
Parameters
$chatId : int|null
Return values
self

setConfigId()

public setConfigId(int|null $configId) : self
Parameters
$configId : int|null
Return values
self

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

setCrm()

public setCrm(bool $crm) : void
Parameters
$crm : bool

setCrmActivityId()

public setCrmActivityId(int|null $crmActivityId) : void
Parameters
$crmActivityId : int|null

setCrmCreate()

public setCrmCreate(bool $crmCreate) : void
Parameters
$crmCreate : bool

setCrmCreateCompany()

public setCrmCreateCompany(bool $crmCreateCompany) : void
Parameters
$crmCreateCompany : bool

setCrmCreateContact()

public setCrmCreateContact(bool $crmCreateContact) : void
Parameters
$crmCreateContact : bool

setCrmCreateDeal()

public setCrmCreateDeal(bool $crmCreateDeal) : void
Parameters
$crmCreateDeal : bool

setCrmCreateLead()

public setCrmCreateLead(bool $crmCreateLead) : void
Parameters
$crmCreateLead : bool

setDateCloseVote()

public setDateCloseVote(DateTime|null $dateCloseVote) : void
Parameters
$dateCloseVote : DateTime|null

setDateFirstAnswer()

public setDateFirstAnswer(DateTime|null $dateFirstAnswer) : void
Parameters
$dateFirstAnswer : DateTime|null

setDateFirstLastUserAction()

public setDateFirstLastUserAction(DateTime|null $dateFirstLastUserAction) : void
Parameters
$dateFirstLastUserAction : DateTime|null

setDateLastMessage()

public setDateLastMessage(DateTime|null $dateLastMessage) : void
Parameters
$dateLastMessage : DateTime|null

setDateOperator()

public setDateOperator(DateTime|null $dateOperator) : void
Parameters
$dateOperator : DateTime|null

setDateOperatorAnswer()

public setDateOperatorAnswer(DateTime|null $dateOperatorAnswer) : void
Parameters
$dateOperatorAnswer : DateTime|null

setDateOperatorClose()

public setDateOperatorClose(DateTime|null $dateOperatorClose) : void
Parameters
$dateOperatorClose : DateTime|null

setEndId()

public setEndId(int|null $endId) : void
Parameters
$endId : int|null

setIsClosed()

public setIsClosed(bool|null $isClosed) : self
Parameters
$isClosed : bool|null
Return values
self

setLikeCount()

public setLikeCount(int|null $likeCount) : void
Parameters
$likeCount : int|null

setMessageCount()

public setMessageCount(int|null $messageCount) : void
Parameters
$messageCount : int|null

setMode()

public setMode(string|null $mode) : void
Parameters
$mode : string|null

setOperatorFromCrm()

public setOperatorFromCrm(bool $operatorFromCrm) : void
Parameters
$operatorFromCrm : bool

setOperatorId()

public setOperatorId(int|null $operatorId) : self
Parameters
$operatorId : int|null
Return values
self

setParentId()

public setParentId(int $parentId) : void
Parameters
$parentId : int

setPause()

public setPause(bool $pause) : void
Parameters
$pause : bool

setPinMode()

public setPinMode(bool|null $pinMode) : self
Parameters
$pinMode : bool|null
Return values
self

setPrimaryId()

public setPrimaryId(int $primaryId) : self
Parameters
$primaryId : int
Return values
self

setSendForm()

public setSendForm(string|null $sendForm) : void
Parameters
$sendForm : string|null

setSendHistory()

public setSendHistory(bool $sendHistory) : void
Parameters
$sendHistory : bool

setSessionId()

public setSessionId(int|null $id) : self
Parameters
$id : int|null
Return values
self

setSource()

public setSource(string|null $source) : void
Parameters
$source : string|null

setSpam()

public setSpam(bool $spam) : void
Parameters
$spam : bool

setStartId()

public setStartId(int|null $startId) : void
Parameters
$startId : int|null

setStatus()

public setStatus(int|null $status) : self
Parameters
$status : int|null
Return values
self

setTimeAnswer()

public setTimeAnswer(int|null $timeAnswer) : void
Parameters
$timeAnswer : int|null

setTimeBot()

public setTimeBot(int|null $timeBot) : void
Parameters
$timeBot : int|null

setTimeClose()

public setTimeClose(int|null $timeClose) : void
Parameters
$timeClose : int|null

setTimeDialog()

public setTimeDialog(int|null $timeDialog) : void
Parameters
$timeDialog : int|null

setTimeFirstAnswer()

public setTimeFirstAnswer(int|null $timeFirstAnswer) : void
Parameters
$timeFirstAnswer : int|null

setUserCode()

public setUserCode(string|null $userCode) : void
Parameters
$userCode : string|null

setUserId()

public setUserId(int|null $userId) : void
Parameters
$userId : int|null

setWaitAction()

public setWaitAction(bool $waitAction) : void
Parameters
$waitAction : bool

setWaitAnswer()

public setWaitAnswer(bool $waitAnswer) : void
Parameters
$waitAnswer : bool

setWaitVote()

public setWaitVote(bool $waitVote) : void
Parameters
$waitVote : bool

setWorktime()

public setWorktime(bool $worktime) : void
Parameters
$worktime : bool

toArray()

Returns object state as array.

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

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

updateStateAfterOrmEvent()

public static updateStateAfterOrmEvent(int $id, array<string|int, mixed> $fields) : void
Parameters
$id : int
$fields : 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