Class WorkflowBaseObject

This class is the base class for Workflow, Transition and Status objects.

It mainly provides a way to store additional properties without the need to declare them in the class definition. Theses properties are called metadata and stored into an array. They can be accessed like regular class properties.

yii\base\Object

raoul2000\workflow\base\WorkflowBaseObject

Direct known subclasses

raoul2000\workflow\base\Status, raoul2000\workflow\base\Transition, raoul2000\workflow\base\Workflow

Abstract
Namespace: raoul2000\workflow\base
Located at base/WorkflowBaseObject.php

Methods summary

`public`	# `__construct( array $config = [] )` Construct a workflow object. Construct a workflow object. Parameters `$config`
`public`	# `__get( $name )`
`abstract public string`	# `getId( )` Returns string the object identifier
`public mixed`	# `getMetadata( string $paramName = null, mixed $defaultValue = null )` Returns the value of the metadata with namer `$paramName`. If no `$paramName`is provided, this method returns an array containing all metadata parameters. Returns the value of the metadata with namer `$paramName`. If no `$paramName`is provided, this method returns an array containing all metadata parameters. Parameters `$paramName` when null the method returns the complet metadata array, otherwise it returns the value of the correponding metadata. `$defaultValue` Returns mixed Throws yii\base\InvalidConfigException
`public boolean`	# `hasMetadata( string $paramName )` Test if a metadata parameter is defined. Test if a metadata parameter is defined. Parameters `$paramName` the metadata parameter name Returns boolean TRUE if the metadata parameter exists, FALSE otherwise Throws `raoul2000\workflow\base\WorkflowException`
`public raoul2000\workflow\source\IWorkflowSource`	# `getSource( )` Returns the source workflow component used to create this instance. Returns the source workflow component used to create this instance. Returns `raoul2000\workflow\source\IWorkflowSource` the source instance or null if no source was been provided

Namespaces

Classes

Interfaces

Class WorkflowBaseObject

Direct known subclasses

Methods summary

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Throws

Returns