laravel / 8 / api / 8.x / illuminate / foundation / bus / dispatchable.html

Dispatchable

trait Dispatchable (View source)

Methods

static PendingDispatch dispatch(...$arguments)

Dispatch the job with the given arguments.

static PendingDispatch|Fluent dispatchIf(bool $boolean, mixed ...$arguments)

Dispatch the job with the given arguments if the given truth test passes.

static PendingDispatch|Fluent dispatchUnless(bool $boolean, mixed ...$arguments)

Dispatch the job with the given arguments unless the given truth test passes.

static mixed dispatchSync(...$arguments)

Dispatch a command to its appropriate handler in the current process.

static mixed dispatchNow(...$arguments) deprecated

Dispatch a command to its appropriate handler in the current process.

static mixed dispatchAfterResponse(...$arguments)

Dispatch a command to its appropriate handler after the current process.

static PendingChain withChain(array $chain)

Set the jobs that should run if this job is successful.

Details

static PendingDispatch dispatch(...$arguments)

Dispatch the job with the given arguments.

Parameters

...$arguments

Return Value

static PendingDispatch|Fluent dispatchIf(bool $boolean, mixed ...$arguments)

Dispatch the job with the given arguments if the given truth test passes.

Parameters

bool $boolean
mixed ...$arguments

Return Value

static PendingDispatch|Fluent dispatchUnless(bool $boolean, mixed ...$arguments)

Dispatch the job with the given arguments unless the given truth test passes.

Parameters

bool $boolean
mixed ...$arguments

Return Value

static mixed dispatchSync(...$arguments)

Dispatch a command to its appropriate handler in the current process.

Queueable jobs will be dispatched to the "sync" queue.

Parameters

...$arguments

Return Value

mixed

static mixed dispatchNow(...$arguments) deprecated

deprecated

Will be removed in a future Laravel version.

Dispatch a command to its appropriate handler in the current process.

Parameters

...$arguments

Return Value

mixed

static mixed dispatchAfterResponse(...$arguments)

Dispatch a command to its appropriate handler after the current process.

Parameters

...$arguments

Return Value

mixed

static PendingChain withChain(array $chain)

Set the jobs that should run if this job is successful.

Parameters

array $chain

Return Value

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/8.x/Illuminate/Foundation/Bus/Dispatchable.html