Download the PHP package xiaobudongzhang/state-machine without Composer
On this page you can find all versions of the php package xiaobudongzhang/state-machine. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download xiaobudongzhang/state-machine
More information about xiaobudongzhang/state-machine
Files in xiaobudongzhang/state-machine
Package state-machine
Short Description A very lightweight yet powerful PHP state machine
License MIT
Homepage https://github.com/xiaobudongzhang/StateMachine
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package state-machine
A very lightweight yet powerful PHP state machine
Define your states, define your transitions and your callbacks: we do the rest. The era of hard-coded states is over!
Installation (via composer)
Usage
Configure a state machine graph
In order to use the state machine, you first need to define a graph. A graph is a definition of states, transitions and optionnally callbacks ; all attached on an object from your domain. Multiple graphes can be attached to the same object.
Let's define a graph called myGraphA for our DomainObject object:
So, in the previous example, the graph has 6 possible states, and those can be achieved by applying some transitions to the object. For example, when creating a new DomainObject, you would apply the 'create' transition to the object, and after that the state of it would become pending.
Using the state machine
Definitions
The state machine is the object actually manipulating your object. By using the state machine you can test if a transition can be applied, actually apply a transition, retrieve the current state, etc. A state machine is specific to a couple object + graph. It means that if you want to manipulate another object, or the same object with another graph, you need another state machine.
The factory helps you to get the state machine for these couples object + graph. You give an object and a graph name to it, and it will return you the state machine for this couple. If you want to have this factory as a service in your Symfony2 application, please see the corresponding StateMachineBundle.
Usage
Please refer to the several examples in the examples folder.
Callbacks
Callbacks are used to guard transitions or execute some code before or after applying transitions.
Guarding callbacks must return a bool. If a guard returns false, a transition cannot be performed.
Credits
This library has been highly inspired by https://github.com/yohang/Finite, but has taken another direction.
All versions of state-machine with dependencies
symfony/event-dispatcher Version ^4.3|^5.0
symfony/property-access Version ^4.3|^5.0
symfony/expression-language Version ^4.3|^5.0