PHP Interface raoul2000\workflow\base\StatusInterface

Show file Open project: raoul2000/yii2-workflow

Public Methods

Method	Description
getId ( ) : string	Returns the id of this status.
getLabel ( ) : string	Returns the label for this status.
getTransitions ( ) : Transition[]	Returns the list of Transitions instances leaving this status.
getWorkflow ( ) : Workflow	Returns the workflow instance this status belongs to
getWorkflowId ( ) : string
isInitialStatus ( ) : boolean	Test is this status is the initial status of the parent workflow

Method Details

getId() public method

Returns the id of this status.

public getId ( ) : string
return	string	the id for this status

getLabel() public method

Returns the label for this status.

public getLabel ( ) : string
return	string	the label for this status. .

getTransitions() public method

The array returned is indexed by the canonical id of the end status. Note that an empty array can be returned if this status has no out-going transition (i.e. no other status can be reached).

public getTransitions ( ) : Transition[]
return	Transition[]	the list of out-going transitions for this status.

getWorkflow() public method

Returns the workflow instance this status belongs to

public getWorkflow ( ) : Workflow
return	Workflow	the workflow instance

getWorkflowId() public method

public getWorkflowId ( ) : string
return	string	the id of the workflow this status belongs to.

isInitialStatus() public method

Test is this status is the initial status of the parent workflow

public isInitialStatus ( ) : boolean
return	boolean	TRUE if this status is the initial status of its parent workflow, FALSE otherwise