Scheduler implements SingletonInterface
TYPO3 Scheduler. This class handles scheduling and execution of tasks.
Table of Contents
Interfaces
- SingletonInterface
- "empty" interface for singletons (marker interface pattern)
Properties
- $extConf : array<string|int, mixed>
- $logger : LoggerInterface
- $schedulerTaskRepository : SchedulerTaskRepository
- $taskSerializer : TaskSerializer
Methods
- __construct() : mixed
- Constructor, makes sure all derived client classes are included
- executeTask() : bool
- This method executes the given task and properly marks and records that execution It is expected to return FALSE if the task was barred from running or if it was not saved properly
- recordLastRun() : mixed
- This method stores information about the last run of the Scheduler into the system registry
- cleanExecutionArrays() : mixed
- Cleans the execution lists of the scheduled tasks, executions older than 24h are removed
Properties
$extConf
public
array<string|int, mixed>
$extConf
= []
Settings from the extension manager
$logger
protected
LoggerInterface
$logger
$schedulerTaskRepository
protected
SchedulerTaskRepository
$schedulerTaskRepository
$taskSerializer
protected
TaskSerializer
$taskSerializer
Methods
__construct()
Constructor, makes sure all derived client classes are included
public
__construct(LoggerInterface $logger, TaskSerializer $taskSerializer, SchedulerTaskRepository $schedulerTaskRepository) : mixed
Parameters
- $logger : LoggerInterface
- $taskSerializer : TaskSerializer
- $schedulerTaskRepository : SchedulerTaskRepository
executeTask()
This method executes the given task and properly marks and records that execution It is expected to return FALSE if the task was barred from running or if it was not saved properly
public
executeTask(AbstractTask $task) : bool
Parameters
- $task : AbstractTask
-
The task to execute
Tags
Return values
bool —Whether the task was saved successfully to the database or not
recordLastRun()
This method stores information about the last run of the Scheduler into the system registry
public
recordLastRun([string $type = 'cron' ]) : mixed
Parameters
- $type : string = 'cron'
-
Type of run (manual or command-line (assumed to be cron))
cleanExecutionArrays()
Cleans the execution lists of the scheduled tasks, executions older than 24h are removed
protected
cleanExecutionArrays() : mixed