PHP Class raoul2000\workflow\base\WorkflowBaseObject

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.
Inheritance: extends yii\base\Object
Afficher le fichier Open project: raoul2000/yii2-workflow Class Usage Examples

Méthodes publiques

Méthode Description
__construct ( array $config = [] ) Construct a workflow object.
__get ( $name )
getId ( ) : string
getMetadata ( string $paramName = null, mixed $defaultValue = null ) : mixed Returns the value of the metadata with namer $paramName.
getSource ( ) : raoul2000\workflow\source\IWorkflowSource Returns the source workflow component used to create this instance.
hasMetadata ( string $paramName ) : boolean Test if a metadata parameter is defined.

Method Details

__construct() public méthode

Construct a workflow object.
public __construct ( array $config = [] )
$config array

__get() public méthode

public __get ( $name )

getId() abstract public méthode

abstract public getId ( ) : string
Résultat string the object identifier

getMetadata() public méthode

If no $paramNameis provided, this method returns an array containing all metadata parameters.
public getMetadata ( string $paramName = null, mixed $defaultValue = null ) : mixed
$paramName string when null the method returns the complet metadata array, otherwise it returns the value of the correponding metadata.
$defaultValue mixed
Résultat mixed

getSource() public méthode

Returns the source workflow component used to create this instance.
public getSource ( ) : raoul2000\workflow\source\IWorkflowSource
Résultat raoul2000\workflow\source\IWorkflowSource the source instance or null if no source was been provided

hasMetadata() public méthode

Test if a metadata parameter is defined.
public hasMetadata ( string $paramName ) : boolean
$paramName string the metadata parameter name
Résultat boolean TRUE if the metadata parameter exists, FALSE otherwise