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 StatusInterface

This interface must be implemented by Status objects.

Direct known implementers

raoul2000\workflow\base\Status

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

Methods summary

public string
# getId( )

Returns the id of this status.

Returns the id of this status.

Returns

string
the id for this status
public string
# getLabel( )

Returns the label for this status.

Returns the label for this status.

Returns

string
the label for this status. .
public string
# getWorkflowId( )

Returns

string
the id of the workflow this status belongs to.
public raoul2000\workflow\base\Transition[]
# getTransitions( )

Returns the list of Transitions instances leaving this status.

Returns the list of Transitions instances leaving this status.

The array returned is indexed by the canonical id of the end status. Note that an empty array can be returned if this status has no out-going transition (i.e. no other status can be reached).

Returns

raoul2000\workflow\base\Transition[]
the list of out-going transitions for this status.
public raoul2000\workflow\base\Workflow
# getWorkflow( )

Returns the workflow instance this status belongs to

Returns the workflow instance this status belongs to

Returns

raoul2000\workflow\base\Workflow
the workflow instance
public boolean
# isInitialStatus( )

Test is this status is the initial status of the parent workflow

Test is this status is the initial status of the parent workflow

Returns

boolean
TRUE if this status is the initial status of its parent workflow, FALSE otherwise
yii2-workflow Class Reference API documentation generated by ApiGen