IMachineDefinitionReader Interface Reference

Description

Interface of state machine definition reader – converts external file to Smalldb machine definition.

Inheritance diagram for IMachineDefinitionReader

Static Public Member Functions
static	loadString ($machine_type, $data_string, $options=array(), $filename=null)
	Parse string and return fragment of state machine definition. More...
static	postprocessDefinition ($machine_type, &$machine_def, &$errors)
	If reader was invoked, it may need to postprocess the definition when everything is loaded (after last loadString call is completed). More...

Member Function Documentation

static loadString (   $machine_type,   $data_string,   $options = array(),   $filename = null  )

static

Parse string and return fragment of state machine definition.

Parameters

$machine_type	- Name of state machine (for better error messages)
$data_string	- Data to parse.
$options	- Additional options specified in master definition.
$filename	- Name of the file (or similar identifier) - only for debug messages.

Returns

array - Fragment of machine definition.

Implemented in BpmnReader, GraphMLReader, and JsonReader.

static postprocessDefinition (   $machine_type, &  $machine_def, &  $errors  )

static

If reader was invoked, it may need to postprocess the definition when everything is loaded (after last loadString call is completed).

Postprocessing is invoked only once, even when loadString has been invoked multiple times.

Parameters

$machine_type	- Name of state machine (for better error messages)
$machine_def	- Machine definition to be processed in place.
$errors	- List of errors in state machine definition. Errors may be specified in the diagram as well.

Returns

bool True when machine is successfully loaded, false otherwise.

Implemented in BpmnReader, GraphMLReader, and JsonReader.