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 Transition

Transition object is an oriented link between a start and an end status.

yii\base\Object
Extended by raoul2000\workflow\base\WorkflowBaseObject
Extended by raoul2000\workflow\base\Transition implements raoul2000\workflow\base\TransitionInterface
Namespace: raoul2000\workflow\base
Located at base/Transition.php

Methods summary

public
# __construct( array $config = [] )

Creates a Transition object.

Creates a Transition object.

To create a new Transition, you should provide following mandatory values in the configuration array $config :

  • start : the start Status instance
  • end : the end Status instance

Parameters

$config

Throws

yii\base\InvalidConfigException

See

raoul2000\workflow\base\Status

Overrides

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

Returns the id of this transition.

Returns the id of this transition.

The id is built by concatenating the start and the end status Ids, separated with character '-'. For instance, a transition between status A and B has an idea equals to "A-B".

Returns

string
the transition Id

See

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

Implementation of

raoul2000\workflow\base\TransitionInterface::getId()
public raoul2000\workflow\base\StatusInterface
# getEndStatus( )

Returns

raoul2000\workflow\base\StatusInterface
the Status instance this transition ends to

See

raoul2000\workflow\base\TransitionInterface::getEndStatus()

Implementation of

raoul2000\workflow\base\TransitionInterface::getEndStatus()
public raoul2000\workflow\base\StatusInterface
# getStartStatus( )

Returns

raoul2000\workflow\base\StatusInterface
the Status instance this transition starts from

See

raoul2000\workflow\base\TransitionInterface::getStartStatus()

Implementation of

raoul2000\workflow\base\TransitionInterface::getStartStatus()

Methods inherited from raoul2000\workflow\base\WorkflowBaseObject

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

yii2-workflow Class Reference API documentation generated by ApiGen