ValidatorTask extends AbstractTask

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

Constants

TYPE_RECURRING  = 2

TYPE_SINGLE  = 1

Properties

$configuration  : string

Specific TSconfig for this task.

$countInARun  : int

$depth  : int

Level of pages the task should check

$description  : string

Description for the task

$disabled  : bool

Disable flag, TRUE if task is disabled, FALSE otherwise

$email  : string

Email address to which an email report is sent

$emailOnBrokenLinkOnly  : bool

Only send an email, if new broken links were found

$emailTemplateName  : string

Template name to be used for the email

$execution  : Execution

The execution object related to the task

$executionTime  : int

This variable contains the time of next execution of the task

$languageFile  : string

Default language file of the extension linkvalidator

$languages  : string

Languages to check for broken links

$modTSconfig  : array<string|int, mixed>

Merged mod TSconfig

$page  : int

UID of the start page for this task

$runOnNextCronJob  : bool

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

$sleepAfterFinish  : int

$sleepTime  : int

$taskGroup  : int|null

Task group for this task

$taskNeedsUpdate  : bool

Defines if the task should be updated as some values have changed during task execution

$taskUid  : int

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

Methods

__construct()  : mixed

execute()  : bool

Function execute from the Scheduler

getAdditionalInformation()  : string

Returns the most important properties of the LinkValidator task as a comma separated string that will be displayed in the scheduler module.

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

validateTaskParameters()  : bool

extractPageId()  : int

getFluidEmail()  : FluidEmail

Get FluidEmail with template from the task configuration

getLanguageService()  : LanguageService|null

getLinkAnalyzerResult()  : LinkAnalyzerResult

Validate all broken links for pages set in the task configuration and return the analyzers result as object.

getLinkTypes()  : array<int, string>

Get the list of linkTypes to consider for fetching broken links

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

Get the list of fields to consider for fetching broken links

loadModTSconfig()  : void

Load and merge linkvalidator TSconfig from task configuration with page TSconfig

logException()  : mixed

reportEmail()  : bool

Build and send report email when broken links were found

setCliArguments()  : self

Simulate cli call with setting the required options to the $_SERVER['argv']

templateFilesExist()  : bool

Check if both template files (HTML and txt) exist under at least one template path