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 PhpClassLoader

This class is responsible for locating and loading a workflow definition stored as a PHP class. The PHP class is expected to implement the IWorkflowDefinitionProvider interface.

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

Methods summary

public
# loadDefinition( string $workflowId, unknown $source )

Instanciate the PHP class to use as workflow definition provider, retrieve the workflow definition and parses it.

Instanciate the PHP class to use as workflow definition provider, retrieve the workflow definition and parses it.

Parameters

$workflowId
$source

Throws

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

Returns the complete name for the Workflow Provider class used to retrieve the definition of workflow $workflowId. The class name is built by appending the workflow id to the namespace parameter set for this source component.

Returns the complete name for the Workflow Provider class used to retrieve the definition of workflow $workflowId. The class name is built by appending the workflow id to the namespace parameter set for this source component.

Parameters

$workflowId
a workflow id

Returns

string
the full qualified class name used to provide definition for the workflow
public string
# getNameSpace( )

Returns the namespace value used to load the workflow definition provider class. If the alias with name self::NAMESPACE_ALIAS_NAME is found, it takes precedence over the configured namespace attribute.

Returns the namespace value used to load the workflow definition provider class. If the alias with name self::NAMESPACE_ALIAS_NAME is found, it takes precedence over the configured namespace attribute.

Returns

string
the namespace value

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

getParser(), init(), parse()

Constants summary

string NAMESPACE_ALIAS_NAME

yii2 alias name containing the namespace value to use to load definition provider class. If this alias is defined, it take precedence over the namespace configuration attribute.

yii2 alias name containing the namespace value to use to load definition provider class. If this alias is defined, it take precedence over the namespace configuration attribute.

# '@workflowDefinitionNamespace'

Properties summary

public string $namespace

namespace where workflow definition class are located

namespace where workflow definition class are located

# 'app\models'

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

$parser

yii2-workflow Class Reference API documentation generated by ApiGen