Skip to content

feat: ability to use callable as action #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Fishdrowned wants to merge 2 commits into
base: master
Choose a base branch
from
Open

feat: ability to use callable as action #1

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1679686
feat: ability to use callable as action
Fishdrowned Oct 11, 2019
544a7db
feat: ability to use callable as action
Fishdrowned Oct 11, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 26 additions & 14 deletions src/StateMachine.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ class StateMachine
* StateMachine constructor.
* @param array $transitions
*
* $transitions example:
* $transitions example for a deterministic finite state machine:
* https://en.wikipedia.org/wiki/Deterministic_finite_automaton
* [
* 'State1' => [
* 'action1' => 'State1',
Expand All @@ -38,20 +39,22 @@ class StateMachine
* ],
* ]
*
* You may use Closure to do real actions in the target state:
* $transitions example for a nondeterministic finite state machine:
* https://en.wikipedia.org/wiki/Nondeterministic_finite_automaton
* You may use a `Closure` or a `callable array` to perform checks before transitioning, e.g.:
* [
* 'State1' => [
* 'action1' => 'State1',
* 'action2' => 'State1',
* 'locked' => [
* 'push' => 'locked',
* // use callable array:
* 'coin' => [Turnstile::class, 'insertCoin'],
* ],
* 'State2' => [
* 'action3' => function ($stateMachine) {
* // Do something here
* return 'State3';
* 'unlocked' => [
* // use closure:
* 'push' => function ($stateMachine) {
* Turnstile::useCoin();
* return Turnstile::hasCoin() ? 'unlocked' : 'locked';
* },
* ],
* 'State3' => [
* 'action4' => 'State1',
* 'coin' => [$turnstile, 'insertCoin'],
* ],
* ]
* @param array|null $history
Expand Down Expand Up @@ -98,8 +101,17 @@ public function doAction($action, &$payload = null)
Exception::INVALID_ACTION
);
}
if (($state = $this->transitions[$this->currentState][$action]) instanceof Closure) {
$state = $state($this, $payload);
$state = $this->transitions[$this->currentState][$action];
if (!is_string($state)) {
if (is_callable($state)) {
$state = call_user_func($state, $this, $payload);
}
}
if (!is_string($state) || !isset($this->transitions[$state])) {
throw new Exception(
sprintf('Invalid action "%s" for current state "%s"', $action, $this->currentState),
Exception::INVALID_ACTION
);
}
$this->previousState = $this->currentState;
$this->currentState = $state;
Expand Down