Bitrix API

Base

AbstractYes

Table of Contents

Constants

ACTION  = 'base'
CONTEXT_PREFIX  = 'configuration_action'
ERROR_PROCESS_DID_NOT_CREATE  = 'PROCESS_DID_NOT_CREATE'
ERROR_PROCESS_NOT_FOUND  = 'PROCESS_NOT_FOUND'
PROPERTY_FILES  = 'FILES'
PROPERTY_MANIFEST  = 'MANIFEST'
PROPERTY_STRUCTURE  = 'STRUCTURE'
STATUS_ERROR  = 'E'
STATUS_FINISH  = 'F'
STATUS_PROCESS  = 'P'
STATUS_START  = 'S'
STATUS_UNKNOWN  = 'U'
STATUSES  = [self::STATUS_START, self::STATUS_PROCESS, self::STATUS_FINISH, self::STATUS_ERROR, self::STATUS_UNKNOWN]

Methods

__construct()  : mixed
Base constructor.
get()  : array<string|int, mixed>
Returns information about current action
getContext()  : string
Returns current working user context
getContextEntity()  : string
Returns working context
getNotificationInstance()  : Notification
Returns instance to work with notification
getSetting()  : Setting
Returns instance of Setting with current context
getStatus()  : array<string|int, mixed>|mixed|string
Returns actions status
register()  : array<string|int, mixed>
Registers process
runAgent()  : string
setContext()  : bool
Set custom working user context
setContextEntity()  : bool
Sets working context
setProcessId()  : bool
Sets process id
unregister()  : array<string|int, string>
Unregister process

Constants

ACTION

public mixed ACTION = 'base'

CONTEXT_PREFIX

public mixed CONTEXT_PREFIX = 'configuration_action'

ERROR_PROCESS_DID_NOT_CREATE

public mixed ERROR_PROCESS_DID_NOT_CREATE = 'PROCESS_DID_NOT_CREATE'

ERROR_PROCESS_NOT_FOUND

public mixed ERROR_PROCESS_NOT_FOUND = 'PROCESS_NOT_FOUND'

PROPERTY_FILES

public mixed PROPERTY_FILES = 'FILES'

PROPERTY_MANIFEST

public mixed PROPERTY_MANIFEST = 'MANIFEST'

PROPERTY_STRUCTURE

public mixed PROPERTY_STRUCTURE = 'STRUCTURE'

STATUS_ERROR

public mixed STATUS_ERROR = 'E'

STATUS_FINISH

public mixed STATUS_FINISH = 'F'

STATUS_PROCESS

public mixed STATUS_PROCESS = 'P'

STATUS_START

public mixed STATUS_START = 'S'

STATUS_UNKNOWN

public mixed STATUS_UNKNOWN = 'U'

STATUSES

public mixed STATUSES = [self::STATUS_START, self::STATUS_PROCESS, self::STATUS_FINISH, self::STATUS_ERROR, self::STATUS_UNKNOWN]

Methods

__construct()

Base constructor.

public __construct([int $processId = 0 ]) : mixed
Parameters
$processId : int = 0

get()

Returns information about current action

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

getContext()

Returns current working user context

public getContext() : string
Return values
string

getContextEntity()

Returns working context

public getContextEntity() : string
Return values
string

getNotificationInstance()

Returns instance to work with notification

public getNotificationInstance() : Notification
Return values
Notification

getSetting()

Returns instance of Setting with current context

public getSetting() : Setting
Return values
Setting

getStatus()

Returns actions status

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

register()

Registers process

public register(array<string|int, mixed> $data[, array<string|int, mixed> $additionalOptions = [] ][, int $userId = 0 ][, string $appCode = '' ][, bool $byAgent = true ]) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>
$additionalOptions : array<string|int, mixed> = []
$userId : int = 0
$appCode : string = ''
$byAgent : bool = true
Tags
throws
ArgumentException
Return values
array<string|int, mixed>

runAgent()

public static runAgent(int $processId) : string
Parameters
$processId : int
Return values
string

setContext()

Set custom working user context

public setContext([string $context = '' ]) : bool
Parameters
$context : string = ''
Return values
bool

setContextEntity()

Sets working context

public setContextEntity([int $appId = 0 ]) : bool
Parameters
$appId : int = 0
Return values
bool

setProcessId()

Sets process id

public setProcessId(int $processId) : bool
Parameters
$processId : int
Return values
bool

unregister()

Unregister process

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results