AbstractTask implements LoggerAwareInterface uses LoggerAwareTrait

This is the base class for all Scheduler tasks It's an abstract class, not designed to be instantiated directly All Scheduler tasks should inherit from this class

Table of Contents

Interfaces

LoggerAwareInterface

Constants

TYPE_RECURRING  = 2

TYPE_SINGLE  = 1

Properties

$description  : string

Description for the task

$disabled  : bool

Disable flag, TRUE if task is disabled, FALSE otherwise

$execution  : Execution

The execution object related to the task

$executionTime  : int

This variable contains the time of next execution of the task

$runOnNextCronJob  : bool

Run on next cron job flag, TRUE if task should run on next cronjob, FALSE otherwise

$scheduler  : Scheduler|null

Reference to a scheduler object

$taskGroup  : int|null

Task group for this task

$taskUid  : int

The unique id of the task used to identify it in the database.

Methods

__construct()  : mixed

Constructor

areMultipleExecutionsAllowed()  : bool

Returns TRUE if several runs of the task are allowed concurrently

execute()  : bool

This is the main method that is called when a task is executed It MUST be implemented by all classes inheriting from this one Note that there is no error handling, errors and failures are expected to be handled and logged by the client implementations.

getAdditionalInformation()  : string

This method is designed to return some additional information about the task, that may help to set it apart from other tasks from the same class This additional information is used - for example - in the Scheduler's BE module This method should be implemented in most task classes

getDescription()  : string

This method returns the description of the task

getExecution()  : Execution

Returns the execution object

getExecutionTime()  : int

This method returns the timestamp corresponding to the next execution time of the task

getNextDueExecution()  : int

Returns the timestamp for next due execution of the task

getRunOnNextCronJob()  : bool

This method returns the run on next cron job status of the task

getTaskClassName()  : string

This method returns the class name of the scheduler task

getTaskDescription()  : string

This method returns the description of the scheduler task

getTaskGroup()  : int|null

This method returns the task group (uid) of the task

getTaskTitle()  : string

This method returns the title of the scheduler task

getTaskUid()  : int

This method returns the unique id of the task

getType()  : int

Guess task type from the existing information If an interval or a cron command is defined, it's a recurring task

isDisabled()  : bool

This method returns the disabled status of the task

isExecutionRunning()  : bool

Returns TRUE if an instance of the task is already running

markExecution()  : int

This method adds current execution to the execution list It also logs the execution time and mode

registerRecurringExecution()  : mixed

Registers a recurring execution of the task

registerSingleExecution()  : mixed

Registers a single execution of the task

remove()  : mixed

Removes the task totally from the system.

save()  : bool

Saves the details of the task to the database.

setDescription()  : void

This method is used to set the description of the task

setDisabled()  : mixed

This method is used to set the disabled status of the task

setExecution()  : mixed

Sets the internal execution object

setExecutionTime()  : mixed

This method is used to set the timestamp corresponding to the next execution time of the task

setRunOnNextCronJob()  : mixed

This method set the flag for next cron job execution

setScheduler()  : mixed

Sets the internal reference to the singleton instance of the Scheduler and the logger instance in case it was unserialized

setTaskGroup()  : mixed

This method is used to set the task group (uid) of the task

setTaskUid()  : void

This method is used to set the unique id of the task

stop()  : mixed

Stops the task, by replacing the execution object by an empty one NOTE: the task still needs to be saved after that

unmarkAllExecutions()  : bool

Clears all marked executions

unmarkExecution()  : mixed

Removes given execution from list

unsetScheduler()  : mixed

Unsets the internal reference to the singleton instance of the Scheduler and the logger instance.

getLanguageService()  : LanguageService|null

logException()  : mixed