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 PhpArrayLoader

Loads a workflow definition from a PHP file. The PHP filename is built by concatenating the $path and the $workflowId values, adding the '.php' extension.

This file must return the workflow definition in the form of an associative array having the appropriate structure depending on the configured parser.

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

Methods summary

public array
# loadDefinition( string $workflowId, raoul2000\workflow\source\file\WorkflowFileSource $source )

Loads and returns the workflow definition available as a PHP array in a file. If a parser has been configured, it is used to converte the array structure defined in the file, into the format expected by the WorkflowFileSource class.

Loads and returns the workflow definition available as a PHP array in a file. If a parser has been configured, it is used to converte the array structure defined in the file, into the format expected by the WorkflowFileSource class.

Parameters

$workflowId
$source

Returns

array
the workflow definition

Throws

WorkflowException
public string
# createFilename( string $workflowId )

Creates and returns the absolute filename of the PHP file that contains the workflow definition to load.

Creates and returns the absolute filename of the PHP file that contains the workflow definition to load.

Parameters

$workflowId

Returns

string
the absolute file path of the workflow definition file

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

getParser(), init(), parse()

Properties summary

public string $path

path where the php file to load is located

path where the php 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