troojaan/laravel-state-machine

Winzou State Machine service provider for Laravel

Winzou State Machine service provider for Laravel

, _(*1)

This is a Laravel service provider for winzou/state-machine., _(*2)

Features

• It provides dependency injection for the StateMachineFactory., _(*3)

• You can use Laravel's service container to resolve class methods for the callbacks, along with their dependencies., _(*4)

• It allows you to listen for transition events using Laravel's event dispatcher., _(*5)

• A facade is also available for convenience., _(*6)

Installation

You can install the package via composer. This package requires Laravel 5.1 or higher., _(*7)

``` bash composer require troojaan/laravel-state-machine, <sub>(*8)</sub>

Since version 5.5, Laravel uses package auto-discovery, so you don't need to manually add the ServiceProvider and the facade. If you don't use auto-discovery or you are using an older version, add the service provider and the facade in config/app.php.

``` php
<?php

'providers' => [
    troojaan\SM\ServiceProvider::class,
],

'aliases' => [
    'StateMachine' => troojaan\SM\Facade::class,
],

Configuration

Publish the config file in config/state-machine.php., <sub>(*9)</sub>

``` bash php artisan vendor:publish --provider="troojaan\SM\ServiceProvider", <sub>(*10)</sub>

Please see the documentation of the [StateMachineBundle](https://github.com/winzou/StateMachineBundle) for all the available options.

## Usage

``` php
<?php

// Get the article
$article = App\Article::find($id);

// Get the state machine for this article, and graph called "simple"

// Using the facade
$stateMachine = StateMachine::get($article, 'simple');

// Or using the service container with dependency injection
public function method(SM\Factory\FactoryInterface $factory)
{
    $stateMachine = $factory->get($article, 'simple');
}

Now you can use the $stateMachine to interact with the state of the $article., <sub>(*11)</sub>

``` php <?php, <sub>(*12)</sub>

// Get the actual state of the object $stateMachine->getState();, <sub>(*13)</sub>

// Get all available transitions $stateMachine->getPossibleTransitions();, <sub>(*14)</sub>

// Check if a transition can be applied: returns true or false $stateMachine->can('approve');, <sub>(*15)</sub>

// Apply a transition $stateMachine->apply('publish');, <sub>(*16)</sub>

### Callbacks

Callbacks are used to guard transitions or execute some code before or after applying transitions.

This package adds the ability to resolve callbacks and inject their dependencies from Laravel's Service Container.

#### Defining a callback

Under the `callbacks.guard` array of your configuration, add an associative array to define the callback. The key of the array can be anything you want (e.g. `guard_on_submitting`). This array must have a clause, a callback, and may have some arguments.

##### Clause

First, you need to specify a clause that will determine when the callback will be invoked. A clause has a key (`from`, `to`, `on`, `excluded_from`, `excluded_to`, `excluded_on`) and its value is the state or the transition that should satisfy the clause. 

E.g. `'on' => 'submit_changes'` will be triggered when the transition `submit changes` is being checked or applied.

##### Callback

Second, you need to specify the callback that will be invoked under the `do` key. The callback must be a `callable`, and can be one of the following:

###### A closure:
```php
'do' => function () {
    // 
},

A built-in or user-defined function as a string:

`do` => 'abort',

A class method as array:

Classes are resolved through the service container with their dependencies., <sub>(*17)</sub>

'do' => ['MyService', 'handle'],

A class method as string:

`do` => 'MyService@handle',

Arguments

Using dependency injection

By default, if you don't specify the args key in your array, all the callback method parameters will be injected automatically using Laravel's service container, like Route/Controller methods., <sub>(*18)</sub>

Type-hints, <sub>(*19)</sub>

All type-hinted parameters are resolved from the container, e.g. App $app., <sub>(*20)</sub>

Object in the state machine, <sub>(*21)</sub>

If a parameter has the same type-hint as the object that is associated to the state machine, e.g. App\Article $article, the instance will be injected., <sub>(*22)</sub>

State machine event, <sub>(*23)</sub>

If a parameter has the state machine event type-hint, e.g. SM\Event\TransitionEvent $e, the event that was triggered in the state machine will be injected. Alternatively you can define a parameter named $event without a type-hint., <sub>(*24)</sub>

Using ExpressionLanguage notation

Otherwise, you can define one or multiple arguments that will be passed explicitly to your callbacks in the given order, by using the args key. This package is using Symfony's ExpressionLanguage notation to evaluate expressions., <sub>(*25)</sub>

Here are some examples:, <sub>(*26)</sub>

<?php

// The callback won't be passed any argument
'args' => [],

// You can pass strings and arrays as JSON-like strings.
'args' => ['"approved"', '["foo", "bar"]', '{"foo": "bar"}'],

// The callback will receive the object that is associated with the state machine,
// e.g. the `$article`.
'args' => ['object'],

// The callback will receive the `SM\Event\TransitionEvent` instance.
'args' => ['event'],

Example

You want to call the handle method on the MyService class to determine if the state machine can apply the submit_changes transition. The handle method will receive the object of the state machine as the first argument, and the transition event as the second argument., <sub>(*27)</sub>

<?php

'callbacks' => [
    // will be called when testing a transition
    'guard' => [
        'guard_on_submitting' => [
            // call the callback on a specific transition
            'on' => 'submit_changes',

            // will call the method of this class
            'do' => ['MyService', 'handle'],

            // arguments for the callback
            'args' => ['object', 'event'],
        ],
    ],
],

Events

When checking if a transition can be applied, the SM\Event\SMEvents::TEST_TRANSITION event is fired., <sub>(*28)</sub>

Before and after a transition is being applied, the SM\Event\SMEvents::PRE_TRANSITION and SM\Event\SMEvents::POST_TRANSITION events are fired respectively., <sub>(*29)</sub>

All the events receive an SM\Event\TransitionEvent instance., <sub>(*30)</sub>

If you wish to listen to all the events with the same listener, you can use the winzou.state_machine.* wildcard parameter., <sub>(*31)</sub>

You can define your own listeners in your app's EventServiceProvider. E.g.:, <sub>(*32)</sub>

<?php

use SM\Event\SMEvents;

/**
 * The event listener mappings for the application.
 *
 * @var array
 */
protected $listen = [
    SMEvents::TEST_TRANSITION => [
        \App\Listeners\CheckTransition::class,
    ],
    SMEvents::PRE_TRANSITION => [
        \App\Listeners\BeforeTransition::class,
    ],
    SMEvents::POST_TRANSITION => [
        \App\Listeners\AfterTransition::class,
    ],
    'winzou.state_machine.*' => [
        \App\Listeners\Transition::class,
    ],
];

Debug command

An artisan command for debugging graphs is included. It accepts the name of the graph as an argument. If no arguments are passed, the graph name will be asked interactively., <sub>(*33)</sub>

$ php artisan winzou:state-machine:debug simple

+--------------------+
| Configured States: |
+--------------------+
| new                |
| pending_review     |
| awaiting_changes   |
| accepted           |
| published          |
| rejected           |
+--------------------+
+-----------------+------------------+------------------+
| Transition      | From(s)          | To               |
+-----------------+------------------+------------------+
| create          | new              | pending_review   |
+-----------------+------------------+------------------+
| ask_for_changes | pending_review   | awaiting_changes |
|                 | accepted         |                  |
+-----------------+------------------+------------------+
| cancel_changes  | awaiting_changes | pending_review   |
+-----------------+------------------+------------------+
| submit_changes  | awaiting_changes | pending_review   |
+-----------------+------------------+------------------+
| approve         | pending_review   | accepted         |
|                 | rejected         |                  |
+-----------------+------------------+------------------+
| publish         | accepted         | published        |
+-----------------+------------------+------------------+

Changelog

Please see CHANGELOG for more information what has changed recently., <sub>(*34)</sub>

Testing

bash $ composer test, <sub>(*35)</sub>

Contributing

Please see CONTRIBUTING for details., <sub>(*36)</sub>

Security

If you discover any security related issues, please email Sébastien at info@sebdesign.eu instead of using the issue tracker., <sub>(*37)</sub>

Credits

• Alexandre Bacco
• Sébastien Nikolaou
• Ayman Terra

License

The MIT License (MIT). Please see License File for more information., <sub>(*38)</sub>