Inheritance diagram for ScheduledTask:

Public Member Functions
	__construct ($args=array())

	addExecutionLogEntry ($message, $type=null)

	execute ()

	getHelper ()

	getName ()

	getProcessId ()

Protected Member Functions
	executeActions ()

Detailed Description

Base class for executing scheduled tasks. All scheduled task classes must extend this class and implement execute().

See also: ScheduledTaskDAO

Definition at line 20 of file ScheduledTask.inc.php.

Constructor & Destructor Documentation

◆ __construct()

ScheduledTask::__construct ( $args = array() )

Constructor.

Parameters

$args array

Reimplemented in FileLoader, and UsageStatsLoader.

Definition at line 51 of file ScheduledTask.inc.php.

References getName(), getProcessId(), and AppLocale\requireComponents().

Member Function Documentation

◆ addExecutionLogEntry()

ScheduledTask::addExecutionLogEntry	(	$message,
		$type = `null`
	)

Add an entry into the execution log.

Parameters

$message	string A translated message.
$type	string (optional) One of the ScheduledTaskHelper SCHEDULED_TASK_MESSAGE_TYPE... constants.

Definition at line 111 of file ScheduledTask.inc.php.

References fatalError(), and Core\getCurrentDate().

Referenced by FileLoader\checkFolderStructure(), execute(), UsageStatsLoader\executeActions(), FileLoader\executeActions(), FileLoader\moveFile(), and UsageStatsLoader\processFile().

◆ execute()

ScheduledTask::execute ( )

Make sure the execution process follow the required steps. This is not the method one should extend to implement the task actions, for this see ScheduledTask::executeActions().

Returns: boolean Whether or not the task was succesfully executed.

Definition at line 154 of file ScheduledTask.inc.php.

References addExecutionLogEntry(), executeActions(), getHelper(), getName(), and Config\getVar().

◆ executeActions()

ScheduledTask::executeActions ( )

abstractprotected

Implement this method to execute the task actions.

Returns: boolean true iff success

Reimplemented in FileLoader, ReviewReminder, UsageStatsLoader, StatisticsReport, and PublishSubmissions.

Referenced by execute().

◆ getHelper()

ScheduledTask::getHelper ( )

Get scheduled task helper object.

Returns: ScheduledTaskHelper

Definition at line 91 of file ScheduledTask.inc.php.

Referenced by execute().

◆ getName()

ScheduledTask::getName ( )

Get the scheduled task name. Override to define a custom task name.

Returns: string

Reimplemented in UsageStatsLoader, StatisticsReport, ReviewReminder, and PublishSubmissions.

Definition at line 101 of file ScheduledTask.inc.php.

Referenced by __construct(), and execute().

◆ getProcessId()

ScheduledTask::getProcessId ( )

Get this process id.

Returns: int

Definition at line 83 of file ScheduledTask.inc.php.

Referenced by __construct().

The documentation for this class was generated from the following file:

ScheduledTask.inc.php

Public Member Functions

Protected Member Functions