yii2-workflow Class Reference
  • Namespace
  • Class

Namespaces

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

Classes

  • SimpleWorkflowBehavior
  • Status
  • StatusIdConverter
  • Transition
  • Workflow
  • WorkflowBaseObject
  • WorkflowException
  • WorkflowValidationException

Interfaces

  • IStatusAccessor
  • IStatusIdConverter
  • StatusInterface
  • TransitionInterface
  • WorkflowInterface

Class Workflow

Implements the Workflow as an object having an $id and an initialStatus. The Workflow class inherits from WorkflowBaseObject that provides support for metadata attributes and workflow source access.

yii\base\Object
Extended by raoul2000\workflow\base\WorkflowBaseObject
Extended by raoul2000\workflow\base\Workflow implements raoul2000\workflow\base\WorkflowInterface
Namespace: raoul2000\workflow\base
See: raoul2000\workflow\base\WorkflowBaseObject
Located at base/Workflow.php

Methods summary

public
# __construct( array $config = [] )

Workflow constructor.

Workflow constructor.

Parameters

$config

Throws

yii\base\InvalidConfigException

Overrides

raoul2000\workflow\base\WorkflowBaseObject::__construct
public string
# getId( )

Returns

string
the object identifier

See

raoul2000\workflow\base\WorkflowBaseObject::getId()

Implementation of

raoul2000\workflow\base\WorkflowInterface::getId()
public string
# getInitialStatusId( )

Returns

string
status id

See

raoul2000\workflow\base\WorkflowInterface::getInitialStatusId()

Implementation of

raoul2000\workflow\base\WorkflowInterface::getInitialStatusId()
public raoul2000\workflow\base\StatusInterface
# getInitialStatus( )

Returns

raoul2000\workflow\base\StatusInterface
the initial status instance

Throws

raoul2000\workflow\base\WorkflowException
when no source component is available

See

raoul2000\workflow\base\WorkflowInterface::getInitialStatus()

Implementation of

raoul2000\workflow\base\WorkflowInterface::getInitialStatus()
public raoul2000\workflow\base\StatusInterface[]
# getAllStatuses( )

Returns

raoul2000\workflow\base\StatusInterface[]
status list belonging to this workflow

Throws

raoul2000\workflow\base\WorkflowException
when no source component is available

See

raoul2000\workflow\base\WorkflowInterface::getAllStatuses()

Implementation of

raoul2000\workflow\base\WorkflowInterface::getAllStatuses()

Methods inherited from raoul2000\workflow\base\WorkflowBaseObject

__get(), getMetadata(), getSource(), hasMetadata()

Constants summary

string PARAM_INITIAL_STATUS_ID
# 'initialStatusId'
yii2-workflow Class Reference API documentation generated by ApiGen