W3cubDocs

CallQueuedListener

class CallQueuedListener implements ShouldQueue (View source)

Traits

Properties

Job\|null	$job	The underlying queue job instance.	from InteractsWithQueue
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
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
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
string	$class	The listener class name.
string	$method	The listener method.
array	$data	The data to be passed to the listener.
int	$tries	The number of times the job may be attempted.
int	$maxExceptions	The maximum number of exceptions allowed, regardless of attempts.
int	$backoff	The number of seconds to wait before retrying a job that encountered an uncaught exception.
int	$retryUntil	The timestamp indicating when the job should timeout.
int	$timeout	The number of seconds the job can run before timing out.
bool	$failOnTimeout	Indicates if the job should fail if the timeout is exceeded.
bool	$shouldBeEncrypted	Indicates if the job should be encrypted.

Methods

int

secondsUntil(DateTimeInterface|DateInterval|int $delay)

Get the number of seconds until the given DateTime.

from InteractsWithTime

int

availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Get the "available at" UNIX timestamp.

from InteractsWithTime

DateTimeInterface|int

parseDateInterval(DateTimeInterface|DateInterval|int $delay)

If the given value is an interval, convert it to a DateTime instance.

from InteractsWithTime

int

currentTime()

Get the current system time as a UNIX timestamp.

from InteractsWithTime

string

runTimeForHumans(float $startTime, float $endTime = null)

Given a start time, format the total run time for human readability.

from InteractsWithTime

int

attempts()

Get the number of times the job has been attempted.

from InteractsWithQueue

void

delete()

Delete the job from the queue.

from InteractsWithQueue

void

fail(Throwable|string|null $exception = null)

Fail the job from the queue.

from InteractsWithQueue

void

release(DateTimeInterface|DateInterval|int $delay = 0)

Release the job back into the queue after (n) seconds.

from InteractsWithQueue

$this

withFakeQueueInteractions()

Indicate that queue interactions like fail, delete, and release should be faked.

from InteractsWithQueue

$this

assertDeleted()

Assert that the job was deleted from the queue.

from InteractsWithQueue

$this

assertFailed()

Assert that the job was manually failed.

from InteractsWithQueue

$this

assertReleased(DateTimeInterface|DateInterval|int $delay = null)

Assert that the job was released back onto the queue.

from InteractsWithQueue

$this

setJob(Job $job)

Set the base queue job instance.

from InteractsWithQueue

$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

withoutDelay()

Set the delay for the job to zero seconds.

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

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

void

__construct(string $class, string $method, array $data)

Create a new job instance.

void

handle(Container $container)

Handle the queued job.

object

setJobInstanceIfNecessary(Job $job, object $instance)

Set the job instance of the given class if necessary.

void

failed(Throwable $e)

Call the failed method on the job instance.

void

prepareData()

Unserialize the data if needed.

string

displayName()

Get the display name for the queued job.

void

__clone()

Prepare the instance for cloning.

Details

protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)

Get the number of seconds until the given DateTime.

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

int

protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Get the "available at" UNIX timestamp.

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

int

protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

If the given value is an interval, convert it to a DateTime instance.

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

DateTimeInterface|int

protected int currentTime()

Get the current system time as a UNIX timestamp.

Return Value

int

protected string runTimeForHumans(float $startTime, float $endTime = null)

Given a start time, format the total run time for human readability.

Parameters

float	$startTime
float	$endTime

Return Value

string

int attempts()

Get the number of times the job has been attempted.

Return Value

int

void delete()

Delete the job from the queue.

Return Value

void

void fail(Throwable|string|null $exception = null)

Fail the job from the queue.

Parameters

Throwable|string|null

$exception

Return Value

void

void release(DateTimeInterface|DateInterval|int $delay = 0)

Release the job back into the queue after (n) seconds.

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

void

$this withFakeQueueInteractions()

Indicate that queue interactions like fail, delete, and release should be faked.

Return Value

$this

$this assertDeleted()

Assert that the job was deleted from the queue.

Return Value

$this

$this assertFailed()

Assert that the job was manually failed.

Return Value

$this

$this assertReleased(DateTimeInterface|DateInterval|int $delay = null)

Assert that the job was released back onto the queue.

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

$this

$this setJob(Job $job)

Set the base queue job instance.

Parameters

Job

$job

Return Value

$this

$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 withoutDelay()

Set the delay for the job to zero seconds.

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 assertHasChain(array $expectedChain)

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

Parameters

array

$expectedChain

Return Value

void

void assertDoesntHaveChain()

Assert that the job has no remaining chained jobs.

Return Value

void

void __construct(string $class, string $method, array $data)

Create a new job instance.

Parameters

string	$class
string	$method
array	$data

Return Value

void

void handle(Container $container)

Handle the queued job.

Parameters

Container

$container

Return Value

void

protected object setJobInstanceIfNecessary(Job $job, object $instance)

Set the job instance of the given class if necessary.

Parameters

Job	$job
object	$instance

Return Value

object

void failed(Throwable $e)

Call the failed method on the job instance.

The event instance and the exception will be passed.

Parameters

Throwable

Return Value

void

protected void prepareData()

Unserialize the data if needed.

Return Value

void

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/11.x/Illuminate/Events/CallQueuedListener.html