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

Открытые члены
	getInstanceId ()
	getRuntime ()
	getRootActivity ()
	getService ($name)
	getDocumentId ()
	getDocumentType ()
	getTemplateId ()
	getStartedBy ()
	getPersister ()
	__construct ($instanceId, CBPRuntime $runtime)
	__sleep ()
	initialize (CBPActivity $rootActivity, $documentId, $workflowParameters=[], $workflowVariablesTypes=[], $workflowParametersTypes=[], $workflowTemplateId=0)
	reload (CBPActivity $rootActivity)
	start ()
	resume ()
	isNew ()
	abandon ()
	isAbandoned ()
	isFinished ()
	sendExternalEvent (string $eventName, array $eventParameters=[])
	getActivityByName ($activityName)
	initializeActivity (CBPActivity $activity)
	executeActivity (CBPActivity $activity, array $eventParameters=[])
	closeActivity (CBPActivity $activity, $arEventParameters=[])
	cancelActivity (CBPActivity $activity, $arEventParameters=[])
	faultActivity (CBPActivity $activity, Exception $e, $arEventParameters=[])
	finalizeActivity (CBPActivity $activity)
	addEventHandler ($eventName, IBPActivityExternalEventListener $eventHandler)
	getEventsMap ()
	removeEventHandler ($eventName, IBPActivityExternalEventListener $eventHandler)
	isDebug ()

Защищенные члены
	setWorkflowStatus ($newStatus)
	runQueue ()
	runStep ()

Защищенные данные
CBPRuntime	$runtime
CBPWorkflowPersister	$persister
CBPCompositeActivity	$rootActivity
array	$activitiesQueue = []
array	$eventsQueue = []

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

Workflow instance.

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

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

◆ __construct()

__construct	(		$instanceId,
		CBPRuntime	$runtime )

Public constructor initializes a new workflow instance with the specified ID.

Аргументы

mixed	$instanceId	- ID of the new workflow instance.
mixed	$runtime	- Runtime object.

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

Методы

◆ __sleep()

__sleep ( )

Remove workflow object from serialized data

Возвращает: array

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

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

◆ abandon()

abandon ( )

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

◆ addEventHandler()

addEventHandler	(		$eventName,
		IBPActivityExternalEventListener	$eventHandler )

Add new event handler to the specified event.

Аргументы

mixed	$eventName	- Event name.
IBPActivityExternalEventListener	$eventHandler	- Event handler.

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

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

◆ cancelActivity()

cancelActivity	(	CBPActivity	$activity,
			$arEventParameters = [] )

Cancel specified activity.

Аргументы

CBPActivity	$activity	- Activity object.
mixed	$arEventParameters	- Optional parameters.

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

◆ closeActivity()

closeActivity	(	CBPActivity	$activity,
			$arEventParameters = [] )

Close specified activity.

Аргументы

CBPActivity	$activity	- Activity object.
mixed	$arEventParameters	- Optional parameters.

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

◆ executeActivity()

executeActivity	(	CBPActivity	$activity,
		array	$eventParameters = [] )

Plans specified activity for execution.

Аргументы

CBPActivity	$activity	- Activity object.
mixed	$eventParameters	- Optional parameters.

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

◆ faultActivity()

faultActivity	(	CBPActivity	$activity,
		Exception	$e,
			$arEventParameters = [] )

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

◆ finalizeActivity()

finalizeActivity ( CBPActivity $activity )

Аргументы

CBPActivity $activity

Исключения

CBPArgumentNullException
Exception

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

◆ getActivityByName()

getActivityByName ( $activityName )

Returns activity by its name.

Аргументы

mixed $activityName - Activity name.

Возвращает: CBPActivity - Returns activity object or null if activity is not found.

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

◆ getDocumentId()

getDocumentId ( )

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

◆ getDocumentType()

getDocumentType ( )

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

◆ getEventsMap()

getEventsMap ( )

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

◆ getInstanceId()

getInstanceId ( )

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

◆ getPersister()

getPersister ( )

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

◆ getRootActivity()

getRootActivity ( )

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

◆ getRuntime()

getRuntime ( )

Возвращает: CBPRuntime

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

◆ getService()

getService ( $name )

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

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

◆ getStartedBy()

getStartedBy ( )

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

◆ getTemplateId()

getTemplateId ( )

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

◆ initialize()

initialize	(	CBPActivity	$rootActivity,
			$documentId,
			$workflowParameters = [],
			$workflowVariablesTypes = [],
			$workflowParametersTypes = [],
			$workflowTemplateId = 0 )

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

◆ initializeActivity()

initializeActivity ( CBPActivity $activity )

Initializes the specified activity by calling its method Initialize.

Аргументы

CBPActivity $activity

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

◆ isAbandoned()

isAbandoned ( )

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

◆ isDebug()

isDebug ( )

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

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

◆ isFinished()

isFinished ( )

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

◆ isNew()

isNew ( )

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

◆ reload()

reload ( CBPActivity $rootActivity )

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

◆ removeEventHandler()

removeEventHandler	(		$eventName,
		IBPActivityExternalEventListener	$eventHandler )

Remove the event handler from the specified event.

Аргументы

mixed	$eventName	- Event name.
IBPActivityExternalEventListener	$eventHandler	- Event handler.

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

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

◆ resume()

resume ( )

Resume existing workflow.

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

◆ runQueue()

runQueue ( )

protected

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

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

◆ runStep()

runStep ( )

protected

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

◆ sendExternalEvent()

sendExternalEvent	(	string	$eventName,
		array	$eventParameters = [] )

Resume the workflow instance and transfer the specified event to it.

Аргументы

string	$eventName	- Event name.
array	$eventParameters	- Event parameters.

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

◆ setWorkflowStatus()

setWorkflowStatus ( $newStatus )

protected

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

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

◆ start()

start ( )

Starts new workflow instance.

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

Поля

◆ $activitiesQueue

array $activitiesQueue = []

protected

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

◆ $eventsQueue

array $eventsQueue = []

protected

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

◆ $persister

CBPWorkflowPersister $persister

protected

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

◆ $rootActivity

CBPCompositeActivity $rootActivity

protected

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

◆ $runtime

CBPRuntime $runtime

protected

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

Объявления и описания членов класса находятся в файле:

C:/bitrix/modules/bizproc/classes/general/workflow.php

Открытые члены

Защищенные члены

Защищенные данные

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

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

◆ __construct()

Методы

◆ __sleep()

◆ abandon()

◆ addEventHandler()

◆ cancelActivity()

◆ closeActivity()

◆ executeActivity()

◆ faultActivity()

◆ finalizeActivity()

◆ getActivityByName()

◆ getDocumentId()

◆ getDocumentType()

◆ getEventsMap()

◆ getInstanceId()

◆ getPersister()

◆ getRootActivity()

◆ getRuntime()

◆ getService()

◆ getStartedBy()

◆ getTemplateId()

◆ initialize()

◆ initializeActivity()

◆ isAbandoned()

◆ isDebug()

◆ isFinished()

◆ isNew()

◆ reload()

◆ removeEventHandler()

◆ resume()

◆ runQueue()

◆ runStep()

◆ sendExternalEvent()

◆ setWorkflowStatus()

◆ start()

Поля

◆ $activitiesQueue

◆ $eventsQueue

◆ $persister

◆ $rootActivity

◆ $runtime