zxin/ think-workflow
将 Symfony Workflow 组件集成到 Thinkphp。
Requires
- php: ^8.0|^8.1|^8.2
- symfony/event-dispatcher-contracts: ^3.0
- symfony/process: ^6.0
- symfony/workflow: ^6.0
- topthink/framework: ~6.1.2
Requires (Dev)
- fakerphp/faker: ^1.13|^1.9.1
- mockery/mockery: ^1.2
- orchestra/testbench: ^6.0|^7.0|^8.0
- php-cs-fixer/shim: ^3.14
- phpunit/phpunit: ^9.0
- symfony/var-dumper: ^6.0
This package is auto-updated.
Last update: 2024-09-16 11:18:09 UTC
README
⚠️ 寻找维护帮助!
我已经好几年没有在实际项目中使用这个包了。由于它主要是一个 Symfony 组件的适配器,所以维护量相对较小。随着项目越来越多,我越来越难抽出时间来维护这个项目,因此我正在寻找帮助来维护它,或者在合适的条件下,完全接管这个包。
这是从 brexis/laravel-workflow 分支出来的。我对这个包的需求比其他包更前沿,因此我非常感谢 brexis 对原始工作和改编所做的工作。
在 Laravel 中使用 Symfony Workflow 组件
安装
composer require zerodahero/laravel-workflow
Laravel 支持
从 v3 升级到 v4
此次更改涉及 PHP 和 Laravel 版本,本版本只支持 PHP 8.0、8.1 和 Laravel 9。如果您需要使用旧版本,请从版本 3.4 开始。
从 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' => [ ... ZeroDaHero\LaravelWorkflow\WorkflowServiceProvider::class, ]
将 Workflow
门面添加到您的 facades 数组中
<?php ... 'Workflow' => ZeroDaHero\LaravelWorkflow\Facades\WorkflowFacade::class,
配置
发布配置文件
php artisan vendor:publish --provider="ZeroDaHero\LaravelWorkflow\WorkflowServiceProvider"
在 config/workflow.php
中配置您的流程
<?php // 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' ] ], ] ];
更简洁的设置(适用于 eloquent 模型的工作流)。
<?php // 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' ] ], ] ];
如果您使用的是 "multiple_state" 类型的流程(即您将在工作流中同时处于多个位置),您需要将支持类/Eloquent 模型的标记转换为数组。更多信息请参阅 Laravel 文档。
您还可以添加元数据,类似于 Symfony 实现(注意:它不是以与 Symfony 相同的方式收集的,但应该可以正常工作。如果情况不是这样,请提出 pull request 或 issue。)
<?php return [ 'straight' => [ 'type' => 'workflow', // or 'state_machine' 'metadata' => [ 'title' => 'Blog Publishing Workflow', ], '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 ZeroDaHero\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');
使用事件
此包提供了一系列在转换期间触发的事件
ZeroDaHero\LaravelWorkflow\Events\Guard ZeroDaHero\LaravelWorkflow\Events\Leave ZeroDaHero\LaravelWorkflow\Events\Transition ZeroDaHero\LaravelWorkflow\Events\Enter ZeroDaHero\LaravelWorkflow\Events\Entered
鼓励您使用 Symfony的事件发射点语法风格,因为这提供了对事件监听的最高精度,并防止接收到多个相同的事件类。工作流组件在每个工作流事件上触发多个事件,如果仅通过类名监听,则将导致“重复”事件。
注意:这些事件在版本3.1.1之前接收Symfony事件,从版本3.1.1开始接收此包的事件
<?php 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' ); } }
您也可以以更典型的Laravel风格订阅事件,尽管这不再被推荐,因为根据您如何监听事件,可能会导致“重复”事件。
<?php 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' ); } }
工作流与状态机
当使用多状态工作流时,有必要区分多个地方可以转换到同一个地方的情况,或者一个主题在精确的两个地方转换到同一个地方的情况。由于配置是PHP数组,您必须将后者的情况“嵌套”到数组中,这样就可以使用地点数组构建转换,而不是通过单个地点进行循环。
示例1. 精确两个地方转换到同一个地方
在这个示例中,草稿必须同时处于 content_approved
和 legal_approved
状态。
<?php return [ 'straight' => [ 'type' => 'workflow', 'metadata' => [ 'title' => 'Blog Publishing Workflow', ], 'marking_store' => [ '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' => [ '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
如果您希望输出到根目录以外的目录,可以使用--disk
和--path
选项设置存储磁盘(默认为local
)和路径(默认为root_path()
)。
php artisan workflow:dump workflow-name --class=App\\BlogPost --disk=s3 --path="workflows/diagrams/"
使用跟踪模式
如果您通过某种动态方式(可能是通过数据库)加载工作流定义,您可能希望启用注册跟踪。这将使您能够看到已加载的内容,以防止或忽略重复的工作流定义。
在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' => [ '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' ] ], ];