Quick Reference
Static Entry Points
| Method | Mode | Requires |
|---|---|---|
::sync() | Synchronous execution | Executable or QueueableExecutable |
::onQueue() | Queue dispatch | QueueableExecutable |
::prepare() | Job without dispatch | QueueableExecutable |
::test() | Test execution | Executable or QueueableExecutable, test environment only |
::mock() | Mockery mock | Executable or QueueableExecutable, test environment only |
::spy() | Mockery spy | Executable or QueueableExecutable, test environment only |
::assert() | Assertion helper | Executable or QueueableExecutable, test environment only |
Lifecycle Methods
| Method | Purpose | Returns |
|---|---|---|
configure(QueueableConfig, ...) | Mutate queue config at build time | void |
backoff(...) | Backoff strategy | int|array |
displayName(...) | Queue display name | string |
retryUntil(...) | Retry deadline | DateTimeInterface |
tries(...) | Max attempts | int |
uniqueFor(...) | Unique lock duration | int |
uniqueId(...) | Unique lock identifier | string|int |
uniqueVia(...) | Cache store for lock | Repository |
tags(...) | Horizon tags | array |
middleware(...) | Job middleware | array |
failed(Throwable, ...) | Handle failure | void |
All lifecycle methods receive execute-arguments by name.
