Open Journal Systems
3.3.0
|
Public Member Functions | |
__construct ($args=array()) | |
addExecutionLogEntry ($message, $type=null) | |
execute () | |
getHelper () | |
getName () | |
getProcessId () | |
Protected Member Functions | |
executeActions () | |
Base class for executing scheduled tasks. All scheduled task classes must extend this class and implement execute().
Definition at line 20 of file ScheduledTask.inc.php.
ScheduledTask::__construct | ( | $args = array() | ) |
Constructor.
$args | array |
Reimplemented in FileLoader, UsageStatsLoader, CrossrefInfoSender, DataciteInfoSender, DOAJInfoSender, MedraInfoSender, and Depositor.
Definition at line 51 of file ScheduledTask.inc.php.
References getName(), getProcessId(), and AppLocale\requireComponents().
ScheduledTask::addExecutionLogEntry | ( | $message, | |
$type = null |
|||
) |
Add an entry into the execution log.
$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 DOAJInfoSender\_addLogEntry(), CrossrefInfoSender\_addLogEntry(), MedraInfoSender\_addLogEntry(), DataciteInfoSender\_addLogEntry(), CrossrefInfoSender\_getJournals(), MedraInfoSender\_getJournals(), DataciteInfoSender\_getJournals(), Depositor\_processNeedPackaging(), Depositor\_processNeedTransferring(), Depositor\_processStatusUpdates(), FileLoader\checkFolderStructure(), execute(), Depositor\executeActions(), UsageStatsLoader\executeActions(), FileLoader\executeActions(), FileLoader\moveFile(), and UsageStatsLoader\processFile().
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().
Definition at line 154 of file ScheduledTask.inc.php.
References addExecutionLogEntry(), executeActions(), getHelper(), getName(), and Config\getVar().
|
abstractprotected |
Implement this method to execute the task actions.
Reimplemented in SubscriptionExpiryReminder, FileLoader, ReviewReminder, UsageStatsLoader, OpenAccessNotification, CrossrefInfoSender, DataciteInfoSender, DOAJInfoSender, MedraInfoSender, StatisticsReport, Depositor, and PublishSubmissions.
Referenced by execute().
ScheduledTask::getHelper | ( | ) |
Get scheduled task helper object.
Definition at line 91 of file ScheduledTask.inc.php.
Referenced by execute().
ScheduledTask::getName | ( | ) |
Get the scheduled task name. Override to define a custom task name.
Reimplemented in UsageStatsLoader, CrossrefInfoSender, DataciteInfoSender, DOAJInfoSender, MedraInfoSender, StatisticsReport, Depositor, ReviewReminder, OpenAccessNotification, SubscriptionExpiryReminder, and PublishSubmissions.
Definition at line 101 of file ScheduledTask.inc.php.
Referenced by __construct(), and execute().
ScheduledTask::getProcessId | ( | ) |
Get this process id.
Definition at line 83 of file ScheduledTask.inc.php.
Referenced by __construct().