1. class
  2. Hypervel
  3. \
  4. Broadcasting
  5. \
  6. BroadcastEvent

BroadcastEvent

class BroadcastEvent implements ShouldQueue

Traits

Queueable
ReadsQueueAttributes
ReadsClassAttributes

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
array|string|int|null $messageGroup

The message group the job should be sent to.

 from  Queueable
null|array|callable $deduplicator

The deduplicator callback the job should use to generate the deduplication ID.

 from  Queueable
string $debounceOwner

The lock owner token for debounce supersession checks.

 from  Queueable
string $uniqueLockOwner

The owner of the unique job lock.

 from  Queueable
array|DateInterval|DateTimeInterface|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 the open parent 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
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
mixed $event

The event instance.
int|null $tries

The number of times the job may be attempted.
int|null $timeout

The number of seconds the job can run before timing out.
array|int|null $backoff

The number of seconds to wait before retrying the job when encountering an uncaught exception.
int|null $maxExceptions

The maximum number of unhandled exceptions to allow before failing.
bool $deleteWhenMissingModels

Delete the job if its models no longer exist.

Methods

Queueable
onConnection(UnitEnum|string|null $connection)

Set the desired connection for the job.

from  Queueable
Queueable
onQueue(UnitEnum|string|null $queue)

Set the desired queue for the job.

from  Queueable
Queueable
onGroup(array|UnitEnum|string|int|null $group)

Set the desired job message group.

from  Queueable
Queueable
withDeduplicator(array|callable|null $deduplicator)

Set the desired job deduplicator callback.

from  Queueable
Queueable
allOnConnection(UnitEnum|string|null $connection)

Set the desired connection for the chain.

from  Queueable
Queueable
allOnQueue(UnitEnum|string|null $queue)

Set the desired queue for the chain.

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

Set the desired delay in seconds for the job.

from  Queueable
Queueable
withoutDelay()

Set the delay for the job to zero seconds.

from  Queueable
Queueable
afterCommit()

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

from  Queueable
Queueable
beforeCommit()

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

from  Queueable
Queueable
through(array|object $middleware)

Specify the middleware the job should be dispatched through.

from  Queueable
Queueable
chain(array $chain)

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

from  Queueable
Queueable
prependToChain(mixed $job)

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

from  Queueable
Queueable
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|null $e)

Invoke all of the chain's failed job callbacks.

from  Queueable
void
assertHasChain(array $expectedChain)

Assert that the job has the given chain of jobs attached to it.

from  Queueable
void
assertDoesntHaveChain()

Assert that the job has no remaining chained jobs.

from  Queueable
mixed
getAttributeValue(object $target, string $attributeClass, string|null $property = null, mixed $default = null)

Get a configuration value from an attribute, falling back to a property.

from  ReadsClassAttributes
mixed
extractAttributeValue(object $instance)

Extract the value from an attribute instance.

from  ReadsClassAttributes
object|null
getAttributeInstance(object $target, string $attributeClass, ReflectionClass|null $declaringClass = null)

Get an instance of the given attribute class from the target class or its parents.

from  ReadsClassAttributes
bool
propertyOverridesAttribute(object $target, ReflectionClass $reflection, string|null $property, ReflectionClass $attributeDeclaringClass)

Determine if a property declared on a child class overrides an inherited attribute.

from  ReadsClassAttributes
__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.

array
getConnectionChannels(array $channels, string|null $connection)

Get the channels for the given connection.

array
getConnectionPayload(array $payload, string|null $connection)

Get the payload for the given connection.

array
middleware()

Get the middleware for the underlying event.

void
failed(Throwable|null $e = null)

Handle a job failure.

string
displayName()

Get the display name for the queued job.

void
__clone()

Prepare the instance for cloning.

Details

in Queueable at line 97
Queueable onConnection(UnitEnum|string|null $connection)

Set the desired connection for the job.

Parameters

UnitEnum|string|null $connection

Return Value

Queueable

in Queueable at line 109
Queueable onQueue(UnitEnum|string|null $queue)

Set the desired queue for the job.

Parameters

UnitEnum|string|null $queue

Return Value

Queueable

in Queueable at line 123
Queueable onGroup(array|UnitEnum|string|int|null $group)

Set the desired job message group.

This feature is only supported by some queues, such as Amazon SQS.

Parameters

array|UnitEnum|string|int|null $group

Return Value

Queueable

in Queueable at line 135
Queueable withDeduplicator(array|callable|null $deduplicator)

Set the desired job deduplicator callback.

This feature is only supported by some queues, such as Amazon SQS FIFO.

Parameters

array|callable|null $deduplicator

Return Value

Queueable

in Queueable at line 153
Queueable allOnConnection(UnitEnum|string|null $connection)

Set the desired connection for the chain.

Parameters

UnitEnum|string|null $connection

Return Value

Queueable

in Queueable at line 168
Queueable allOnQueue(UnitEnum|string|null $queue)

Set the desired queue for the chain.

Parameters

UnitEnum|string|null $queue

Return Value

Queueable

in Queueable at line 183
Queueable delay(array|DateInterval|DateTimeInterface|int|null $delay)

Set the desired delay in seconds for the job.

Parameters

array|DateInterval|DateTimeInterface|int|null $delay

Return Value

Queueable

in Queueable at line 193
Queueable withoutDelay()

Set the delay for the job to zero seconds.

Return Value

Queueable

in Queueable at line 203
Queueable afterCommit()

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

Return Value

Queueable

in Queueable at line 213
Queueable beforeCommit()

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

Return Value

Queueable

in Queueable at line 223
Queueable through(array|object $middleware)

Specify the middleware the job should be dispatched through.

Parameters

array|object $middleware

Return Value

Queueable

in Queueable at line 233
Queueable chain(array $chain)

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

Parameters

array $chain

Return Value

Queueable

in Queueable at line 245
Queueable 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

Queueable

in Queueable at line 259
Queueable appendToChain(mixed $job)

Append a job to the end of the current chain.

Parameters

mixed $job

Return Value

Queueable

in Queueable at line 275
protected string serializeJob(mixed $job)

Serialize a job for queuing.

Parameters

mixed $job

Return Value

string

Exceptions

RuntimeException

in Queueable at line 293
void dispatchNextJobInChain()

Dispatch the next job on the chain.

Return Value

void

in Queueable at line 316
void invokeChainCatchCallbacks(Throwable|null $e)

Invoke all of the chain's failed job callbacks.

Parameters

Throwable|null $e

Return Value

void

in Queueable at line 326
void assertHasChain(array $expectedChain)

Assert that the job has the given chain of jobs attached to it.

Parameters

array $expectedChain

Return Value

void

in Queueable at line 348
void assertDoesntHaveChain()

Assert that the job has no remaining chained jobs.

Return Value

void

in ReadsClassAttributes at line 17
protected mixed getAttributeValue(object $target, string $attributeClass, string|null $property = null, mixed $default = null)

Get a configuration value from an attribute, falling back to a property.

Parameters

object $target
string $attributeClass
string|null $property
mixed $default

Return Value

mixed

in ReadsClassAttributes at line 46
protected mixed extractAttributeValue(object $instance)

Extract the value from an attribute instance.

Parameters

object $instance

Return Value

mixed

in ReadsClassAttributes at line 58
protected object|null getAttributeInstance(object $target, string $attributeClass, ReflectionClass|null $declaringClass = null)

Get an instance of the given attribute class from the target class or its parents.

Parameters

object $target
string $attributeClass
ReflectionClass|null $declaringClass

Return Value

object|null

in ReadsClassAttributes at line 74
protected bool propertyOverridesAttribute(object $target, ReflectionClass $reflection, string|null $property, ReflectionClass $attributeDeclaringClass)

Determine if a property declared on a child class overrides an inherited attribute.

Parameters

object $target
ReflectionClass $reflection
string|null $property
ReflectionClass $attributeDeclaringClass

Return Value

bool

at line 63
__construct(mixed $event)

Create a new job handler instance.

Parameters

mixed $event

at line 77
void handle(Factory $manager)

Handle the queued job.

Parameters

Factory $manager

Return Value

void

at line 107
protected array getPayloadFromEvent(mixed $event)

Get the payload for the given event.

Parameters

mixed $event

Return Value

array

at line 129
protected mixed formatProperty(mixed $value)

Format the given value for a property.

Parameters

mixed $value

Return Value

mixed

at line 141
protected array getConnectionChannels(array $channels, string|null $connection)

Get the channels for the given connection.

Parameters

array $channels
string|null $connection

Return Value

array

at line 151
protected array getConnectionPayload(array $payload, string|null $connection)

Get the payload for the given connection.

Parameters

array $payload
string|null $connection

Return Value

array

at line 169
array middleware()

Get the middleware for the underlying event.

Return Value

array

at line 181
void failed(Throwable|null $e = null)

Handle a job failure.

Parameters

Throwable|null $e

Return Value

void

at line 193
string displayName()

Get the display name for the queued job.

Return Value

string

at line 201
void __clone()

Prepare the instance for cloning.

Return Value

void