yii2-workflow Class Reference
  • Namespace
  • Class

Namespaces

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

Classes

  • BasicEventSequence
  • ExtendedEventSequence
  • ReducedEventSequence
  • WorkflowEvent

Interfaces

  • IEventSequence

Class ExtendedEventSequence

This event sequence provider include additional generic events to each sequence.

For example, when entering into a workflow, the generic event EnterWorkflow() is added to the sequence allowing the developer to create a handler invoked each time a model enters into a workflow.

yii\base\Object
Extended by raoul2000\workflow\events\ExtendedEventSequence implements raoul2000\workflow\events\IEventSequence
Namespace: raoul2000\workflow\events
See: raoul2000\workflow\events\IEventSequence
Located at events/ExtendedEventSequence.php

Methods summary

public array
# createEnterWorkflowSequence( raoul2000\workflow\base\StatusInterface $initalStatus, yii\base\Object $sender )

Produces the following event sequence when a model enters a workflow.

Produces the following event sequence when a model enters a workflow.

  • beforeEnterWorkflow(*)
  • beforeEnterWorkflow(WID)
  • beforeEnterStatus(*)
  • beforeEnterStatus(ID)

  • afterEnterWorkflow(*)

  • afterEnterWorkflow(WID)
  • afterEnterStatus(*)
  • afterEnterStatus(ID)

Where WID is the workflow Id and ID is the status Id.

Parameters

$initalStatus
the status used to enter into the workflow (the initial status)
$sender

Returns

array

See

raoul2000\workflow\events\IEventSequence::createEnterWorkflowSequence()

Implementation of

raoul2000\workflow\events\IEventSequence::createEnterWorkflowSequence()
public array
# createLeaveWorkflowSequence( raoul2000\workflow\base\StatusInterface $finalStatus, yii\base\Object $sender )

Produces the following event sequence when a model leaves a workflow.

Produces the following event sequence when a model leaves a workflow.

  • beforeLeaveStatus(*)
  • beforeLeaveStatus(ID)
  • beforeLeaveWorkflow(*)
  • beforeLeaveWorkflow(WID)

  • afterLeaveStatus(*)

  • afterLeaveStatus(ID)
  • afterLeaveWorkflow(*)
  • afterLeaveWorkflow(WID)

Parameters

$finalStatus

the status that the model last visited in the workflow it is leaving (the final status)

$sender

Returns

array

See

raoul2000\workflow\events\IEventSequence::createLeaveWorkflowSequence()

Implementation of

raoul2000\workflow\events\IEventSequence::createLeaveWorkflowSequence()
public array
# createChangeStatusSequence( raoul2000\workflow\base\TransitionInterface $transition, yii\base\Object $sender )

Produces the following event sequence when a model changes from status A to status B.

Produces the following event sequence when a model changes from status A to status B.

  • beforeLeaveStatus(*)
  • beforeLeaveStatus(A)
  • beforeChangeStatusFrom(A)to(B)
  • beforeEnterStatus(*)
  • beforeEnterStatus(B)

  • afterLeaveStatus(*)

  • afterLeaveStatus(A)
  • afterChangeStatusFrom(A)to(B)
  • afterEnterStatus(*)
  • afterEnterStatus(B)

Parameters

$transition

the transition representing the status change

$sender

Returns

array

See

raoul2000\workflow\events\IEventSequence::createChangeStatusSequence()

Implementation of

raoul2000\workflow\events\IEventSequence::createChangeStatusSequence()
yii2-workflow Class Reference API documentation generated by ApiGen