yii2-workflow Class Reference
  • Namespace
  • Class

Namespaces

  • raoul2000
    • workflow
      • actions
      • base
      • events
      • helpers
      • source
        • file
      • validation

Classes

  • DefaultArrayParser
  • GraphmlLoader
  • MinimalArrayParser
  • PhpArrayLoader
  • PhpClassLoader
  • WorkflowArrayParser
  • WorkflowDefinitionLoader
  • WorkflowFileSource

Interfaces

  • IWorkflowDefinitionProvider

Class GraphmlLoader

Parser for workflow definition stored as graphml file. graphml format is an XML language designed to describe an oriented graph structure. Before using this format to define a workflow, make sure you comply with requirements. (refer to the user guide)

yii\base\Object
Extended by raoul2000\workflow\source\file\WorkflowDefinitionLoader
Extended by raoul2000\workflow\source\file\GraphmlLoader
Namespace: raoul2000\workflow\source\file
Located at source/file/GraphmlLoader.php

Methods summary

public array
# loadDefinition( string $workflowId, IWorkflowSource $source )

Loads the definition of the workflow whose id is passed as argument.

Loads the definition of the workflow whose id is passed as argument.

Parameters

$workflowId
$source
the workflow source component

Returns

array
the workflow definition

Throws

raoul2000\workflow\base\WorkflowException
public string
# createFilename( string $workflowId )

creates and returns the filename where the workflow $workflowId is stored.

creates and returns the filename where the workflow $workflowId is stored.

The filename is built using the [[path]] property, the workflow id itself, and graphml extension.

Parameters

$workflowId
the workflow id

Returns

string
the filename
public
# convert( string $graphmlFile )

Convert a graphml file describing a workflow into an array suitable to create a workflow object.

Convert a graphml file describing a workflow into an array suitable to create a workflow object.

Parameters

$graphmlFile
the path to the graphml file to process

Methods inherited from raoul2000\workflow\source\file\WorkflowDefinitionLoader

getParser(), init(), parse()

Properties summary

public string $path

path where the graphml file to load is located

path where the graphml file to load is located

# '@app/models'

Properties inherited from raoul2000\workflow\source\file\WorkflowDefinitionLoader

$parser

yii2-workflow Class Reference API documentation generated by ApiGen