Bitrix API

Session extends EO_DebuggerSession

Table of Contents

Constants

ERROR_DOCUMENT_ID_ALREADY_FIXED  = 'DOCUMENT ID IS ALREADY FIXED'
ERROR_UNKNOWN_DOCUMENT_ID  = 'FIXING UNKNOWN DOCUMENT ID'

Methods

addDocument()  : mixed
addWorkflowContext()  : Result
canAddDocument()  : bool
Returns true if can add document to session documents and false otherwise
canUserDebug()  : bool
canUserFinish()  : bool
deleteAll()  : Result
deleteDocuments()  : Result
deleteWorkflows()  : mixed
finish()  : mixed
fixateDocument()  : mixed
getDescription()  : string|null
getFixedDocument()  : Document|null
getLogs()  : array<string|int, EO_Tracking>
getParameterDocumentType()  : array<string|int, mixed>
getRobots()  : array<string|int, mixed>
getShortDescription()  : string|null
hasWorkflow()  : bool
isActive()  : bool
isBeforeDebuggerStartState()  : bool
isExperimentalMode()  : bool
Returns true if the session mode is Experimental and false otherwise.
isFixed()  : bool
isFixedDocument()  : bool
isInterceptionMode()  : bool
Returns true if the session mode is Interception and false otherwise.
isSessionDocument()  : bool
isStartedByUser()  : bool
isStartedInDocumentType()  : bool
removeFromDocuments()  : void
toArray()  : array<string|int, mixed>

Constants

ERROR_DOCUMENT_ID_ALREADY_FIXED

public mixed ERROR_DOCUMENT_ID_ALREADY_FIXED = 'DOCUMENT ID IS ALREADY FIXED'

ERROR_UNKNOWN_DOCUMENT_ID

public mixed ERROR_UNKNOWN_DOCUMENT_ID = 'FIXING UNKNOWN DOCUMENT ID'

Methods

addDocument()

public addDocument(string $documentId) : mixed
Parameters
$documentId : string

addWorkflowContext()

public addWorkflowContext(string $workflowId, Template|array<string|int, mixed> $template) : Result
Parameters
$workflowId : string
$template : Template|array<string|int, mixed>
Return values
Result

canAddDocument()

Returns true if can add document to session documents and false otherwise

public canAddDocument() : bool
Return values
bool

canUserDebug()

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

canUserFinish()

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

deleteAll()

public deleteAll() : Result
Return values
Result

deleteDocuments()

public deleteDocuments() : Result
Return values
Result

deleteWorkflows()

public deleteWorkflows() : mixed

fixateDocument()

public fixateDocument(string $documentId) : mixed
Parameters
$documentId : string

getDescription()

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

getLogs()

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

getParameterDocumentType()

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

getRobots()

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

getShortDescription()

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

hasWorkflow()

public hasWorkflow(string $workflowId) : bool
Parameters
$workflowId : string
Return values
bool

isActive()

public isActive() : bool
Return values
bool

isBeforeDebuggerStartState()

public isBeforeDebuggerStartState() : bool
Return values
bool

isExperimentalMode()

Returns true if the session mode is Experimental and false otherwise.

public isExperimentalMode() : bool
Return values
bool

isFixed()

public isFixed() : bool
Return values
bool

isFixedDocument()

public isFixedDocument(array<string|int, mixed> $parameterDocumentId) : bool
Parameters
$parameterDocumentId : array<string|int, mixed>
Return values
bool

isInterceptionMode()

Returns true if the session mode is Interception and false otherwise.

public isInterceptionMode() : bool
Return values
bool

isSessionDocument()

public isSessionDocument(array<string|int, mixed> $parameterDocumentId) : bool
Parameters
$parameterDocumentId : array<string|int, mixed>
Return values
bool

isStartedByUser()

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

isStartedInDocumentType()

public isStartedInDocumentType(array<string|int, mixed> $parameterDocumentType) : bool
Parameters
$parameterDocumentType : array<string|int, mixed>
Return values
bool

removeFromDocuments()

public removeFromDocuments(Document $debuggerSessionDocument) : void
Parameters
$debuggerSessionDocument : Document

toArray()

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results