PHP Class Metabor\Statemachine\Util\SetupHelper

Author: Oliver Tischlinger

Show file Open project: metabor/statemachine Class Usage Examples

Protected Properties

Property	Type	Description
$stateCollection	MetaborStd\Statemachine\StateCollectionInterface

Public Methods

Method	Description
__construct ( MetaborStd\Statemachine\StateCollectionInterface $stateCollection )
addCommand ( $sourceStateName, string $eventName, SplObserver $command )	If there is no Transition from the SourceState with this Event use addCommandAndSelfTransition().
addCommandAndSelfTransition ( $sourceStateName, string $eventName, SplObserver $command )
createEvent ( MetaborStd\Statemachine\StateInterface $sourceState, string $eventName ) : MetaborStd\Event\EventInterface
createTransition ( MetaborStd\Statemachine\StateInterface $sourceState, MetaborStd\Statemachine\StateInterface $targetState, string $eventName = null, MetaborStd\Statemachine\ConditionInterface $condition = null ) : MetaborStd\Statemachine\TransitionInterface
findOrCreateEvent ( string $sourceStateName, string $eventName ) : MetaborStd\Event\EventInterface
findOrCreateState ( $name ) : MetaborStd\Statemachine\StateInterface
findOrCreateTransition ( string $sourceStateName, string $targetStateName, string $eventName = null, MetaborStd\Statemachine\ConditionInterface $condition = null ) : MetaborStd\Statemachine\TransitionInterface

Protected Methods

Method	Description
addTransition ( MetaborStd\Statemachine\StateInterface $sourceState, MetaborStd\Statemachine\TransitionInterface $sourceTransition )
createState ( string $name ) : MetaborStd\Statemachine\StateInterface
findTransition ( MetaborStd\Statemachine\StateInterface $sourceState, MetaborStd\Statemachine\StateInterface $targetState, string $eventName = null, MetaborStd\Statemachine\ConditionInterface $condition = null ) : MetaborStd\Statemachine\TransitionInterface

Method Details

__construct() public method

public __construct ( MetaborStd\Statemachine\StateCollectionInterface $stateCollection )
$stateCollection	MetaborStd\Statemachine\StateCollectionInterface

addCommand() public method

If there is no Transition from the SourceState with this Event use addCommandAndSelfTransition().

public addCommand ( $sourceStateName, string $eventName, SplObserver $command )
$sourceStateName
$eventName	string
$command	SplObserver

addCommandAndSelfTransition() public method

public addCommandAndSelfTransition ( $sourceStateName, string $eventName, SplObserver $command )
$sourceStateName
$eventName	string
$command	SplObserver

addTransition() protected method

protected addTransition ( MetaborStd\Statemachine\StateInterface $sourceState, MetaborStd\Statemachine\TransitionInterface $sourceTransition )
$sourceState	MetaborStd\Statemachine\StateInterface
$sourceTransition	MetaborStd\Statemachine\TransitionInterface

createEvent() public method

public createEvent ( MetaborStd\Statemachine\StateInterface $sourceState, string $eventName ) : MetaborStd\Event\EventInterface
$sourceState	MetaborStd\Statemachine\StateInterface
$eventName	string
return	MetaborStd\Event\EventInterface

createState() protected method

protected createState ( string $name ) : MetaborStd\Statemachine\StateInterface
$name	string
return	MetaborStd\Statemachine\StateInterface

createTransition() public method

public createTransition ( MetaborStd\Statemachine\StateInterface $sourceState, MetaborStd\Statemachine\StateInterface $targetState, string $eventName = null, MetaborStd\Statemachine\ConditionInterface $condition = null ) : MetaborStd\Statemachine\TransitionInterface
$sourceState	MetaborStd\Statemachine\StateInterface
$targetState	MetaborStd\Statemachine\StateInterface
$eventName	string
$condition	MetaborStd\Statemachine\ConditionInterface
return	MetaborStd\Statemachine\TransitionInterface

findOrCreateEvent() public method

public findOrCreateEvent ( string $sourceStateName, string $eventName ) : MetaborStd\Event\EventInterface
$sourceStateName	string
$eventName	string
return	MetaborStd\Event\EventInterface

findOrCreateState() public method

public findOrCreateState ( $name ) : MetaborStd\Statemachine\StateInterface
$name
return	MetaborStd\Statemachine\StateInterface

findOrCreateTransition() public method

public findOrCreateTransition ( string $sourceStateName, string $targetStateName, string $eventName = null, MetaborStd\Statemachine\ConditionInterface $condition = null ) : MetaborStd\Statemachine\TransitionInterface
$sourceStateName	string
$targetStateName	string
$eventName	string
$condition	MetaborStd\Statemachine\ConditionInterface
return	MetaborStd\Statemachine\TransitionInterface

findTransition() protected method

protected findTransition ( MetaborStd\Statemachine\StateInterface $sourceState, MetaborStd\Statemachine\StateInterface $targetState, string $eventName = null, MetaborStd\Statemachine\ConditionInterface $condition = null ) : MetaborStd\Statemachine\TransitionInterface
$sourceState	MetaborStd\Statemachine\StateInterface
$targetState	MetaborStd\Statemachine\StateInterface
$eventName	string
$condition	MetaborStd\Statemachine\ConditionInterface
return	MetaborStd\Statemachine\TransitionInterface

Property Details

$stateCollection protected property

protected StateCollectionInterface,MetaborStd\Statemachine $stateCollection
return	MetaborStd\Statemachine\StateCollectionInterface