• Главная
• raoul2000
• workflow
• source
• file
• WorkflowFileSource

PHP Класс raoul2000\workflow\source\file\WorkflowFileSource

The task of loading the workflow definition file, and turns it content into a normalized array, is delegated to a WorkflowDefinitionLoader instance. The definition loader can be initialized through the [[definitionLoader]] attribute. Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство	Тип	Описание
$definitionCache		The workflow definition cache used by this source component can be be specified in one of the following forms : - string : ID of an existing cache component registered in the current Yii::$app. - a configuration array: the array must contain a class element which is treated as the object class, and the rest of the name-value pairs will be used to initialize the corresponding object properties - object : the instance of the cache component By default no cache is used.
$definitionLoader		The workflow definition loader used by this source component can be be specified in one of the following forms : - string : ID of an existing workflow definition component registered in the current Yii::$app. - a configuration array: the array must contain a class element which is treated as the object class, and the rest of the name-value pairs will be used to initialize the corresponding object properties - object : the instance of the workflow definition loader Note that in all cases, the workflow definition loader configured here must implement the WorkflowDefinitionLoader interface. If this attribute is not set then a default object of type \raoul2000\workflow\source\file\PhpClassLoader is used.

Открытые методы

Метод	Описание
__construct ( array $config = [] )	Constructor method.
addWorkflowDefinition ( string $workflowId, array $definition, boolean $overwrite = false ) : boolean	Add a workflow definition array to the collection of workflow definitions handled by this source.
getAllStatuses ( $workflowId )	Returns an array containing all statuses belonging to a workflow.
getClassMap ( ) : string[]	Returns the class map array for this Workflow source instance.
getClassMapByType ( string $type ) : string | null	Returns the class name that implement the type passed as argument.
getDefinitionCache ( ) : null | yii\caching\Cache	Return the workflow definition cache component used by this workflow source or NULL if no cache is used.
getDefinitionLoader ( ) : WorkflowDefinitionLoader	Returns the Workflow Definition Loader component.
getStatus ( string $id, mixed $defaultWorkflowId = null ) : Status	Returns the status object instance whose id is passed as argument.
getTransition ( $startId, $endId, $defaultWorkflowId = null )	Returns the transition between $startId and $endId statuses.
getTransitions ( $statusId, $defaultWorkflowId = null )	Returns all out going transitions leaving the status whose id is passed as argument.
getWorkflow ( $id ) : Workflow | null	Returns the Workflow instance whose id is passed as argument.
getWorkflowDefinition ( string $id )	Loads definition for the workflow whose id is passed as argument.
isValidStatusId ( string $id ) : boolean	Checks if the string passed as argument can be used as a status ID.
isValidStatusLocalId ( string $val ) : boolean	Checks if the string passed as argument can be used as a status local ID.
isValidWorkflowId ( string $val ) : boolean	Checks if the string passed as argument can be used as a workflow ID.
parseStatusId ( string $val, Model | string $helper = null ) : string[]	Parses the string $val assuming it is a status id and returns and array containing the workflow ID and status local ID.
validateWorkflowDefinition ( string $wId, array $definition ) : array	Validate the workflow definition passed as argument.

Описание методов

Описание свойств