README

在 Laravel 中使用 Symfony Workflow 组件

安装

composer require toby1991/laravel-workflow

对于 laravel <= 5.4

将 ServiceProvider 添加到 config/app.php 中的 providers 数组

<?php

'providers' => [
    ...
    TobyYan\LaravelWorkflow\WorkflowServiceProvider::class,

]

将 Workflow 门面添加到您的 facades 数组

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

配置

发布配置文件

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

在 config/workflow.php 中配置您的 workflow

<?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'
                'metadata' => ['max' => 1],
            ],
            'publish' => [
                'from' => 'review',
                'to'   => 'published'
            ],
            'reject' => [
                'from' => 'review',
                'to'   => 'rejected'
            ]
        ],
    ]
];

在受支持的类中使用 WorkflowTrait

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;
use TobyYan\LaravelWorkflow\Traits\WorkflowTrait;

class BlogPost extends Model
{
  use WorkflowTrait;

}

用法

<?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();

使用事件

此包提供了一组在转换期间触发的事件

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

您可以订阅事件

<?php

namespace App\Listeners;

use TobyYan\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(
            'TobyYan\LaravelWorkflow\Events\GuardEvent',
            'App\Listeners\BlogPostWorkflowSubscriber@onGuard'
        );

        $events->listen(
            'TobyYan\LaravelWorkflow\Events\LeaveEvent',
            'App\Listeners\BlogPostWorkflowSubscriber@onLeave'
        );

        $events->listen(
            'TobyYan\LaravelWorkflow\Events\TransitionEvent',
            'App\Listeners\BlogPostWorkflowSubscriber@onTransition'
        );

        $events->listen(
            'TobyYan\LaravelWorkflow\Events\EnterEvent',
            'App\Listeners\BlogPostWorkflowSubscriber@onEnter'
        );

        $events->listen(
            'TobyYan\LaravelWorkflow\Events\EnteredEvent',
            'App\Listeners\BlogPostWorkflowSubscriber@onEntered'
        );
    }

}

导出 Workflows

Symfony workflow 使用 GraphvizDumper 来创建工作流程图像。您可能需要安装 Graphviz 的 dot 命令。

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

您可以使用 --format 选项更改图像格式。默认格式是 png。

php artisan workflow:dump workflow_name --format=jpg