BroadcastEvent

class BroadcastEvent implements ShouldQueue (View source)

Traits

Properties

string\|null	$connection	The name of the connection the job should be sent to.	from Queueable
string\|null	$queue	The name of the queue the job should be sent to.	from Queueable
string\|null	$chainConnection	The name of the connection the chain should be sent to.	from Queueable
string\|null	$chainQueue	The name of the queue the chain should be sent to.	from Queueable
array\|null	$chainCatchCallbacks	The callbacks to be executed on chain failure.	from Queueable
DateTimeInterface\|DateInterval\|array\|int\|null	$delay	The number of seconds before the job should be made available.	from Queueable
bool\|null	$afterCommit	Indicates whether the job should be dispatched after all database transactions have committed.	from Queueable
array	$middleware	The middleware the job should be dispatched through.	from Queueable
array	$chained	The jobs that should run if this job is successful.	from Queueable
mixed	$event	The event instance.
int	$tries	The number of times the job may be attempted.
int	$timeout	The number of seconds the job can run before timing out.
int	$backoff	The number of seconds to wait before retrying the job when encountering an uncaught exception.
int	$maxExceptions	The maximum number of unhandled exceptions to allow before failing.

Methods

$this

onConnection(string|null $connection)

Set the desired connection for the job.

from Queueable

$this

onQueue(string|null $queue)

Set the desired queue for the job.

from Queueable

$this

allOnConnection(string|null $connection)

Set the desired connection for the chain.

from Queueable

$this

allOnQueue(string|null $queue)

Set the desired queue for the chain.

from Queueable

$this

delay(DateTimeInterface|DateInterval|array|int|null $delay)

Set the desired delay in seconds for the job.

from Queueable

$this

afterCommit()

Indicate that the job should be dispatched after all database transactions have committed.

from Queueable

$this

beforeCommit()

Indicate that the job should not wait until database transactions have been committed before dispatching.

from Queueable

$this

through(array|object $middleware)

Specify the middleware the job should be dispatched through.

from Queueable

$this

chain(array $chain)

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

from Queueable

$this

prependToChain(mixed $job)

Prepend a job to the current chain so that it is run after the currently running job.

from Queueable

$this

appendToChain(mixed $job)

Append a job to the end of the current chain.

from Queueable

string

serializeJob(mixed $job)

Serialize a job for queuing.

from Queueable

void

dispatchNextJobInChain()

Dispatch the next job on the chain.

from Queueable

void

invokeChainCatchCallbacks(Throwable $e)

Invoke all of the chain's failed job callbacks.

from Queueable

void

__construct(mixed $event)

Create a new job handler instance.

void

handle(Factory $manager)

Handle the queued job.

array

getPayloadFromEvent(mixed $event)

Get the payload for the given event.

mixed

formatProperty(mixed $value)

Format the given value for a property.

string

displayName()

Get the display name for the queued job.

void

__clone()

Prepare the instance for cloning.

Details

$this onConnection(string|null $connection)

Set the desired connection for the job.

Parameters

string|null

$connection

Return Value

$this

$this onQueue(string|null $queue)

Set the desired queue for the job.

Parameters

string|null

$queue

Return Value

$this

$this allOnConnection(string|null $connection)

Set the desired connection for the chain.

Parameters

string|null

$connection

Return Value

$this

$this allOnQueue(string|null $queue)

Set the desired queue for the chain.

Parameters

string|null

$queue

Return Value

$this

$this delay(DateTimeInterface|DateInterval|array|int|null $delay)

Set the desired delay in seconds for the job.

Parameters

DateTimeInterface|DateInterval|array|int|null

$delay

Return Value

$this

$this afterCommit()

Indicate that the job should be dispatched after all database transactions have committed.

Return Value

$this

$this beforeCommit()

Indicate that the job should not wait until database transactions have been committed before dispatching.

Return Value

$this

$this through(array|object $middleware)

Specify the middleware the job should be dispatched through.

Parameters

array|object

$middleware

Return Value

$this

$this chain(array $chain)

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

Parameters

array

$chain

Return Value

$this

$this prependToChain(mixed $job)

Prepend a job to the current chain so that it is run after the currently running job.

Parameters

mixed

$job

Return Value

$this

$this appendToChain(mixed $job)

Append a job to the end of the current chain.

Parameters

mixed

$job

Return Value

$this

protected string serializeJob(mixed $job)

Serialize a job for queuing.

Parameters

mixed

$job

Return Value

string

Exceptions

RuntimeException

void dispatchNextJobInChain()

Dispatch the next job on the chain.

Return Value

void

void invokeChainCatchCallbacks(Throwable $e)

Invoke all of the chain's failed job callbacks.

Parameters

Throwable

Return Value

void

void __construct(mixed $event)

Create a new job handler instance.

Parameters

mixed

$event

Return Value

void

void handle(Factory $manager)

Handle the queued job.

Parameters

Factory

$manager

Return Value

void

protected array getPayloadFromEvent(mixed $event)

Get the payload for the given event.

Parameters

mixed

$event

Return Value

array

protected mixed formatProperty(mixed $value)

Format the given value for a property.

Parameters

mixed

$value

Return Value

mixed

string displayName()

Get the display name for the queued job.

Return Value

string

void __clone()

Prepare the instance for cloning.

Return Value

void

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/10.x/Illuminate/Broadcasting/BroadcastEvent.html