yii2-workflow Class Reference
  • Namespace
  • Class

Namespaces

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

Classes

  • BasicEventSequence
  • ExtendedEventSequence
  • ReducedEventSequence
  • WorkflowEvent

Interfaces

  • IEventSequence

Class BasicEventSequence

The basic event sequence.

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

Methods summary

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

Produces the following sequence when a model enters a workflow :

Produces the following sequence when a model enters a workflow :

  • beforeEnterWorkflow(workflowID)
  • beforeEnterStatus(statusID)

  • afterEnterWorkflow(workflowID)

  • afterEnterStatus(statusID)

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 sequence when a model leaves a workflow :

Produces the following sequence when a model leaves a workflow :

  • beforeLeaveStatus(statusID)
  • beforeLeaveWorkflow(workflowID)

  • afterLeaveStatus(statusID)

  • afterLeaveWorkflow(workflowID)

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 sequence when a model changes from status A to status B:

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

  • beforeLeaveStatus(A)
  • beforeChangeStatus(A,B)
  • beforeEnterStatus(B)

  • afterLeaveStatus(A)

  • afterChangeStatus(A,B)
  • 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