1. class
  2. Illuminate
  3. \
  4. Events
  5. \
  6. CallQueuedListener

CallQueuedListener

class CallQueuedListener implements ShouldQueue

Traits

InteractsWithQueue

Properties

protected Job $job

The underlying queue job instance.

 from  InteractsWithQueue
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 $timeout

The number of seconds the job can run before timing out.

Methods

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 $exception = null)

Fail the job from the queue.

from  InteractsWithQueue
void
release(int $delay = 0)

Release the job back into the queue.

from  InteractsWithQueue
$this
setJob(Job $job)

Set the base queue job instance.

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

Create a new job instance.

void
handle(Container $container)

Handle the queued job.

mixed
setJobInstanceIfNecessary(Job $job, mixed $instance)

Set the job instance of the given class if necessary.

void
failed(Exception $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.

Details

in InteractsWithQueue at line 21
int attempts()

Get the number of times the job has been attempted.

Return Value

int

in InteractsWithQueue at line 31
void delete()

Delete the job from the queue.

Return Value

void

in InteractsWithQueue at line 44
void fail(Throwable $exception = null)

Fail the job from the queue.

Parameters

Throwable $exception

Return Value

void

in InteractsWithQueue at line 57
void release(int $delay = 0)

Release the job back into the queue.

Parameters

int $delay

Return Value

void

in InteractsWithQueue at line 70
$this setJob(Job $job)

Set the base queue job instance.

Parameters

Job $job

Return Value

$this

at line 57
void __construct(string $class, string $method, array $data)

Create a new job instance.

Parameters

string $class
string $method
array $data

Return Value

void

at line 70
void handle(Container $container)

Handle the queued job.

Parameters

Container $container

Return Value

void

at line 90
protected mixed setJobInstanceIfNecessary(Job $job, mixed $instance)

Set the job instance of the given class if necessary.

Parameters

Job $job
mixed $instance

Return Value

mixed

at line 107
void failed(Exception $e)

Call the failed method on the job instance.

The event instance and the exception will be passed.

Parameters

Exception $e

Return Value

void

at line 125
protected void prepareData()

Unserialize the data if needed.

Return Value

void

at line 137
string displayName()

Get the display name for the queued job.

Return Value

string