通过以下方式搜索 
adiletmaks / laravel-workflow
将 Symfony Workflow 组件集成到 Laravel 中。
v3.2.3
2021-01-26 12:40 UTC
Requires
- php: >=7.2
- illuminate/console: ^7.1|^8.0
- illuminate/contracts: ^7.1|^8.0
- illuminate/support: ^7.1|^8.0
- symfony/event-dispatcher: ^5.0
- symfony/process: ^5.0
- symfony/workflow: ^5.0
Requires (Dev)
- fzaninotto/faker: ^1.9
- mockery/mockery: ^1.2
- orchestra/testbench: ^5.2|^6.0
- phpunit/phpunit: ^8.0
- symfony/var-dumper: ^5.0
README
这是从 brexis/laravel-workflow 分支出来的。我对这个包的需求似乎比其他包更容易维护。向 brexis 为其原始工作和在此包上的改进致敬。
在 Laravel 中使用 Symfony Workflow 组件
安装
composer require adlietmaks/laravel-workflow
Laravel 支持
从 v2 升级到 v3
从 v2 到 v3 的最大变化是依赖关系。为了匹配 Symfony v5 组件，Laravel 版本提升到 v7。如果您使用的是 Laravel v6 或更早版本，应继续使用此包的 v2 版本。
为了匹配 Symfony v5 工作流组件的变化，"arguments" 配置选项已更改为 "property"。这描述了与工作流绑定的模型上的属性（在大多数情况下，您只需将 "arguments" 键名更改为 "property"，并设置为字符串而不是之前的数组）。
此外，"initial_place" 键已更改为 "initial_places"，以与 Symfony 组件保持一致。
非包发现
如果您不使用包发现
在 config/app.php 中的 providers 数组中添加 ServiceProvider
<?php 'providers' => [ ... Adiletmaks\LaravelWorkflow\WorkflowServiceProvider::class, ]
将 Workflow facade 添加到您的 facades 数组中
<?php ... 'Workflow' => Adiletmaks\LaravelWorkflow\Facades\WorkflowFacade::class,
配置
发布配置文件
php artisan vendor:publish --provider="Adiletmaks\LaravelWorkflow\WorkflowServiceProvider"
在 config/workflow.php 中配置您的流程
<?php return [ 'straight' => [ 'type' => 'workflow', // or 'state_machine' 'marking_store' => [ 'type' => 'multiple_state', // or 'single_state' 'property' => 'currentPlace', // this is the property on the model 'class' => MethodMarkingStore::class, // you may omit for default, or set to override marking store class ], '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' ] ], ] ];
如果您使用的是 "multiple_state" 类型的 marking_store（即您将在工作流中的多个地方同时存在），则需要您的支持类/Eloquent 模型将标记转换为数组。更多内容请参阅 Laravel 文档。
您还可以添加元数据，类似于 Symfony 的实现（注意：它不是以与 Symfony 的相同方式收集的，但应该可以正常工作。如果这不正确，请提交 pull request 或 issue。）
<?php return [ 'straight' => [ 'type' => 'workflow', // or 'state_machine' 'metadata' => [ 'title' => 'Blog Publishing Workflow', ], 'marking_store' => [ 'type' => 'multiple_state', // or 'single_state' 'property' => 'currentPlace' // this is the property on the model ], 'supports' => ['App\BlogPost'], 'places' => [ 'draft' => [ 'metadata' => [ 'max_num_of_words' => 500, ] ] 'review', 'rejected', 'published' ], 'transitions' => [ 'to_review' => [ 'from' => 'draft', 'to' => 'review', 'metadata' => [ 'priority' => 0.5, ] ], 'publish' => [ 'from' => 'review', 'to' => 'published' ], 'reject' => [ 'from' => 'review', 'to' => 'rejected' ] ], ] ];
在支持类中使用 WorkflowTrait
<?php namespace App; use Illuminate\Database\Eloquent\Model; use Adiletmaks\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); // 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();
Symfony Workflow 使用
一旦有了底层的 Symfony 工作流组件，您就可以像在 Symfony 中一样做任何事情。下面提供了一些示例，但请务必查阅 Symfony 文档 以更好地了解这里的情况。
<?php 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');
使用事件
此包提供在转换过程中触发的事件列表
Adiletmaks\LaravelWorkflow\Events\Guard Adiletmaks\LaravelWorkflow\Events\Leave Adiletmaks\LaravelWorkflow\Events\Transition Adiletmaks\LaravelWorkflow\Events\Enter Adiletmaks\LaravelWorkflow\Events\Entered
您也可以订阅事件
<?php namespace App\Listeners; use Adiletmaks\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( 'Adiletmaks\LaravelWorkflow\Events\GuardEvent', 'App\Listeners\BlogPostWorkflowSubscriber@onGuard' ); $events->listen( 'Adiletmaks\LaravelWorkflow\Events\LeaveEvent', 'App\Listeners\BlogPostWorkflowSubscriber@onLeave' ); $events->listen( 'Adiletmaks\LaravelWorkflow\Events\TransitionEvent', 'App\Listeners\BlogPostWorkflowSubscriber@onTransition' ); $events->listen( 'Adiletmaks\LaravelWorkflow\Events\EnterEvent', 'App\Listeners\BlogPostWorkflowSubscriber@onEnter' ); $events->listen( 'Adiletmaks\LaravelWorkflow\Events\EnteredEvent', 'App\Listeners\BlogPostWorkflowSubscriber@onEntered' ); } }
您也可以使用 Symfony 的点语法事件发射方式。
注意：这些事件在版本 3.1.1 之前接收 Symfony 事件，从版本 3.1.1 开始接收此包的事件
<?php namespace App\Listeners; use Adiletmaks\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' ); } }
工作流与状态机
在多状态工作流中使用时，有必要区分一个可以转换到一个地方的多个地方数组，或者一个主题在确切的多处同时转换到一个地方的情况。由于配置是 PHP 数组，您必须将后者嵌套到数组中，以便使用地方数组构建转换，而不是循环遍历单个地方。
示例 1. 确切两个地方转换到一个
在这个例子中，草稿必须同时处于 content_approved 和 legal_approved。
<?php return [ 'straight' => [ 'type' => 'workflow', 'metadata' => [ 'title' => 'Blog Publishing Workflow', ], 'marking_store' => [ 'type' => 'multiple_state', 'property' => 'currentPlace' ], 'supports' => ['App\BlogPost'], 'places' => [ 'draft', 'content_review', 'content_approved', 'legal_review', 'legal_approved', 'published' ], 'transitions' => [ 'to_review' => [ 'from' => 'draft', 'to' => ['content_review', 'legal_review'], ], // ... transitions to "approved" states here 'publish' => [ 'from' => [ // note array in array ['content_review', 'legal_review'] ], 'to' => 'published' ], // ... ], ] ];
示例 2. 两个位置中的任意一个转换到另一个
在这个例子中，草稿可以从 content_approved 或 legal_approved 转换为 published
<?php return [ 'straight' => [ 'type' => 'workflow', 'metadata' => [ 'title' => 'Blog Publishing Workflow', ], 'marking_store' => [ 'type' => 'multiple_state', 'property' => 'currentPlace' ], 'supports' => ['App\BlogPost'], 'places' => [ 'draft', 'content_review', 'content_approved', 'legal_review', 'legal_approved', 'published' ], 'transitions' => [ 'to_review' => [ 'from' => 'draft', 'to' => ['content_review', 'legal_review'], ], // ... transitions to "approved" states here 'publish' => [ 'from' => [ 'content_review', 'legal_review' ], 'to' => 'published' ], // ... ], ] ];
导出工作流
Symfony 工作流使用 GraphvizDumper 创建工作流图像。你可能需要安装 Graphviz 的 dot 命令
php artisan workflow:dump workflow_name --class App\\BlogPost
你可以使用 --format 选项来更改图像格式。默认格式是 png。
php artisan workflow:dump workflow_name --format=jpg
用于跟踪模式
如果你是通过某种动态方式（可能通过数据库）加载工作流定义，你很可能需要开启注册跟踪。这将允许你查看已加载的内容，以防止或忽略重复的工作流定义。
在配置文件 workflow_registry.php 中将 track_loaded 设置为 true。
<?php 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, ];
你可以使用工作流注册的 addFromArray 方法动态加载一个工作流
<?php /** * 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 } }
注意：动态工作流没有持久性，此包假设你以某种方式存储它们（数据库等）。要使用动态工作流，你需要在使用之前加载工作流。上面的 loadWorkflow() 方法可以与模型 boot() 或类似的方法相关联。
如果你在工作流定义中指定了 initial_places，且它不是“位置”列表中的第一个位置。
<?php return [ 'type' => 'workflow', // or 'state_machine' 'metadata' => [ 'title' => 'Blog Publishing Workflow', ], 'marking_store' => [ 'type' => 'multiple_state', 'property' => 'currentPlace' ], 'supports' => ['App\BlogPost'], 'places' => [ 'review', 'rejected', 'published', 'draft', => [ 'metadata' => [ 'max_num_of_words' => 500, ] ] ], 'initial_places' => 'draft', // or set to an array if multiple initial places 'transitions' => [ 'to_review' => [ 'from' => 'draft', 'to' => 'review', 'metadata' => [ 'priority' => 0.5, ] ], 'publish' => [ 'from' => 'review', 'to' => 'published' ], 'reject' => [ 'from' => 'review', 'to' => 'rejected' ] ], ];