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

Interface WorkflowInterface

Interface implemented by Workflow objects.

Direct known implementers

raoul2000\workflow\base\Workflow

Namespace: raoul2000\workflow\base
Located at base/WorkflowInterface.php

Methods summary

public string
# getId( )

Returns the id of this workflow

Returns the id of this workflow

Returns

string
the workflow id
public string
# getInitialStatusId( )

Returns the id of the initial status for this workflow.

Returns the id of the initial status for this workflow.

Returns

string
status id
public raoul2000\workflow\base\StatusInterface
# getInitialStatus( )

Returns the initial status instance for this workflow.

Returns the initial status instance for this workflow.

Returns

raoul2000\workflow\base\StatusInterface
the initial status instance

Throws

raoul2000\workflow\base\WorkflowException
when no source component is available
public raoul2000\workflow\base\StatusInterface[]
# getAllStatuses( )

Returns an array containing all Status instances belonging to this workflow.

Returns an array containing all Status instances belonging to this workflow.

Returns

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

Throws

raoul2000\workflow\base\WorkflowException
when no source component is available
yii2-workflow Class Reference API documentation generated by ApiGen