PHP Class izzum\statemachine\loader\YAML

The yaml string can contain one or more machine definitions. The correct machine will be found from the yaml structure. This class provides a way to load yaml from a file on your file system (fast access). This class needs the php yaml module to operate, which can be found via php.net

See link: https://en.wikipedia.org/wiki/YAML

See link: https://php.net/manual/en/intro.yaml.php

See link: the needed yaml library

Author: Rolf Vreijdenberger

Inheritance: implements izzum\statemachine\loader\Loader

Show file Open project: rolfvreijdenberger/izzum-statemachine Class Usage Examples

Public Methods

Method	Description
__construct ( string $yaml )
__toString ( )
createFromFile ( string $filename ) : YAML	creates an instance of this class with the data loaded from a file.
getYAML ( )
load ( StateMachine $stateMachine )	{@inheritDoc}
toString ( )

Method Details

__construct() public method

public __construct ( string $yaml )
$yaml	string	optional a valid yaml string as specified in assets/yaml/example.yaml

__toString() public method

public __toString ( )

createFromFile() public static method

creates an instance of this class with the data loaded from a file.

public static createFromFile ( string $filename ) : YAML
$filename	string	eg: __DIR__ . '/../../configuration.yaml'
return	YAML	an instance of YAML with the data read from the file

getYAML() public method

public getYAML ( )

load() public method

{@inheritDoc}

public load ( StateMachine $stateMachine )
$stateMachine	izzum\statemachine\StateMachine

toString() public method

public toString ( )