Download the PHP package jeroen-g/statinator without Composer
On this page you can find all versions of the php package jeroen-g/statinator. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package statinator
Statinator
Next-gen PHP state machines and state charts.
Installation
composer require jeroen-g/statinator
Usage
Imagine you want to create a state machine for a light switch in which the light can be in the state ON or OFF. A diagram would look as follows:
Source: statecharts.github.io
The Statinator configuration for this state machine would look like this:
Then in your application you should instantiate Statinator with this configuration.
The Statinator accepts a second parameter as a repository implementing the ActionRepositoryInterface
,
this (optionally) stores successful and failed actions.
Any object that you want to use with a state machine should implement the StatableInterface
contract.
For the example of the light switch this might be:
Anywhere in your code, you may use the Statinator instance to get a state machine and interact with its state and transitions.
While seeing objects move from one state to another is quite cool, the real power lies with the actions that you may define for transitions.
Before and after a state changes, the state machine executes any available actions. You can define actions as part of the global configuration, or by using a setter on the Statinator.
The actions can be a callable
or a class implementing ActionableInterface
.
`
If your action implements the ActionableInterface
it could be saved using a repository that is passed when you instantiated Statinator.
This package ships with an ArrayActionRepository
that is used by default and does not persist the data. Another possibility
is the LogActionRepository
, this one requires a PSR-compliant logger where the data will be persisted.
You can of course also make your own repository (maybe one that uses the database) as long as it implements the ActionRepositoryInterface
.
Contributing
The project includes a Makefile to run install it, run the tests and check the code style.