ModelScheduler module

Task

A model in the Scheduler module, with 28 members for templates, 29 API properties and 34 members for admin templates.

Scheduler\Models\Frontend\Task Scheduler\Models\Api\Task Scheduler\Models\Backend\Task

Templates view

Properties 28

Take no arguments.

# getDeleteUrlSrc(): ?string; Get the url for deleting the record.
# getId(): ?int
# getName(): ?string
# getText(): ?string
# isPredefined(): bool
# getQueueKey(): ?string
# getParameters(): ?array
# getInterval(): ?string
# getIntervalMinute(): ?string
# getIntervalHour(): ?string
# getIntervalDay(): ?string
# getIntervalMonth(): ?string
# getIntervalDayOfWeek(): ?string
# getPauseUntil(): ?DateTime
# getRecurringUntil(): ?DateTime
# getLastDispatched(): ?DateTime
# getWatermark(): ?DateTime; Returns the worker-state watermark (read-only — there is intentionally no setter). A value read from a hydrated entity may be stale in long-running worker contexts; code that needs the current value must read it via \Scheduler\Repositories\Task::findWatermark(), and the only legitimate writer is \Scheduler\Repositories\Task::casWatermark(). See the property docblock for the full rationale.
# getCreated(): ?DateTime; Date the record was created.
# getModified(): ?DateTime; Last modification date for the record.
# getPublished(): ?DateTime; Date at which the page was published
# isPublished(): bool; Determines if the record is published.
# getSite(): ?Site
# isRecurring(): bool; Check whether the task is configured as recurring task / cron
# getNextRunDate(): ?DateTime; Get the next time this task will be dispatched, based on the last
# isDue(): bool; Check whether the task is due for dispatching. Also considers "late" tasks due for dispatching on non-recurring tasks only
# isNewRecord() Not in API & Jobs: bool; Check if the record is a new record
# isHierarchicalModel() Not in API & Jobs: bool; Check whether a model is a hierarchical model, i.e. can have children
# isVersionedModel() Not in API & Jobs: bool; Check whether a model is versioned

API & Jobs view

API & JobsEach property is a key in REST API responses and job payloads. Its name is the template getter without get, is or has. Methods that need arguments are not available here.

Properties 29

Read-only values on the record.

# deleteUrl Not in Templates: ?string; Get the delete URL. Does not allow deleting pre-defined tasks - they would be re-created anyway.
# hateoasLinks Not in Templates: array; Get the HATEOAS links for the record
# editUrl Not in Templates: ?string; Get the url for editing the record.
# publishUrl Not in Templates: ?string; Get the url for publishing the record.
# deleteUrlSrc: ?string; Get the url for deleting the record.
# id: ?int
# name: ?string
# text: ?string
# predefined: bool
# queueKey: ?string
# parameters: ?array
# interval: ?string
# intervalMinute: ?string
# intervalHour: ?string
# intervalDay: ?string
# intervalMonth: ?string
# intervalDayOfWeek: ?string
# pauseUntil: ?DateTime
# recurringUntil: ?DateTime
# lastDispatched: ?DateTime
# watermark: ?DateTime; Returns the worker-state watermark (read-only — there is intentionally no setter). A value read from a hydrated entity may be stale in long-running worker contexts; code that needs the current value must read it via \Scheduler\Repositories\Task::findWatermark(), and the only legitimate writer is \Scheduler\Repositories\Task::casWatermark(). See the property docblock for the full rationale.
# created: ?DateTime; Date the record was created.
# modified: ?DateTime; Last modification date for the record.
# published: ?DateTime; Date at which the page was published
# published: bool; Determines if the record is published.
# site: ?Site
# recurring: bool; Check whether the task is configured as recurring task / cron
# nextRunDate: ?DateTime; Get the next time this task will be dispatched, based on the last
# due: bool; Check whether the task is due for dispatching. Also considers "late" tasks due for dispatching on non-recurring tasks only

Admin view

AdminAvailable in cdna-admin templates. Copy an admin template into your site repository to change how this record is edited.

Properties 34