EventParams
in package
Uses
InteractsWithQueue, SerializesAndRestoresModelIdentifiers
Table of Contents
- $eventClass : mixed
- $job : Job
- The underlying queue job instance.
- $params : mixed
- __construct() : void
- Create a new job instance.
- attempts() : int
- Get the number of times the job has been attempted.
- delete() : void
- Delete the job from the queue.
- fail() : void
- Fail the job from the queue.
- handle() : void
- Execute the job.
- release() : void
- Release the job back into the queue.
- setJob() : $this
- Set the base queue job instance.
- getQueryForModelRestoration() : Builder
- Get the query for restoration.
- getRestoredPropertyValue() : mixed
- Get the restored property value after deserialization.
- getSerializedPropertyValue() : mixed
- Get the property value prepared for serialization.
- restoreCollection() : Collection
- Restore a queueable collection instance.
- serializeParams() : mixed
- unserializeParams() : mixed
Properties
$eventClass
protected
mixed
$eventClass
$job
The underlying queue job instance.
protected
Job
$job
$params
protected
mixed
$params
Methods
__construct()
Create a new job instance.
public
__construct(mixed $eventClass, array<string|int, mixed> $params) : void
Parameters
- $eventClass : mixed
- $params : array<string|int, mixed>
Return values
void —attempts()
Get the number of times the job has been attempted.
public
attempts() : int
Return values
int —delete()
Delete the job from the queue.
public
delete() : void
Return values
void —fail()
Fail the job from the queue.
public
fail([Throwable $exception = null ]) : void
Parameters
- $exception : Throwable = null
Return values
void —handle()
Execute the job.
public
handle() : void
Return values
void —release()
Release the job back into the queue.
public
release(int $delay) : void
Parameters
- $delay : int
Return values
void —setJob()
Set the base queue job instance.
public
setJob(Job $job) : $this
Parameters
- $job : Job
Return values
$this —getQueryForModelRestoration()
Get the query for restoration.
protected
getQueryForModelRestoration(Model $model, array<string|int, mixed>|int $ids) : Builder
Parameters
- $model : Model
- $ids : array<string|int, mixed>|int
Return values
Builder —getRestoredPropertyValue()
Get the restored property value after deserialization.
protected
getRestoredPropertyValue(mixed $value) : mixed
Parameters
- $value : mixed
Return values
mixed —getSerializedPropertyValue()
Get the property value prepared for serialization.
protected
getSerializedPropertyValue(mixed $value) : mixed
Parameters
- $value : mixed
Return values
mixed —restoreCollection()
Restore a queueable collection instance.
protected
restoreCollection(ModelIdentifier $value) : Collection
Parameters
- $value : ModelIdentifier
Return values
Collection —serializeParams()
protected
serializeParams(mixed $params) : mixed
Parameters
- $params : mixed
Return values
mixed —unserializeParams()
protected
unserializeParams() : mixed