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 |
| DateTimeInterface|DateInterval|int|null | $delay | The number of seconds before the job should be made available. |
from Queueable |
| $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. |
Methods
Set the desired connection for the chain.
Specify the middleware the job should be dispatched through.
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|int|null $delay)
Set the desired delay for the job.
array
middleware()
Get the middleware the job should be dispatched through.
$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.
void
dispatchNextJobInChain()
Dispatch the next job on the chain.
void
__construct(mixed $event)
Create a new job handler instance.
void
handle(Broadcaster $broadcaster)
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.