Класс Base

Граф наследования:Base:

Открытые члены
	__construct ($processId=0)
	setProcessId (int $processId)
	getContext ()
	setContext ($context='')
	getContextEntity ()
	setContextEntity ($appId=0)
	getSetting ()
	register (array $data, array $additionalOptions=[], int $userId=0, string $appCode='', bool $byAgent=true)
	unregister ()
	getNotificationInstance ()
	getStatus ()
	get ()

Открытые статические члены
static	runAgent (int $processId)

Открытые атрибуты
const	CONTEXT_PREFIX = 'configuration_action'
const	ACTION = 'base'
const	ERROR_PROCESS_NOT_FOUND = 'PROCESS_NOT_FOUND'
const	ERROR_PROCESS_DID_NOT_CREATE = 'PROCESS_DID_NOT_CREATE'
const	STATUS_START = 'S'
const	STATUS_PROCESS = 'P'
const	STATUS_FINISH = 'F'
const	STATUS_ERROR = 'E'
const	STATUS_UNKNOWN = 'U'
const	STATUSES
const	PROPERTY_STRUCTURE = 'STRUCTURE'
const	PROPERTY_FILES = 'FILES'
const	PROPERTY_MANIFEST = 'MANIFEST'

Защищенные члены
	run ()
	checkRegister ($data)
	init ()
	reset ()
	getStructureData ()
	prepareData ($data)
	setStatus (string $status)

Защищенные данные
const	MODULE_ID = 'rest'
	$processId = 0
	$setting = null
	$notification = null

Подробное описание

См. определение в файле base.php строка 19

Конструктор(ы)

__construct()

__construct

(

$processId = 0

)

Base constructor.

Аргументы

int

$processId

См. определение в файле base.php строка 60

Методы

checkRegister()

checkRegister ( $data )

abstractprotected

Переопределяется в Import.

get()

get

(

)

Returns information about current action

Возвращает

array

Переопределяется в Import.

См. определение в файле base.php строка 417

getContext()

getContext

(

)

Returns current working user context

Возвращает

string

См. определение в файле base.php строка 103

getContextEntity()

getContextEntity

(

)

Returns working context

Возвращает

string

См. определение в файле base.php строка 132

getNotificationInstance()

getNotificationInstance

(

)

Returns instance to work with notification

Возвращает

Notification

См. определение в файле base.php строка 378

getSetting()

getSetting

(

)

Returns instance of Setting with current context

Возвращает

Setting

См. определение в файле base.php строка 156

getStatus()

getStatus

(

)

Returns actions status

Возвращает

array|mixed|string

См. определение в файле base.php строка 408

getStructureData()

getStructureData ( )

protected

Возвращает

array|mixed

См. определение в файле base.php строка 169

init()

init ( )

protected

См. определение в файле base.php строка 66

prepareData()

prepareData ( $data )

protected

Prepares data before saving. Sorted list of files important for some cases.

Аргументы

$data

Возвращает

mixed

См. определение в файле base.php строка 302

register()

register	(	array	$data,
		array	$additionalOptions = [],
		int	$userId = 0,
		string	$appCode = '',
		bool	$byAgent = true )

Registers process

Аргументы

array	$data
array	$additionalOptions
int	$userId
string	$appCode
bool	$byAgent

Возвращает

array

Исключения

ArgumentException

См. определение в файле base.php строка 216

reset()

reset ( )

protected

См. определение в файле base.php строка 72

run()

run ( )

abstractprotected

Переопределяется в Import.

runAgent()

static runAgent ( int $processId )

static

Аргументы

int

$processId

Возвращает

string

См. определение в файле base.php строка 448

setContext()

setContext

(

$context = ''

)

Set custom working user context

Аргументы

string

$context

Возвращает

bool

См. определение в файле base.php строка 114

setContextEntity()

setContextEntity

(

$appId = 0

)

Sets working context

Аргументы

int

$appId

Возвращает

bool

См. определение в файле base.php строка 143

setProcessId()

setProcessId

(

int

$processId

)

Sets process id

Аргументы

int

$processId

Возвращает

bool

См. определение в файле base.php строка 84

setStatus()

setStatus ( string $status )

protected

Аргументы

string

$status

Возвращает

bool

См. определение в файле base.php строка 393

unregister()

unregister

(

)

Unregister process

Возвращает

string[]

См. определение в файле base.php строка 336

Данные класса

$notification

$notification = null

protected

См. определение в файле base.php строка 48

$processId

$processId = 0

protected

См. определение в файле base.php строка 46

$setting

$setting = null

protected

См. определение в файле base.php строка 47

ACTION

const ACTION = 'base'

См. определение в файле base.php строка 22

CONTEXT_PREFIX

const CONTEXT_PREFIX = 'configuration_action'

См. определение в файле base.php строка 21

ERROR_PROCESS_DID_NOT_CREATE

const ERROR_PROCESS_DID_NOT_CREATE = 'PROCESS_DID_NOT_CREATE'

См. определение в файле base.php строка 24

ERROR_PROCESS_NOT_FOUND

const ERROR_PROCESS_NOT_FOUND = 'PROCESS_NOT_FOUND'

См. определение в файле base.php строка 23

MODULE_ID

const MODULE_ID = 'rest'

protected

См. определение в файле base.php строка 45

PROPERTY_FILES

const PROPERTY_FILES = 'FILES'

См. определение в файле base.php строка 42

PROPERTY_MANIFEST

const PROPERTY_MANIFEST = 'MANIFEST'

См. определение в файле base.php строка 43

PROPERTY_STRUCTURE

const PROPERTY_STRUCTURE = 'STRUCTURE'

См. определение в файле base.php строка 41

STATUS_ERROR

const STATUS_ERROR = 'E'

См. определение в файле base.php строка 30

STATUS_FINISH

const STATUS_FINISH = 'F'

См. определение в файле base.php строка 29

STATUS_PROCESS

const STATUS_PROCESS = 'P'

См. определение в файле base.php строка 28

STATUS_START

const STATUS_START = 'S'

См. определение в файле base.php строка 27

STATUS_UNKNOWN

const STATUS_UNKNOWN = 'U'

См. определение в файле base.php строка 31

STATUSES

const STATUSES

Инициализатор

= [
        self::STATUS_START,
        self::STATUS_PROCESS,
        self::STATUS_FINISH,
        self::STATUS_ERROR,
        self::STATUS_UNKNOWN,
    ]

См. определение в файле base.php строка 32