g
Frontend | Backend | Api

Scheduler\Models\Backend\Task

Task

Method Description Returns
getDeleteUrl() Get the delete URL. Does not allow deleting pre-defined tasks - they would be re-created anyway. string
getHateoasLinks() Get the HATEOAS links for the record array
getEditUrl() Get the url for editing the record. string
getPublishUrl() Get the url for publishing the record. string
getDeleteUrlSrc() Get the url for deleting the record. string
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
getCreated() Date the record was created. DateTime
getModified() Last modification date for the record. DateTime
getPublished() Date at which the page was published DateTime
isPublished() Determines if the record is published. bool
getSite() Site
isRecurring() Check whether the task is configured as recurring task / cron bool
getNextRunDate() Get the next time this task will be dispatched, based on the last DateTime
isDue() Check whether the task is due for dispatching. Also considers "late" tasks due for dispatching on non-recurring tasks only bool
isNewRecord() Check if the record is a new record bool
isHierarchicalModel() Check whether a model is a hierarchical model, i.e. can have children bool
getIntervalDescription() Get a description for the interval at which a task is scheduled string
getParametersText() Get a text representation of the parameters string