• Главная
• izzum
• statemachine
• State

PHP Класс izzum\statemachine\State

A State instance can (and should) be shared by multiple Transition objects when it is the same State for their origin/from State. A State can be a regex state (or negated regex). A regex state can be used in a transition and when added to a statemachine the regular expression will be matched on all currently known states on that statemachine and new Transitions will be added to the statemachine that match the from/to state regexes. This is very useful to build a lot of transitions very quickly. to build a full mesh of transitions (all states to all states): $a = new State('a'); $b = new State('b'); $c = new State('c'); $machine->addState($a); $machine->addState($b); $machine->addState($c); $state_regex_all = new State('regex:|.*|'); $machine->addTransition(new Transition($state_regex_all, $state_regex_all)); Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство	Тип	Описание
$callable_entry	callable	the entry callable method
$callable_exit	callable	the exit callable method
$command_entry_name	string	This can actually be a ',' seperated string of multiple commands that will be executed as a composite.
$command_exit_name	string	This can actually be a ',' seperated string of multiple commands that will be executed as a composite.
$description	string	a description for the state
$name	string	The name of the state
$transitions	Transition[]	These will be set by Transition objects (they provide the association) this is not a hashmap, so the order of Transitions *might* be important. whenever a State is asked for it's transitions, the first transition might be tried first. this might have performance and configuration benefits
$type	string	The state type: - State::TYPE_INITIAL - State::TYPE_NORMAL - State::TYPE_FINAL - State::TYPE_REGEX

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

Метод	Описание
__construct ( string $name, string $type = self::TYPE_NORMAL, $command_entry_name = self::COMMAND_EMPTY, $command_exit_name = self::COMMAND_EMPTY, callable $callable_entry = self::CALLABLE_NULL, callable $callable_exit = self::CALLABLE_NULL )
__toString ( ) : string
addTransition ( Transition $transition ) : boolan	add an outgoing transition from this state.
entryAction ( Context $context )	An action executed every time a state is entered.
exitAction ( Context $context )	An action executed every time a state is exited.
getDescription ( ) : string	get the description for this state (if any)
getEntryCallable ( ) : callable	get the entry callable, the callable to be called when entering this state
getEntryCommandName ( ) : string	get the fully qualified command name for entry of the state
getExitCallable ( ) : callable	get the exit callable, the callable to be called when exiting this state
getExitCommandName ( ) : string	get the fully qualified command name for exit of the state
getName ( )	gets the name of this state
getTransitions ( ) : Transition[]	get all outgoing transitions
getTransitionsTriggeredByEvent ( string $event ) : Transition[]	get the transition for this state that can be triggered by an event code.
getType ( ) : string	get the state type
hasTransition ( string $transition_name ) : boolean	Do we have a transition from this state with a certain name?
isFinal ( ) : boolean	is it a final state
isInitial ( ) : boolean	is it an initial state
isNegatedRegex ( ) : boolean	is this state a negated regex type of state? "not-regex:"
isNormal ( ) : boolean	is it a normal state
isNormalRegex ( ) : boolean	is this state a normal regex type of state? "regex:"
isRegex ( ) : boolean	is this state a regex type of state? formats: "regex:" "not-regex:"
setDescription ( string $description )	set the description of the state (for uml generation for example)
setEntryCallable ( callable $callable )	set the entry callable, the callable to be called when entering this state
setEntryCommandName ( string $name )	set the entry command name
setExitCallable ( callable $callable )	set the exit callable, the callable to be called when exiting this state
setExitCommandName ( string $name )	set the exit command name

Защищенные методы

Метод	Описание
callCallable ( callable $callable, Context $context, string $type = 'n/a' )	calls a $callable if it exists, with the arguments $context->getEntity()
execute ( izzum\command\ICommand $command )	helper method
getCommand ( string $command_name, Context $context ) : izzum\command\ICommand	returns the associated Command for the entry/exit action.
setName ( string $name )	sets the name of this state
setType ( string $type )	set the state type

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

Описание свойств