Entry
Entry
A configured CRON schedule that is tracked in the schedule history.
class EntryAn entry identifies the schedule (see $identity), holds its per-schedule catch-up overrides, and carries the result of the catch-up check back to the agent: if $catchup is true, the schedule's task should start at $start and represent the missed occurrence $occurrence.
Properties
identity
public string $identityType: string
key
public string $keyType: string
cron
public Cron $cronType: Hazaar\Util\Cron
start
When the schedule's task should start. Set to the catch-up start time if a catch-up was scheduled.
public int $startType: int
occurrence
The occurrence the next execution represents. Set to the missed occurrence if a catch-up was scheduled.
public int $occurrenceType: int
catchup
True if a catch-up of a missed occurrence was scheduled.
public bool $catchupType: bool
tracked
False if the schedule can't be tracked, because another schedule has the same identity.
public bool $tracked = trueType: bool
tag
the schedule's tag
public readonly string $tagType: string
action
the scheduled action, e.g. App\Models\Reports::daily
public readonly string $actionType: string
when
the CRON expression
public readonly string $whenType: string
options
the schedule's config, from which the catchup* overrides are read
public readonly array $optionsType: array
Methods
__construct
public __construct(string $tag, string $action, mixed $args, string $when, int $next, array $options): voidParameters
| Parameter | Type | Description |
|---|---|---|
$tag | string | the schedule's tag |
$action | string | the scheduled action, e.g. App\Models\Reports::daily |
$args | mixed | the schedule's args, used to identify an untagged schedule |
$when | string | the CRON expression |
$next | int | when the schedule is next due |
$options | array | the schedule's config, from which the catchup* overrides are read |
getName
Returns a name for the schedule to use in log messages: its tag, or its action if it has no tag.
public getName(): stringReturns: string
Generated by Hazaar API Doc Generator on Thu, 22 Oct 2026 05:05:31 +0000