ValidatorTask extends AbstractTask

This class provides Scheduler plugin implementation

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

$scheduler  : Scheduler|null

Reference to a scheduler object

$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

Constructor

areMultipleExecutionsAllowed()  : bool

Returns TRUE if several runs of the task are allowed concurrently

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.

getConfiguration()  : string

Get the value of the protected property configuration

getDepth()  : int

Get the value of the protected property depth

getDescription()  : string

This method returns the description of the task

getEmail()  : string

Get the value of the protected property email

getEmailOnBrokenLinkOnly()  : bool

Get the value of the protected property emailOnBrokenLinkOnly

getEmailTemplateName()  : string

Get the value of the protected property emailTemplateName

getExecution()  : Execution

Returns the execution object

getExecutionTime()  : int

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

getLanguages()  : string

Get the value of the protected property languages

getNextDueExecution()  : int

Returns the timestamp for next due execution of the task

getPage()  : int

Get the value of the protected property page

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.

setConfiguration()  : self

Set the value of the private property configuration

setDepth()  : self

Set the value of the private property depth

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

setEmail()  : self

Set the value of the private property email.

setEmailOnBrokenLinkOnly()  : self

Set the value of the private property emailOnBrokenLinkOnly

setEmailTemplateName()  : self

Set the value of the private property emailTemplateName

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

setLanguages()  : self

Set the value of the private property languages

setPage()  : self

Set the value of the private property page

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.

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