SystemStatusUpdateTask

class \TYPO3\CMS\Reports\Task\SystemStatusUpdateTask

Extends
AbstractTask

A task that should be run regularly to determine the system's status.

Table of Contents

Constants

TYPE_RECURRING  : mixed = 2
TYPE_SINGLE  : mixed = 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
$notificationAll  : bool
Checkbox for to send all types of notification, not only problems
$notificationEmail  : string
Email addresses to send email notification to in case we find problems with the system.
$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.

Methods

__construct()  : mixed
execute()  : bool
Executes the System Status Update task, determining the highest severity of status reports and saving that to the registry to be displayed at login if necessary.
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|object|null
Returns the execution object
getExecutionTime()  : int
This method returns the timestamp corresponding to the next execution time 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 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
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
validateTaskParameters()  : bool
getLanguageService()  : LanguageService|null
logException()  : mixed
sendNotificationEmail()  : void
Sends a notification email, reporting system issues.

Constants

TYPE_RECURRING

public mixed TYPE_RECURRING = 2

Properties

$description

Description for the task

protected string $description = ''

$disabled

Disable flag, TRUE if task is disabled, FALSE otherwise

protected bool $disabled = false

$executionTime

This variable contains the time of next execution of the task

protected int $executionTime = 0

$notificationAll

Checkbox for to send all types of notification, not only problems

protected bool $notificationAll = false

$notificationEmail

Email addresses to send email notification to in case we find problems with the system.

protected string $notificationEmail = ''

$runOnNextCronJob

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

protected bool $runOnNextCronJob = false

$taskGroup

Task group for this task

protected int|null $taskGroup = 0

$taskUid

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

protected int $taskUid = 0

Methods

execute()

Executes the System Status Update task, determining the highest severity of status reports and saving that to the registry to be displayed at login if necessary.

public execute() : bool

Tags

see
AbstractTask::execute()

Return values

bool —

Returns TRUE on successful execution, FALSE on error

getAdditionalInformation()

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

public getAdditionalInformation() : string

Return values

string —

Information to display

getDescription()

This method returns the description of the task

public getDescription() : string

Return values

string —

Description

getExecution()

Returns the execution object

public getExecution() : Execution|object|null

Return values

Execution|object|null —

The internal execution object - when an invalid task is being unserialized, the Execution object might not be available

getExecutionTime()

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

public getExecutionTime() : int

Return values

int —

Timestamp of next execution

getRunOnNextCronJob()

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

public getRunOnNextCronJob() : bool

Return values

bool —

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

getTaskClassName()

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.

public getTaskClassName() : string

Deprecated

since TYPO3 v14.0, may be removed in TYPO3 v15.0.

Return values

string

getTaskDescription()

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.

public getTaskDescription() : string

Deprecated

since TYPO3 v14.0, may be removed in TYPO3 v15.0.

Note by benni in 2025: This method will cease to exist at some point, as the description is loaded from TCA eventually.

Return values

string

getTaskGroup()

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

public getTaskGroup() : int|null

Return values

int|null —

Uid of task group or null if it came back from the DB without the task group set.

getTaskParameters()

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

public getTaskParameters() : array

Return values

array

getTaskTitle()

This method returns the title of the scheduler task.

public getTaskTitle() : string

Deprecated

since TYPO3 v14.0, may be removed in TYPO3 v15.0.

Unused since TYPO3 v14.0, can be deprecated and removed once we migrate task registration away from TYPO3_CONF_VARS. Note by benni in 2025: This method will cease to exist at some point, as the title is loaded from TCA eventually.

Return values

string

getTaskType()

public getTaskType() : string

Return values

string

getTaskUid()

This method returns the unique id of the task

public getTaskUid() : int

Return values

int —

The id of the task

getType()

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

public getType() : int

Return values

int

isDisabled()

This method returns the disabled status of the task

public isDisabled() : bool

Return values

bool —

TRUE if task is disabled, FALSE otherwise

setDescription()

This method is used to set the description of the task

public setDescription(string $description) : void

Parameters

$description : string

Description

setDisabled()

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

public setDisabled(bool $flag) : mixed

Parameters

$flag : bool

TRUE if task should be disabled, FALSE otherwise

setExecution()

Sets the internal execution object

public setExecution(Execution $execution) : void

Parameters

$execution : Execution

The execution to add

setExecutionTime()

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

public setExecutionTime(int $timestamp) : mixed

Parameters

$timestamp : int

Timestamp of next execution

setRunOnNextCronJob()

This method set the flag for next cron job execution

public setRunOnNextCronJob(bool $flag) : mixed

Parameters

$flag : bool

TRUE if task should run with the next cron job, FALSE otherwise

setTaskGroup()

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

public setTaskGroup(int $taskGroup) : mixed

Parameters

$taskGroup : int

Uid of task group

setTaskParameters()

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.

public setTaskParameters(array $parameters) : void

Parameters

$parameters : array

setTaskUid()

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

public setTaskUid(int $id) : void

Parameters

$id : int

Primary key (from the database record) of the scheduled task

validateTaskParameters()

public validateTaskParameters(array $parameters) : bool

Parameters

$parameters : array

Return values

bool

logException()

protected logException(Exception $e) : mixed

Parameters

$e : Exception

sendNotificationEmail()

Sends a notification email, reporting system issues.

protected sendNotificationEmail(Status[][] $systemStatus) : void

Parameters

$systemStatus : Status[][]

Array of statuses

On this page