Job
abstract class Job implements SerializableInterface
Traits
Properties
| protected callable | $statusUpdateCallback | Callback tor status updates |
|
| array | $_constructArgs | todo private, then reflection in create |
Methods
No description
When execute is called from Queue an additional QueueableJob Object is passed to execute
Get the status of your job
Note: This event always is being triggered by the job runner
Note: This event always is being triggered by the job runner
Note: This event always is being triggered by the job runner
Note: This event always is being triggered by the job runner
Note: This event may happen in the Frontend call
not used actively - tbd
Optional: Called after unserialize (e.g. load from db / recover or connect resource)
Optional: Override this method and specify the properties to include during serialize null = All Properties will be serialized (default) [] = No Properties will be serialized ['id'] = $this->id will be serialized
Sets the callback which should be called if the job needs to update its status As the QueueableJob has no context of the job itself this function is only available from within the execution context (daemon)
Updates the status message for this job which is being shown in user output (can only be used in execute() function)
If the return is false, the job will not be executed.
Details
at line 28
final static object
create(...$args)
No description
at line 70
abstract bool
execute(QueueableJob $queueableJob = null)
Execute is your primary job execution function
at line 79
bool
executeInJobQueue(QueueableJob $queueableJob)
When execute is called from Queue an additional QueueableJob Object is passed to execute
at line 162
static JobStatus|null
getStatus(string $uniqueId)
Get the status of your job
in
SerializableObjectTrait at line 16
array
jsonSerialize()
No description
at line 144
void
onAbort()
Note: This event always is being triggered by the job runner
at line 151
void
onCancel()
Note: This event always is being triggered by the job runner
at line 130
void
onFinish()
Note: This event always is being triggered by the job runner
at line 137
void
onRetry()
Note: This event always is being triggered by the job runner
at line 123
void
onScheduled()
Note: This event may happen in the Frontend call
at line 57
void
onSerialize()
not used actively - tbd
in
SerializableObjectTrait at line 225
void
onUnserialize()
Optional: Called after unserialize (e.g. load from db / recover or connect resource)
in
SerializableObjectTrait at line 24
SerializedObjectHelper
serializeObject()
No description
in
SerializableObjectTrait at line 212
protected array|null
serializePropertiesInclude()
Optional: Override this method and specify the properties to include during serialize null = All Properties will be serialized (default) [] = No Properties will be serialized ['id'] = $this->id will be serialized
at line 104
setStatusUpdateCallback(callable $callback)
Sets the callback which should be called if the job needs to update its status As the QueueableJob has no context of the job itself this function is only available from within the execution context (daemon)
in
SerializableObjectTrait at line 90
static object
unserializeObject(SerializedObjectHelper $SerializedObjectHelper)
No description
in
SerializableObjectTrait at line 121
static object
unserializeObjectFromJSON(string $json)
No description
at line 89
protected
updateStatusMessage(string $messageToken, int|null $progress = null)
Updates the status message for this job which is being shown in user output (can only be used in execute() function)
at line 113
bool
validate()
If the return is false, the job will not be executed.