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
Set the desired connection for the chain.
Set the desired delay in seconds for the job.
Indicate that the job should be dispatched after all database transactions have committed.
Indicate that the job should not wait until database transactions have been committed before dispatching.
Specify the middleware the job should be dispatched through.
Prepend a job to the current chain so that it is run after the currently running job.
Create a new job handler instance.
Get the payload for the given event.
Format the given value for a property.
Get the display name for the queued job.
Prepare the instance for cloning.
Details
$this
onConnection(string|null $connection)
Set the desired connection for the job.
$this
onQueue(string|null $queue)
Set the desired queue for the job.
$this
allOnConnection(string|null $connection)
Set the desired connection for the chain.
$this
allOnQueue(string|null $queue)
Set the desired queue for the chain.
$this
delay(DateTimeInterface|DateInterval|array|int|null $delay)
Set the desired delay in seconds for the job.
$this
afterCommit()
Indicate that the job should be dispatched after all database transactions have committed.
$this
beforeCommit()
Indicate that the job should not wait until database transactions have been committed before dispatching.
$this
through(array|object $middleware)
Specify the middleware the job should be dispatched through.
$this
chain(array $chain)
Set the jobs that should run if this job is successful.
$this
prependToChain(mixed $job)
Prepend a job to the current chain so that it is run after the currently running job.
$this
appendToChain(mixed $job)
Append a job to the end of the current chain.
protected string
serializeJob(mixed $job)
Serialize a job for queuing.
void
dispatchNextJobInChain()
Dispatch the next job on the chain.
void
invokeChainCatchCallbacks(Throwable $e)
Invoke all of the chain's failed job callbacks.
void
__construct(mixed $event)
Create a new job handler instance.
void
handle(Factory $manager)
Handle the queued job.
protected array
getPayloadFromEvent(mixed $event)
Get the payload for the given event.
protected 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.