PHP Class izzum\statemachine\loader\JSON

The json string can contain one or more machine definitions. The correct machine will be found from the json structure. This class provides a way to load json from a file on your file system (fast access) and is also used by the Redis adapter to load a json string from a redis server. The format of the data to be loaded is specified via a json-schema. The schema can be retrieved via JSON::getJSONSchema() and the schema itself and a full example of the data can be found in 'assets/json'

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

See link: for validating according to a json-schema (useful for building your own)

See link: https://php.net/manual/en/function.json-decode.php

See link: https://php.net/manual/en/function.file-get-contents.php

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 $json )
__toString ( )
createFromFile ( string $filename ) : JSON	creates an instance of this class with the data loaded from a file.
getJSON ( )
getJSONSchema ( ) : string	gets the json schema used for the datastructure of the statemachine definitions
load ( StateMachine $stateMachine )	{@inheritDoc}
toString ( )

Method Details

__construct() public method

public __construct ( string $json )
$json	string	optional a valid json string according to the schema

__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 ) : JSON
$filename	string	eg: __DIR__ . '/../../configuration.json'
return	JSON	an instance of JSON with the data read from the file

getJSON() public method

public getJSON ( )

getJSONSchema() public method

gets the json schema used for the datastructure of the statemachine definitions

public getJSONSchema ( ) : string
return	string

load() public method

{@inheritDoc}

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

toString() public method

public toString ( )