libSmalldb
v0.7-66-gb94d22a
|
Interface of state machine definition reader – converts external file to Smalldb machine definition.
Public Member Functions | |
isSupported (string $file_extension) | |
Return true if the file looks parsable by this reader. More... | |
loadString (string $machine_type, string $data_string, array $options=[], string $filename=null) | |
Parse string and return fragment of state machine definition. More... | |
postprocessDefinition (string $machine_type, array & $machine_def, array & $errors) | |
If reader was invoked, it may need to postprocess the definition when everything is loaded (after last loadString call is completed). More... | |
isSupported | ( | string | $file_extension | ) |
Return true if the file looks parsable by this reader.
string | $file_extension | File extension including leading dot (e.g. ".json") |
Implemented in BpmnReader, GraphMLReader, and JsonReader.
loadString | ( | string | $machine_type, |
string | $data_string, | ||
array | $options = [] , |
||
string | $filename = null |
||
) |
Parse string and return fragment of state machine definition.
string | $machine_type | Name of state machine (for better error messages) |
string | $data_string | Data to parse. |
array | $options | Additional options specified in master definition. |
string | $filename | Name of the file (or similar identifier) - only for debug messages. |
Implemented in BpmnReader, GraphMLReader, and JsonReader.
postprocessDefinition | ( | string | $machine_type, |
array & | $machine_def, | ||
array & | $errors | ||
) |
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.
string | $machine_type | Name of state machine (for better error messages) |
array | $machine_def | Machine definition to be processed in place. |
array | $errors | List of errors in state machine definition. Errors may be specified in the diagram as well. |
Implemented in BpmnReader, GraphMLReader, and JsonReader.