Class Status
A Status object is a component of a workflow.
-
yii\base\Object
-
raoul2000\workflow\base\WorkflowBaseObject
-
raoul2000\workflow\base\Status
implements
raoul2000\workflow\base\StatusInterface
Methods summary
public
|
#
__construct( array $config = [] )
Status constructor.
To create a Status you must provide following values
in the $config array passed as argument:
- id : the id for this status.
- **workflowId ** : the id of the workflow this status belongs to.
Following values are optional :
- label : human readable name for this status.
Parameters
Throws
yii\base\InvalidConfigException
Overrides
|
public
string
|
#
getId( )
Returns the id of this status.
Returns the id of this status.
Note that the status id returned must be unique inside the workflow it belongs to, but it
doesn't have to be unique among all workflows.
Returns
string the id for this status
Implementation of
|
public
string
|
#
getLabel( )
Returns the label for this status.
Returns the label for this status.
Returns
string the label for this status. .
Implementation of
|
public
string
|
#
getWorkflowId( )
Returns
string the id of the workflow this status belongs to.
Implementation of
|
public
raoul2000\workflow\base\Transition[]
|
#
getTransitions( )
Returns
See
Implementation of
|
public
raoul2000\workflow\base\Workflow
|
#
getWorkflow( )
Returns
See
Implementation of
|
public
boolean
|
#
isInitialStatus( )
Returns
boolean TRUE if this status is the initial status of its parent workflow, FALSE otherwise
See
Implementation of
|