Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/raoul2000/yii2-workflow
A simple workflow engine for Yii2
https://github.com/raoul2000/yii2-workflow
php status transition workflow yii2 yii2-extension
Last synced: 8 days ago
JSON representation
A simple workflow engine for Yii2
- Host: GitHub
- URL: https://github.com/raoul2000/yii2-workflow
- Owner: raoul2000
- License: bsd-3-clause
- Created: 2015-02-24T20:50:35.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-06-08T11:52:36.000Z (over 6 years ago)
- Last Synced: 2024-10-30T01:51:36.712Z (21 days ago)
- Topics: php, status, transition, workflow, yii2, yii2-extension
- Language: PHP
- Size: 2.11 MB
- Stars: 171
- Watchers: 22
- Forks: 48
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGE.md
- License: LICENSE.md
Awesome Lists containing this project
README
# yii2-workflow
[](https://travis-ci.org/raoul2000/yii2-workflow)
[](https://packagist.org/packages/raoul2000/yii2-workflow)
[](https://packagist.org/packages/raoul2000/yii2-workflow)
[](https://packagist.org/packages/raoul2000/yii2-workflow)
## Installation
The preferred way to install this extension is through [composer](http://getcomposer.org/download/).
Either run
```
php composer.phar require --prefer-dist raoul2000/yii2-workflow "*"
```
or add
```
"raoul2000/yii2-workflow": "*"
```
to the require section of your `composer.json` file.
# Quick Start
## Configuration
For this "*Quick start Guide*" we will be using **default configuration settings**, but remember that *yii2-workflow* is designed to be highly
flexible so to adapt to a lot of execution contexts... well at least that was my goal.
## Create A Workflow
A workflow is defined as a PHP class that implements the `\raoul2000\workflow\source\file\IWorkflowDefinitionProvider` interface. which
declares the *getDefinition()* method. This method must return an array representing the workflow definition.
Let's define a very *simple workflow* that will be used to manage posts in a basic blog system.
Here is the PHP class that implements the definition for our workflow :
`@app/models/PostWorkflow.php`
```php
namespace app\models;
class PostWorkflow implements \raoul2000\workflow\source\file\IWorkflowDefinitionProvider
{
public function getDefinition() {
return [
'initialStatusId' => 'draft',
'status' => [
'draft' => [
'transition' => ['publish','deleted']
],
'publish' => [
'transition' => ['draft','deleted']
],
'deleted' => [
'transition' => ['draft']
]
]
];
}
}
```
## Attach To The Model
Now let's have a look to our Post model: we store the status of a post in a column named `status` of type STRING(40).
The last step is to associate the workflow definition with posts models. To do so we must declare the *SimpleWorkflowBehavior* behavior
in the Post model class and let the default configuration settings do the rest.
`@app/models/Post.php`
```php
namespace app\models;
/**
* @property integer $id
* @property string $title
* @property string $body
* @property string $status column used to store the status of the post
*/
class Post extends \yii\db\ActiveRecord
{
public function behaviors()
{
return [
\raoul2000\workflow\base\SimpleWorkflowBehavior::className()
];
}
// ...
```
That's it ! We are ready to play with *SimpleWorkflowBehavior*.
## Use It !
Now that we are all setup, we can use the *SimpleWorkflowBehavior* methods to set/get the status of our posts : the *SimpleWorkflowBehavior* will
take care that the post doesn't reach a status where it is not supposed to go to, depending on the workflow definition that we have provided.
```php
$post = new Post();
$post->status = 'draft';
$post->save();
echo 'post status is : '. $post->workflowStatus->label;
```
This will print the following message :
post status is : Draft
If you do the same thing but instead of *draft* set the status to *publish* and try to save it, the following exception is thrown :
Not an initial status : PostWorkflow/publish ("PostWorkflow/draft" expected)
That's because in your workflow definition the **initial status** is set to *draft* and not *publish*.
Ok, one more example for the fun ! This time we are not going to perform the transition when the Post is saved (like we did in the previous
example), but immediately, by invoking the `sendToStatus` method. Our Post is going to try to reach status *publish* passing through *deleted*
which is strictly forbidden by the workflow. Will it be successful in this risky attempt to break workflow rules ?
```php
$post = new Post();
$post->sendToStatus('draft');
$post->sendToStatus('deleted');
$post->sendToStatus('publish'); // danger zone !
```
Game Over ! There is no transition between *deleted* and *publish*, and that's what *SimpleWorkflow* tries to explain to our
fearless post object.
Workflow Exception – raoul2000\workflow\base\WorkflowException
No transition found between status PostWorkflow/deleted and PostWorkflow/publish
Yes, that's severe, but there was many ways to avoid this exception like for instance by first validating that the transition was possible.
## What's Next ?
This is just one way of using the *SimpleWorkflowBehavior* but there's much more and hopefully enough to assist you in workflow management inside your Yii2 web app.
You will find additional information there :
- [yii2-workflow Usage Guide](http://raoul2000.github.io/yii2-workflow/)
- [yii2-workflow Class Reference](http://raoul2000.github.io/yii2-workflow/class-ref/)
- [Demo](http://raoul2000.ass-team.fr/index.php?r=workflow/status-history/update) : a simple example based on the *Post* use case.
You may also be interested in the following projects developed around yii2-workflow :
- [yii2-workflow-view](https://github.com/raoul2000/yii2-workflow-view) : A Widget to display workflows ([demo](http://raoul2000.ass-team.fr/index.php?r=workflow/status-history/update))
- [yii2-workflow-manager](https://github.com/cornernote/yii2-workflow-manager) : A Module to manage workflows
- [yii2-wizflow](https://github.com/raoul2000/yii2-wizflow) : a proof of concept that mixes the Wizard UI pattern with workflow ([Demo](http://raoul2000.ass-team.fr/index.php?r=workflow/wizflow/init))
- ..and more to come
License
-------
**yii2-workflow** is released under the BSD 3-Clause License. See the bundled `LICENSE.md` for details.
[](http://www.yiiframework.com/)