jezzis / finite
A simple PHP5.3+ Finite State Machine
1.1.3
2019-11-22 07:14 UTC
Requires
- php: >=5.5
- symfony/event-dispatcher: ^2.6|^3.0|^4.0
- symfony/options-resolver: ^2.6|^3.0|^4.0
- symfony/property-access: ^2.6|^3.0|^4.0
Requires (Dev)
- phpunit/phpunit: ^4.0
- pimple/pimple: ^1.0
- symfony/dependency-injection: ^2.6|^3.0|^4.0
- symfony/framework-bundle: ^2.6|^3.0|^4.0
- symfony/security: ^2.6|^3.0|^4.0
- twig/twig: ^1.13
Suggests
- pimple/pimple: Needed for use with PimpleFactory
- symfony/security: Needed for using SecurityAwareStateMachine
- symfony/yaml: Yaml allows you to define your State graph in YAML
This package is not auto-updated.
Last update: 2024-11-17 06:08:21 UTC
README
Finite is a Simple State Machine, written in PHP. It can manage any Stateful object by defining states and transitions between these states.
Features
- Managing State/Transition graph for an object
- Defining and retrieving properties for states
- Event Listenable transitions
- Symfony2 integration
- Custom state graph loaders
- Twig Extension
Documentation
Documentation for master (1.1)
Getting started
Installation (via composer)
{ "require": { "yohang/finite": "~1.1" } }
Version note :
If your are using this library in a Symfony project, 1.1 version is only compatible with Symfony >=2.6
.
1.0 is compatible with Symfony >=2.3, <2.6
.
Define your Stateful Object
Your stateful object just need to implement the StatefulInterface
Interface.
use Finite\StatefulInterface; class Document implements StatefulInterface { private $state; public function setFiniteState($state) { $this->state = $state; } public function getFiniteState() { return $this->state; } }
Initializing a simple StateMachine
use Finite\StateMachine\StateMachine; use Finite\State\State; use Finite\State\StateInterface; // $document = retrieve your stateful object $sm = new StateMachine(); // Define states $sm->addState(new State('s1', StateInterface::TYPE_INITIAL)); $sm->addState('s2'); $sm->addState('s3'); $sm->addState(new State('s4', StateInterface::TYPE_FINAL)); // Define transitions $sm->addTransition('t12', 's1', 's2'); $sm->addTransition('t23', 's2', 's3'); $sm->addTransition('t34', 's3', 's4'); $sm->addTransition('t42', 's4', 's2'); // Initialize $sm->setObject($document); $sm->initialize(); // Retrieve current state $sm->getCurrentState(); // Can we process a transition ? $sm->can('t34');