1. Go to this page and download the library: Download zerodahero/laravel-workflow library. Choose the download type require.
2. Extract the ZIP file and open the index.php.
3. Add this code to the index.php.
<?php
require_once('vendor/autoload.php');
/* Start to develop here. Best regards https://php-download.com/ */
// Full workflow, annotated.
return [
// Name of the workflow is the key
'straight' => [
'type' => 'workflow', // or 'state_machine', defaults to 'workflow' if omitted
// The marking store can be omitted, and will default to 'multiple_state'
// for workflow and 'single_state' for state_machine if the type is omitted
'marking_store' => [
'property' => 'marking', // this is the property on the model, defaults to 'marking'
'class' => MethodMarkingStore::class, // optional, uses EloquentMethodMarkingStore by default (for Eloquent models)
],
// optional top-level metadata
'metadata' => [
// any data
],
'supports' => ['App\BlogPost'], // objects this workflow supports
// Specifies events to dispatch (only in 'workflow', not 'state_machine')
// - set `null` to dispatch all events (default, if omitted)
// - set to empty array (`[]`) to dispatch no events
// - set to array of events to dispatch only specific events
// Note that announce will dispatch a guard event on the next transition
// (if announce isn't dispatched the next transition won't guard until checked/applied)
'events_to_dispatch' => [
Symfony\Component\Workflow\WorkflowEvents::ENTER,
Symfony\Component\Workflow\WorkflowEvents::LEAVE,
Symfony\Component\Workflow\WorkflowEvents::TRANSITION,
Symfony\Component\Workflow\WorkflowEvents::ENTERED,
Symfony\Component\Workflow\WorkflowEvents::COMPLETED,
Symfony\Component\Workflow\WorkflowEvents::ANNOUNCE,
],
'places' => ['draft', 'review', 'rejected', 'published'],
'initial_places' => ['draft'], // defaults to the first place if omitted
'transitions' => [
'to_review' => [
'from' => 'draft',
'to' => 'review',
// optional transition-level metadata
'metadata' => [
// any data
]
],
'publish' => [
'from' => 'review',
'to' => 'published'
],
'reject' => [
'from' => 'review',
'to' => 'rejected'
]
],
]
];
// Simple workflow. Sets type 'workflow', with a 'multiple_state' workflow
// on the 'marking' property of any 'App\BlogPost' model.
return [
'simple' => [
'supports' => ['App\BlogPost'], // objects this workflow supports
'places' => ['draft', 'review', 'rejected', 'published'],
'transitions' => [
'to_review' => [
'from' => 'draft',
'to' => 'review'
],
'publish' => [
'from' => 'review',
'to' => 'published'
],
'reject' => [
'from' => 'review',
'to' => 'rejected'
]
],
]
];
namespace App;
use Illuminate\Database\Eloquent\Model;
use ZeroDaHero\LaravelWorkflow\Traits\WorkflowTrait;
class BlogPost extends Model
{
use WorkflowTrait;
}
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);
// or get it directly from the trait
$workflow = $post->workflow_get();
// if more than one workflow is defined for the BlogPost class
$workflow = $post->workflow_get($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
// Get the workflow directly
// 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();
}
// Apply a transition
$post->workflow_apply('publish');
$post->save();
use App\Blogpost;
use Workflow;
$post = BlogPost::find(1);
$workflow = $post->workflow_get();
// Get the current places
$places = $workflow->getMarking($post)->getPlaces();
// Get the definition
$definition = $workflow->getDefinition();
// Get the metadata
$metadata = $workflow->getMetadataStore();
// or get a specific piece of metadata
$workflowMetadata = $workflow->getMetadataStore()->getWorkflowMetadata();
$placeMetadata = $workflow->getMetadataStore()->getPlaceMetadata($place); // string place name
$transitionMetadata = $workflow->getMetadataStore()->getTransitionMetadata($transition); // transition object
// or by key
$otherPlaceMetadata = $workflow->getMetadataStore()->getMetadata('max_num_of_words', 'draft');
namespace App\Listeners;
use ZeroDaHero\LaravelWorkflow\Events\GuardEvent;
class BlogPostWorkflowSubscriber
{
// ...
/**
* Register the listeners for the subscriber.
*
* @param Illuminate\Events\Dispatcher $events
*/
public function subscribe($events)
{
// can use any of the three formats:
// workflow.guard
// workflow.[workflow name].guard
// workflow.[workflow name].guard.[transition name]
$events->listen(
'workflow.straight.guard',
'App\Listeners\BlogPostWorkflowSubscriber@onGuard'
);
// workflow.leave
// workflow.[workflow name].leave
// workflow.[workflow name].leave.[place name]
$events->listen(
'workflow.straight.leave',
'App\Listeners\BlogPostWorkflowSubscriber@onLeave'
);
// workflow.transition
// workflow.[workflow name].transition
// workflow.[workflow name].transition.[transition name]
$events->listen(
'workflow.straight.transition',
'App\Listeners\BlogPostWorkflowSubscriber@onTransition'
);
// workflow.enter
// workflow.[workflow name].enter
// workflow.[workflow name].enter.[place name]
$events->listen(
'workflow.straight.enter',
'App\Listeners\BlogPostWorkflowSubscriber@onEnter'
);
// workflow.entered
// workflow.[workflow name].entered
// workflow.[workflow name].entered.[place name]
$events->listen(
'workflow.straight.entered',
'App\Listeners\BlogPostWorkflowSubscriber@onEntered'
);
// workflow.completed
// workflow.[workflow name].completed
// workflow.[workflow name].completed.[transition name]
$events->listen(
'workflow.straight.completed',
'App\Listeners\BlogPostWorkflowSubscriber@onCompleted'
);
// workflow.announce
// workflow.[workflow name].announce
// workflow.[workflow name].announce.[transition name]
$events->listen(
'workflow.straight.announce',
'App\Listeners\BlogPostWorkflowSubscriber@onAnnounce'
);
}
}
namespace App\Listeners;
use ZeroDaHero\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)
{
// The event can also proxy to the original event
$subject = $event->getSubject();
// is the same as:
$subject = $event->getOriginalEvent()->getSubject();
}
/**
* 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(
'ZeroDaHero\LaravelWorkflow\Events\GuardEvent',
'App\Listeners\BlogPostWorkflowSubscriber@onGuard'
);
$events->listen(
'ZeroDaHero\LaravelWorkflow\Events\LeaveEvent',
'App\Listeners\BlogPostWorkflowSubscriber@onLeave'
);
$events->listen(
'ZeroDaHero\LaravelWorkflow\Events\TransitionEvent',
'App\Listeners\BlogPostWorkflowSubscriber@onTransition'
);
$events->listen(
'ZeroDaHero\LaravelWorkflow\Events\EnterEvent',
'App\Listeners\BlogPostWorkflowSubscriber@onEnter'
);
$events->listen(
'ZeroDaHero\LaravelWorkflow\Events\EnteredEvent',
'App\Listeners\BlogPostWorkflowSubscriber@onEntered'
);
}
}
return [
/**
* When set to true, the registry will track the workflows that have been loaded.
* This is useful when you're loading from a DB, or just loading outside of the
* main config files.
*/
'track_loaded' => false,
/**
* Only used when track_loaded = true
*
* When set to true, a registering a duplicate workflow will be ignored (will not load the new definition)
* When set to false, a duplicate workflow will throw a DuplicateWorkflowException
*/
'ignore_duplicates' => false,
];
/**
* Load the workflow type definition into the registry
*/
protected function loadWorkflow()
{
$registry = app()->make('workflow');
$workflowName = 'straight';
$workflowDefinition = [
// Workflow definition here
// (same format as config/symfony docs)
// This should be the definition only,
// not including the key for the name.
// See note below on initial_places for an example.
];
$registry->addFromArray($workflowName, $workflowDefinition);
// or if catching duplicates
try {
$registry->addFromArray($workflowName, $workflowDefinition);
} catch (DuplicateWorkflowException $e) {
// already loaded
}
}