Siirry sisältöön

Suorita työnkulkuja

Näytä Markdown-muodossa Muokkaa palvelussa GitHub Dokumentaatio: 2cc7b2b

Työnkulku voi käynnistää lapsityönkulun yhtenä vaiheistaan. Ylätyönkulku odottaa, kunnes alityönkulku valmistuu, ja yhdistää sitten alityönkulun lopputilan ylätyönkulun tilaan.

->run_workflow()-metodi

PHP
use Queuety\Queuety;

$enrichment = Queuety::workflow( 'enrich_user' )
    ->then( FetchSocialHandler::class )
    ->then( FetchCreditScoreHandler::class );

Queuety::workflow( 'onboarding' )
    ->then( CreateAccountHandler::class )
    ->run_workflow( 'enrich_user', $enrichment )
    ->then( SendWelcomeEmailHandler::class )
    ->dispatch( [ 'email' => 'user@example.com' ] );

run_workflow()-metodi ottaa kaksi argumenttia:

  1. Suorita työnkulku -toiminnon nimi
  2. WorkflowBuilder-instanssi, joka määrittää toiminnon vaiheet

Näin se toimii

Kun ylätyönkulku saavuttaa run_workflow-vaiheen:

  1. Suorita työnkulku -toiminto käynnistetään itsenäisenä työnkulkuna, jolla on oma tunnus
  2. Ylätyönkulku keskeytyy
  3. Suorita työnkulku -toiminto suorittaa vaiheensa tavalliseen tapaan
  4. Kun toiminto valmistuu, sen lopputila yhdistetään ylätyönkulun tilaan
  5. Ylätyönkulku jatkuu seuraavasta vaiheesta

Ylä- ja lapsityönkulun tila

Suorita työnkulku -toiminto saa alkuperäiseksi hyötykuormakseen ylätyönkulun siihen asti kertyneen nykyisen tilan. Näin lapsivaiheet voivat käyttää aiempien ylätyönkulun vaiheiden tuottamia tietoja:

PHP
class CreateAccountHandler implements Step {
    public function handle( array $state ): array {
        $user_id = wp_create_user( $state['email'], wp_generate_password() );
        return [ 'user_id' => $user_id ];
    }

    public function config(): array {
        return [];
    }
}

// This run-workflow step can access 'user_id' from the parent
class FetchSocialHandler implements Step {
    public function handle( array $state ): array {
        $profile = fetch_social_profile( $state['user_id'] );
        return [ 'social_data' => $profile ];
    }

    public function config(): array {
        return [];
    }
}

Tilan yhdistäminen

Kun Suorita työnkulku -toiminto valmistuu, sen lopputila (lukuun ottamatta sisäisiä avaimia, kuten _steps, _queue, _priority ja _max_attempts) yhdistetään ylätyönkulun tilaan. Seuraava ylätyönkulun vaihe näkee sekä ylätyönkulun aiempien vaiheiden että Suorita työnkulku -toiminnon tiedot:

PHP
class SendWelcomeEmailHandler implements Step {
    public function handle( array $state ): array {
        // Has access to:
        // - $state['email'] (from initial dispatch)
        // - $state['user_id'] (from CreateAccountHandler)
        // - $state['social_data'] (from run-workflow's FetchSocialHandler)
        // - $state['credit_score'] (from run-workflow's FetchCreditScoreHandler)

        send_welcome_email( $state['email'], $state['social_data'] );
        return [ 'welcome_sent' => true ];
    }

    public function config(): array {
        return [];
    }
}

Suorita työnkulku -toiminnon asetukset

Suorita työnkulku -rakentajan asetukset on_queue(), with_priority() ja max_attempts() koskevat lapsityönkulkua. Muita lapsirakentajan työnkulkutason asetuksia, kuten on_cancel(), prune_state_after(), must_complete_within(), version(), idempotency_key(), max_*()-budjetteja ja compensate_on_failure()-asetusta, ei siirretä eteenpäin:

PHP
$sub = Queuety::workflow( 'heavy_processing' )
    ->on_queue( 'background' )
    ->with_priority( Priority::Normal )
    ->max_attempts( 5 )
    ->then( StepA::class )
    ->then( StepB::class );

Queuety::workflow( 'parent' )
    ->run_workflow( 'heavy', $sub )
    ->then( FinalStep::class )
    ->dispatch( $payload );

Sisäkkäiset Suorita työnkulku -toiminnot

Suorita työnkulku -toiminnot voivat sisältää itsekin Suorita työnkulku -toimintoja, joten sisäkkäisyyttä voi olla rajattomasti:

PHP
$inner = Queuety::workflow( 'inner' )
    ->then( InnerStepA::class )
    ->then( InnerStepB::class );

$middle = Queuety::workflow( 'middle' )
    ->then( MiddleStepA::class )
    ->run_workflow( 'inner', $inner )
    ->then( MiddleStepB::class );

Queuety::workflow( 'outer' )
    ->then( OuterStepA::class )
    ->run_workflow( 'middle', $middle )
    ->then( OuterStepB::class )
    ->dispatch( $payload );