PHP Class raoul2000\workflow\base\Status

Author: Raoul

Inheritance: extends WorkflowBaseObject, implements raoul2000\workflow\base\StatusInterface

Afficher le fichier Open project: raoul2000/yii2-workflow Class Usage Examples

Méthodes publiques

Méthode	Description
__construct ( array $config = [] )	Status constructor.
getId ( ) : string	Returns the id of this status.
getLabel ( ) : string	Returns the label for this status.
getTransitions ( )
getWorkflow ( )
getWorkflowId ( ) : string
isInitialStatus ( )

Method Details

__construct() public méthode

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.

public __construct ( array $config = [] )
$config	array

getId() public méthode

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.

public getId ( ) : string
Résultat	string	the id for this status

getLabel() public méthode

Returns the label for this status.

public getLabel ( ) : string
Résultat	string	the label for this status. .

getTransitions() public méthode

See also: raoul2000\workflow\base\StatusInterface::getTransitions()

public getTransitions ( )

getWorkflow() public méthode

See also: raoul2000\workflow\base\StatusInterface::getWorkflow()

public getWorkflow ( )

getWorkflowId() public méthode

public getWorkflowId ( ) : string
Résultat	string	the id of the workflow this status belongs to.

isInitialStatus() public méthode

See also: raoul2000\workflow\base\StatusInterface::isInitialStatus()

public isInitialStatus ( )