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 DefaultArrayParser

Implements a parser for default PHP array formatted workflow.

Example :

[
  'initialStatusId' => 'draft',
  'status' => [
      'draft'     => [
          'label'      => 'Draft State'
          'transition' => 'published'
      ],
      'published' => [
          'transition' => ['draft','published']
      ],
      'archived'
  ]
]
yii\base\Object
Extended by raoul2000\workflow\source\file\WorkflowArrayParser
Extended by raoul2000\workflow\source\file\DefaultArrayParser
Namespace: raoul2000\workflow\source\file
Located at source/file/DefaultArrayParser.php

Methods summary

public array
# parse( string $wId, array $definition, raoul2000\workflow\source\file\WorkflowFileSource $source )

Parse a workflow defined as a PHP Array.

Parse a workflow defined as a PHP Array.

The workflow definition passed as argument is turned into an array that can be used by the WorkflowFileSource components.

Parameters

$wId
$definition
$source

Returns

array
The parse workflow array definition

Throws

raoul2000\workflow\base\WorkflowValidationException

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

validate()

Properties summary

public boolean $validate

when TRUE, the parse method will also perform some validations

when TRUE, the parse method will also perform some validations

# true
yii2-workflow Class Reference API documentation generated by ApiGen