Laravel workflow Build Status

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"

<?php
return [
 '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'
 ]
 ],
 ]
];

<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
use Brexis\LaravelWorkflow\Traits\WorkflowTrait;
class BlogPost extends Model
{
 use WorkflowTrait;
}

Usage

<?php
use App\BlogPost;
use Workflow;
$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 transitions
foreach ($post->workflow_transitions() as $transition) {
 echo $transition->getName();
}
// if more than one workflow is defined for the BlogPost class
foreach ($post->workflow_transitions($workflowName) as $transition) {
 echo $transition->getName();
}
// Apply a transition
$post->workflow_apply('publish');
$post->save();

Use the events

 Brexis\LaravelWorkflow\Events\Guard
 Brexis\LaravelWorkflow\Events\Leave
 Brexis\LaravelWorkflow\Events\Transition
 Brexis\LaravelWorkflow\Events\Enter
 Brexis\LaravelWorkflow\Events\Entered

<?php
namespace App\Listeners;
use Brexis\LaravelWorkflow\Events\GuardEvent;
class BlogPostWorkflowSubscriber
{
 /**
 * Handle workflow guard events.
 */
 public function onGuard(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.
 */
 public function onLeave($event) {}
 /**
 * Handle workflow transition event.
 */
 public function onTransition($event) {}
 /**
 * Handle workflow enter event.
 */
 public function onEnter($event) {}
 /**
 * Handle workflow entered event.
 */
 public function onEntered($event) {}
 /**
 * Register the listeners for the subscriber.
 *
 * @param Illuminate\Events\Dispatcher $events
 */
 public function subscribe($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