PHP Interface Finite\StateMachine\StateMachineInterface

Author: Yohan Giarelli ([email protected])
Afficher le fichier Open project: yohang/finite Interface Usage Examples

Méthodes publiques

Méthode Description
addState ( string | Finite\State\StateInterface $state )
addTransition ( string | Finite\Transition\TransitionInterface $transition, string | null $initialState = null, string | null $finalState = null )
apply ( string $transitionName, array $parameters = [] ) : mixed Apply a transition.
can ( string | Finite\Transition\TransitionInterface $transition, array $parameters = [] ) : boolean Returns if the transition is applicable.
findStateWithProperty ( string $property, mixed $value = null ) : boolean Find a state which have a given property, with an optional given value.
getCurrentState ( ) : Finite\State\StateInterface
getDispatcher ( ) : Symfony\Component\EventDispatcher\EventDispatcherInterface
getGraph ( ) : string
getObject ( ) : object
getState ( string $name ) : Finite\State\StateInterface
getStates ( ) : array Returns an array containing all the states names.
getTransition ( string $name ) : Finite\Transition\TransitionInterface Returns a transition by its name.
getTransitions ( ) : array Returns an array containing all the transitions names.
hasStateAccessor ( ) : boolean
initialize ( ) Initialize the State Machine current state.
setGraph ( string $graph )
setObject ( object $object )
setStateAccessor ( Finite\State\Accessor\StateAccessorInterface $stateAccessor )

Method Details

addState() public méthode

public addState ( string | Finite\State\StateInterface $state )
$state string | Finite\State\StateInterface

addTransition() public méthode

public addTransition ( string | Finite\Transition\TransitionInterface $transition, string | null $initialState = null, string | null $finalState = null )
$transition string | Finite\Transition\TransitionInterface
$initialState string | null
$finalState string | null

apply() public méthode

Apply a transition.
public apply ( string $transitionName, array $parameters = [] ) : mixed
$transitionName string
$parameters array
Résultat mixed

can() public méthode

Returns if the transition is applicable.
public can ( string | Finite\Transition\TransitionInterface $transition, array $parameters = [] ) : boolean
$transition string | Finite\Transition\TransitionInterface
$parameters array
Résultat boolean

findStateWithProperty() public méthode

It is useful for looking for objects having a given property in database for example.
public findStateWithProperty ( string $property, mixed $value = null ) : boolean
$property string
$value mixed
Résultat boolean

getCurrentState() public méthode

public getCurrentState ( ) : Finite\State\StateInterface
Résultat Finite\State\StateInterface

getDispatcher() public méthode

public getDispatcher ( ) : Symfony\Component\EventDispatcher\EventDispatcherInterface
Résultat Symfony\Component\EventDispatcher\EventDispatcherInterface

getGraph() public méthode

public getGraph ( ) : string
Résultat string

getObject() public méthode

public getObject ( ) : object
Résultat object

getState() public méthode

public getState ( string $name ) : Finite\State\StateInterface
$name string
Résultat Finite\State\StateInterface

getStates() public méthode

Returns an array containing all the states names.
public getStates ( ) : array
Résultat array

getTransition() public méthode

Returns a transition by its name.
public getTransition ( string $name ) : Finite\Transition\TransitionInterface
$name string
Résultat Finite\Transition\TransitionInterface

getTransitions() public méthode

Returns an array containing all the transitions names.
public getTransitions ( ) : array
Résultat array

hasStateAccessor() public méthode

public hasStateAccessor ( ) : boolean
Résultat boolean

initialize() public méthode

Initialize the State Machine current state.
public initialize ( )

setGraph() public méthode

public setGraph ( string $graph )
$graph string

setObject() public méthode

public setObject ( object $object )
$object object

setStateAccessor() public méthode

public setStateAccessor ( Finite\State\Accessor\StateAccessorInterface $stateAccessor )
$stateAccessor Finite\State\Accessor\StateAccessorInterface