Documentation

AbstractJob

in package

• Pop
• Queue

implements JobInterface

Abstract job class

Tags

category

Pop

author

Nick Sagona, III nick@popphp.org

copyright

Copyright (c) 2009-2026 Nick Sagona, III

license

https://www.popphp.org/license New BSD License

version

3.0.0

Table of Contents

Interfaces

JobInterface

Job interface

Properties

$attempts  : int

Attempts

$availableAt  : int|null

Timestamp before which this job is not eligible for reservation

$backoff  : int|array<string|int, mixed>|null

Retry backoff: a fixed delay in seconds, or a per-attempt schedule that holds at its last value for further attempts. Null = immediate retry.

$callable  : CallableObject|null

Job callable

$command  : string|array<string|int, mixed>|null

Job application command - an invocation string routed through the application (e.g. 'greet Nick'), or an argv-style array of already split segments (e.g. ['notify', 'Hello there, world']). The string form is split on whitespace by the router, so the array form is the only way to pass a value that itself contains spaces.

$completed  : int|null

Job completed timestamp

$description  : string|null

Job Description

$exec  : string|array<string|int, mixed>|null

Job CLI executable command - a shell command string (runs via the shell, e.g. 'ls -la | wc -l'), or an argv-style array to run with no shell involved at all (e.g. ['ls', '-la'] - the safer form when any part of the command isn't a fully-trusted literal, since shell metacharacters in an argv element are inert)

$failed  : int|null

Job failed timestamp

$failedMessages  : array<string|int, mixed>

Job failed messages

$id  : string|null

Job ID

$maxAttempts  : int

Max attempts

$results  : mixed

Job results

$runUntil  : int|string|null

Run until property

$serializedClosure  : string|null

Serialize closure

$serializedParameters  : array<string|int, mixed>|null

Serialize parameters

$started  : int|null

Job started timestamp

$timeout  : int|null

Soft execution timeout, in seconds (only enforced when ext-pcntl is loaded)

Methods

__construct()  : mixed

Constructor

__sleep()  : array<string|int, mixed>

Sleep magic method

__wakeup()  : void

Wakeup magic method

addFailedMessage()  : AbstractJob

Add failed message

complete()  : AbstractJob

Complete job

delay()  : AbstractJob

Delay job availability

failed()  : AbstractJob

Set job as failed

generateJobId()  : string

Generate job ID

getAttempts()  : int

Get actual attempts

getAvailableAt()  : int|null

Get available-at timestamp

getBackoff()  : int|array<string|int, mixed>|null

Get retry backoff

getBackoffDelay()  : int

Get the backoff delay, in seconds, for the current attempt count

getCallable()  : CallableObject|null

Get job callable

getCommand()  : string|array<string|int, mixed>|null

Get job application command

getCompleted()  : int|null

Get completed timestamp

getDuration()  : int|null

Get how long the job took to run, in seconds, or null unless it both started and completed. Convenience for observability listeners, which would otherwise all repeat the same timestamp subtraction.

getExec()  : string|array<string|int, mixed>|null

Get job CLI executable command

getFailed()  : int|null

Get failed timestamp

getFailedMessages()  : array<string|int, mixed>

Get failed messages

getJobDescription()  : string|null

Get job description

getJobId()  : string|null

Get job ID

getMaxAttempts()  : int

Get max attempts

getResults()  : mixed

Get job results

getRunUntil()  : int|string|null

Get run until value

getStarted()  : int|null

Get started timestamp

getTimeout()  : int|null

Get soft execution timeout

hasAttempts()  : bool

Has actual attempts

hasBackoff()  : bool

Has retry backoff

hasCallable()  : bool

Has job callable

hasCommand()  : bool

Has job application command

hasExceededMaxAttempts()  : bool

Determine if the job has exceeded max attempts

hasExec()  : bool

Has job CLI executable command

hasFailed()  : bool

Has job failed

hasFailedMessages()  : bool

Has failed messages

hasJobDescription()  : bool

Has job description

hasJobId()  : bool

Has job ID

hasMaxAttempts()  : bool

Has max attempts

hasNotRun()  : bool

Has job run yet

hasResults()  : bool

Has job results

hasRunUntil()  : bool

Has run until

hasStarted()  : bool

Has job started

hasTimeout()  : bool

Has soft execution timeout

isAttemptOnce()  : bool

Is job set for only one max attempt

isAvailable()  : bool

Determine if the job is currently available (no delay, or delay has elapsed)

isComplete()  : bool

Is job complete

isExpired()  : bool

Determine if the job has expired

isRunning()  : bool

Is job running and has not completed or failed yet

isValid()  : bool

Determine if the job is still valid

run()  : mixed

Run job

runUntil()  : AbstractJob

Set the run until property

setBackoff()  : AbstractJob

Set retry backoff (fixed seconds, or a per-attempt schedule)

setCallable()  : AbstractJob

Set job callable

setCommand()  : AbstractJob

Set job application command

setExec()  : AbstractJob

Set job CLI executable command

setJobDescription()  : AbstractJob

Set job description

setJobId()  : AbstractJob

Set job ID

setMaxAttempts()  : AbstractJob

Set max attempts

setTimeout()  : AbstractJob

Set soft execution timeout

start()  : AbstractJob

Start job

buildExecProcess()  : Process

Build the Process instance for this job's exec command, without running it. Split out from runExec() purely so a test can construct one and inspect its configured timeout directly, without actually executing a command.

describeFromCommand()  : void

Borrow a job description from the dispatched command, if it has one and the job was not given one explicitly. A command already documents itself, so a queued command job need not be anonymous in the registry.

loadCallable()  : mixed

Load callable

runCommand()  : mixed

Run application command

runExec()  : mixed

Run CLI executable command