CleanerTask extends AbstractTask

A task that should be run regularly that permanently removes soft-deleted datasets from the DB.

Table of Contents

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

$period  : int

$runOnNextCronJob  : bool

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

$taskGroup  : int|null

Task group for this task

$taskUid  : int

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

$tcaTables  : array<string|int, mixed>

Methods

__construct()  : mixed

execute()  : bool

The main method of the task. Iterates through the tables and calls the cleaning function

getAdditionalInformation()  : string

Returns the information shown in the task-list

getAllTcaTables()  : void

TCA Item Provider

getDescription()  : string

This method returns the description of the task

getExecution()  : Execution|object|null

Returns the execution object

getExecutionTime()  : int

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

getPeriodAsTimestamp()  : int

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 Unused since TYPO3 v14.0, can be deprecated and removed once we migrate task registration away from TYPO3_CONF_VARS.

getTaskDescription()  : string

This method returns the description of the scheduler task Unused since TYPO3 v14.0, can be deprecated and removed once we migrate task registration away from TYPO3_CONF_VARS.

getTaskGroup()  : int|null

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

getTaskParameters()  : array<string|int, mixed>

It is recommended to implement this method in the respective task class.

getTaskTitle()  : string

This method returns the title of the scheduler task.

getTaskType()  : string

getTaskUid()  : int

This method returns the unique id of the task

getType()  : int

Guess recurring 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

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()  : void

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

setTaskGroup()  : mixed

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

setTaskParameters()  : void

Used to fill fields of this class, e.g. also when instantiating this class when no parameters are given but native DB fields are coming in.

setTaskUid()  : void

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

cleanTable()  : bool

Executes the delete-query for the given table

getLanguageService()  : LanguageService|null

logException()  : mixed