Laravel workflow

Installation

composer require brexis/laravel-workflow

For laravel <= 5.4

<?php'providers' => [    ...Brexis\LaravelWorkflow\WorkflowServiceProvider::class,]

<?php...'Workflow' =>Brexis\LaravelWorkflow\Facades\WorkflowFacade::class,

Configuration

    php artisan vendor:publish --provider="Brexis\LaravelWorkflow\WorkflowServiceProvider"

<?phpreturn ['straight'   => ['type'          =>'workflow',// or 'state_machine''marking_store' => ['type'      =>'multiple_state','arguments' => ['currentPlace']        ],'supports'      => ['App\BlogPost'],'places'        => ['draft','review','rejected','published'],'transitions'   => ['to_review' => ['from' =>'draft','to'   =>'review'            ],'publish' => ['from' =>'review','to'   =>'published'            ],'reject' => ['from' =>'review','to'   =>'rejected'            ]        ],    ]];

<?phpnamespaceApp;useIlluminate\Database\Eloquent\Model;useBrexis\LaravelWorkflow\Traits\WorkflowTrait;class BlogPostextends Model{use WorkflowTrait;}

Usage

<?phpuseApp\BlogPost;useWorkflow;$post = BlogPost::find(1);$workflow = Workflow::get($post);// if more than one workflow is defined for the BlogPost class$workflow = Workflow::get($post,$workflowName);$workflow->can($post,'publish');// False$workflow->can($post,'to_review');// True$transitions =$workflow->getEnabledTransitions($post);// Apply a transition$workflow->apply($post,'to_review');$post->save();// Don't forget to persist the state// Using the WorkflowTrait$post->workflow_can('publish');// True$post->workflow_can('to_review');// False// Get the post transitionsforeach ($post->workflow_transitions()as$transition) {echo$transition->getName();}// if more than one workflow is defined for the BlogPost classforeach ($post->workflow_transitions($workflowName)as$transition) {echo$transition->getName();}// Apply a transition$post->workflow_apply('publish');$post->save();

Use the events

Brexis\LaravelWorkflow\Events\GuardBrexis\LaravelWorkflow\Events\LeaveBrexis\LaravelWorkflow\Events\Transition    Brexis\LaravelWorkflow\Events\EnterBrexis\LaravelWorkflow\Events\Entered

<?phpnamespaceApp\Listeners;useBrexis\LaravelWorkflow\Events\GuardEvent;class BlogPostWorkflowSubscriber{/**     * Handle workflow guard events.     */publicfunctiononGuard(GuardEvent$event) {/** Symfony\Component\Workflow\Event\GuardEvent */$originalEvent =$event->getOriginalEvent();/** @var App\BlogPost $post */$post =$originalEvent->getSubject();$title =$post->title;if (empty($title)) {// Posts with no title should not be allowed$originalEvent->setBlocked(true);        }    }/**     * Handle workflow leave event.     */publicfunctiononLeave($event) {}/**     * Handle workflow transition event.     */publicfunctiononTransition($event) {}/**     * Handle workflow enter event.     */publicfunctiononEnter($event) {}/**     * Handle workflow entered event.     */publicfunctiononEntered($event) {}/**     * Register the listeners for the subscriber.     *     * @param  Illuminate\Events\Dispatcher  $events     */publicfunctionsubscribe($events)    {$events->listen('Brexis\LaravelWorkflow\Events\GuardEvent','App\Listeners\BlogPostWorkflowSubscriber@onGuard'        );$events->listen('Brexis\LaravelWorkflow\Events\LeaveEvent','App\Listeners\BlogPostWorkflowSubscriber@onLeave'        );$events->listen('Brexis\LaravelWorkflow\Events\TransitionEvent','App\Listeners\BlogPostWorkflowSubscriber@onTransition'        );$events->listen('Brexis\LaravelWorkflow\Events\EnterEvent','App\Listeners\BlogPostWorkflowSubscriber@onEnter'        );$events->listen('Brexis\LaravelWorkflow\Events\EnteredEvent','App\Listeners\BlogPostWorkflowSubscriber@onEntered'        );    }}

Dump Workflows

php artisan workflow:dump workflow_name --class App\\BlogPost

php artisan workflow:dump workflow_name --format=jpg