Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yohang/Finite
A Simple PHP Finite State Machine
https://github.com/yohang/Finite
Last synced: 10 days ago
JSON representation
A Simple PHP Finite State Machine
- Host: GitHub
- URL: https://github.com/yohang/Finite
- Owner: yohang
- License: mit
- Created: 2012-09-27T21:26:13.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2024-07-25T12:02:58.000Z (4 months ago)
- Last Synced: 2024-10-29T10:58:34.339Z (15 days ago)
- Language: PHP
- Homepage: http://yohan.giarel.li/Finite
- Size: 586 KB
- Stars: 1,308
- Watchers: 58
- Forks: 188
- Open Issues: 61
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Finite, A Simple PHP Finite State Machine
=========================================
Finite is a Simple State Machine, written in PHP. It can manage any Stateful object by defining states and transitions between these states.
[](https://travis-ci.org/yohang/Finite)
[](https://packagist.org/packages/yohang/finite)
[](https://packagist.org/packages/yohang/finite)
[](https://packagist.org/packages/yohang/finite)
[](https://scrutinizer-ci.com/g/yohang/Finite/)
[](https://scrutinizer-ci.com/g/yohang/Finite/)
[](https://insight.sensiolabs.com/projects/394f3a8e-e6c5-4102-8979-d389db2d0293)
[](https://www.versioneye.com/php/yohang:finite/1.0.3)
[](https://www.versioneye.com/php/yohang:finite/references)
[](https://gitter.im/yohang/Finite?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
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)](http://finite.readthedocs.org/en/master/)
Getting started
---------------
### Installation (via composer)
```js
{
"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.
```php
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
```php
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');
```