Overview

Namespaces

  • Mothership
    • Exception
      • StateMachine
    • StateMachine

Classes

  • StateMachineAbstract
  • Status
  • Transition
  • WorkflowAbstract

Interfaces

  • StateMachineInterface
  • StatusInterface
  • TransitionInterface
  • WorkflowInterface
  • Overview
  • Namespace
  • Class

Class WorkflowAbstract

Mothership\StateMachine\WorkflowAbstract implements Mothership\StateMachine\WorkflowInterface
Abstract
Namespace: Mothership\StateMachine
Located at Mothership/StateMachine/WorkflowAbstract.php
Methods summary
public
# __construct( Symfony\Component\Console\Output\OutputInterface $output, array $args = [] )
public Symfony\Component\Console\Output\OutputInterface
# getOutput( )

Get the output for the workflow

Get the output for the workflow

Returns

Symfony\Component\Console\Output\OutputInterface
protected
# _init( )

Throws

Mothership\Exception\StateMachine\WorkflowException
public Mothership\StateMachine\StatusInterface
# setInitialState( )

Returns

Mothership\StateMachine\StatusInterface

Throws

Mothership\Exception\StateMachine\WorkflowException

Implementation of

Mothership\StateMachine\WorkflowInterface::setInitialState()
protected mixed|
# executeTransition( $transiction_name )

Parameters

$transiction_name

Returns

mixed|

Throws

Mothership\Exception\StateMachine\WorkflowException
public Mothership\StateMachine\StatusInterface
# getCurrentStatus( )

Return the current status of the workflow

Return the current status of the workflow

Returns

Mothership\StateMachine\StatusInterface
$status

Implementation of

Mothership\StateMachine\WorkflowInterface::getCurrentStatus()
public mixed
# setState( Mothership\StateMachine\StatusInterface $status )

Set the status of the workflow

Set the status of the workflow

Parameters

$status

Returns

mixed

Implementation of

Mothership\StateMachine\WorkflowInterface::setState()
public Mothership\StateMachine\StatusInterface
# getStatus( $name )

Get the status of the workflow by its name

Get the status of the workflow by its name

Parameters

$name

Returns

Mothership\StateMachine\StatusInterface
WorkflowException

Throws

Mothership\Exception\StateMachine\WorkflowException

Implementation of

Mothership\StateMachine\WorkflowInterface::getStatus()
public mixed
# run( )

execute the workflow

execute the workflow

Returns

mixed

Implementation of

Mothership\StateMachine\WorkflowInterface::run()
Properties summary
protected $outpout
#
protected array $vars

Usefull variables for the object passed throw workflow configuration file

Usefull variables for the object passed throw workflow configuration file

# []
protected StatusInterface; $states
# []
protected Mothership\StateMachine\StatusInterface $current_status
#
API documentation generated by ApiGen