Przejdź do treści

Szablony workflow

Wyświetl jako Markdown Edytuj w GitHub Dokumentacja: 2cc7b2b

Szablony workflow pozwalają raz zdefiniować strukturę kroków workflow i uruchamiać ją wielokrotnie według nazwy. Przydaje się to, gdy ten sam wieloetapowy proces trzeba uruchomić z różnymi danymi.

Definiowanie szablonu

Użyj Queuety::define_workflow(), aby utworzyć szablon, a następnie go zarejestruj:

PHP
use Queuety\Queuety;
use Queuety\Enums\Priority;

$builder = Queuety::define_workflow( 'onboarding' )
    ->on_queue( 'pipelines' )
    ->with_priority( Priority::Normal )
    ->max_attempts( 5 )
    ->then( CreateAccountHandler::class )
    ->then( SendWelcomeEmailHandler::class )
    ->then( NotifyAdminHandler::class );

Queuety::register_workflow_template( $builder );

Rejestruj szablony wcześniej, na przykład w hooku inicjalizacyjnym wtyczki:

PHP
add_action( 'init', function () {
    $builder = Queuety::define_workflow( 'onboarding' )
        ->then( CreateAccountHandler::class )
        ->then( SendWelcomeEmailHandler::class )
        ->then( NotifyAdminHandler::class );

    Queuety::register_workflow_template( $builder );
} );

Uruchamianie szablonu

Uruchom zarejestrowany szablon według nazwy za pomocą Queuety::run_workflow():

PHP
$workflow_id = Queuety::run_workflow( 'onboarding', [ 'email' => 'user@example.com' ] );

Drugi argument to początkowe dane lub stan, podobnie jak ->dispatch() w konstruktorze. Zwrócona liczba całkowita to identyfikator workflow.

Jeśli szablon nie jest zarejestrowany, zostaje zgłoszony wyjątek RuntimeException.

Wyświetlanie zarejestrowanych szablonów

Uzyskaj dostęp do rejestru szablonów:

PHP
$registry = Queuety::workflow_templates();
$template = $registry->get( 'onboarding' ); // WorkflowTemplate or null

Pełny przykład

PHP
// Register templates on init.
add_action( 'init', function () {
    // User onboarding pipeline
    $onboarding = Queuety::define_workflow( 'onboarding' )
        ->on_queue( 'users' )
        ->then( CreateAccountHandler::class )
        ->then( SetupDefaultsHandler::class )
        ->then( SendWelcomeEmailHandler::class );
    Queuety::register_workflow_template( $onboarding );

    // Content generation pipeline
    $content = Queuety::define_workflow( 'generate_content' )
        ->on_queue( 'llm' )
        ->max_attempts( 5 )
        ->then( BuildPromptHandler::class )
        ->then( CallLLMHandler::class )
        ->then( ReviewOutputHandler::class )
        ->then( PublishHandler::class );
    Queuety::register_workflow_template( $content );
} );

// Dispatch them anywhere in your application.
$wf1 = Queuety::run_workflow( 'onboarding', [ 'email' => 'alice@example.com' ] );
$wf2 = Queuety::run_workflow( 'generate_content', [ 'topic' => 'WordPress performance' ] );

Szablony a workflow inline

Workflow inline Szablon
Definicja W chwili uruchomienia Raz, podczas rejestracji
Uruchamianie Queuety::workflow('name')->then(...)->dispatch() Queuety::run_workflow('name', $payload)
Ponowne użycie Buduj ciąg za każdym razem Zarejestruj raz, uruchamiaj wielokrotnie
Najlepsze zastosowanie Jednorazowe lub dynamicznie składane workflow Standardowe, powtarzalne procesy