PHP Интерфейс Finite\StateMachine\StateMachineInterface

Автор: Yohan Giarelli ([email protected])
Показать файл Открыть проект Примеры использования интерфейса

Открытые методы

Метод Описание
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 )

Описание методов

addState() публичный Метод

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

addTransition() публичный Метод

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() публичный Метод

Apply a transition.
public apply ( string $transitionName, array $parameters = [] ) : mixed
$transitionName string
$parameters array
Результат mixed

can() публичный Метод

Returns if the transition is applicable.
public can ( string | Finite\Transition\TransitionInterface $transition, array $parameters = [] ) : boolean
$transition string | Finite\Transition\TransitionInterface
$parameters array
Результат boolean

findStateWithProperty() публичный Метод

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
Результат boolean

getCurrentState() публичный Метод

public getCurrentState ( ) : Finite\State\StateInterface
Результат Finite\State\StateInterface

getDispatcher() публичный Метод

public getDispatcher ( ) : Symfony\Component\EventDispatcher\EventDispatcherInterface
Результат Symfony\Component\EventDispatcher\EventDispatcherInterface

getGraph() публичный Метод

public getGraph ( ) : string
Результат string

getObject() публичный Метод

public getObject ( ) : object
Результат object

getState() публичный Метод

public getState ( string $name ) : Finite\State\StateInterface
$name string
Результат Finite\State\StateInterface

getStates() публичный Метод

Returns an array containing all the states names.
public getStates ( ) : array
Результат array

getTransition() публичный Метод

Returns a transition by its name.
public getTransition ( string $name ) : Finite\Transition\TransitionInterface
$name string
Результат Finite\Transition\TransitionInterface

getTransitions() публичный Метод

Returns an array containing all the transitions names.
public getTransitions ( ) : array
Результат array

hasStateAccessor() публичный Метод

public hasStateAccessor ( ) : boolean
Результат boolean

initialize() публичный Метод

Initialize the State Machine current state.
public initialize ( )

setGraph() публичный Метод

public setGraph ( string $graph )
$graph string

setObject() публичный Метод

public setObject ( object $object )
$object object

setStateAccessor() публичный Метод

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