Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
ScheduledTaskTool Class Reference
Inheritance diagram for ScheduledTaskTool:
CommandLineTool runScheduledTasks

Public Member Functions

 execute ()
 
 executeTask ($className, $args)
 
 parseTasks ($file)
 
 ScheduledTaskTool ($argv=array())
 
 usage ()
 

Additional Inherited Members

- Public Attributes inherited from CommandLineTool
 $argv
 

Detailed Description

CLI tool to execute a set of scheduled tasks.

Definition at line 24 of file ScheduledTaskTool.inc.php.

Member Function Documentation

ScheduledTaskTool::execute ( )

Parse and execute the scheduled tasks.

Definition at line 65 of file ScheduledTaskTool.inc.php.

References parseTasks().

ScheduledTaskTool::executeTask (   $className,
  $args 
)

Execute the specified task.

Parameters
$classNamestring the class name to execute
$argsarray the array of arguments to pass to the class constructors

Definition at line 107 of file ScheduledTaskTool.inc.php.

Referenced by parseTasks().

ScheduledTaskTool::parseTasks (   $file)

Parse and execute the scheduled tasks in the specified file.

Parameters
$filestring

Definition at line 73 of file ScheduledTaskTool.inc.php.

References ScheduledTaskHelper\checkFrequency(), executeTask(), and ScheduledTaskHelper\getTaskArgs().

Referenced by execute().

ScheduledTaskTool::ScheduledTaskTool (   $argv = array())

Constructor.

Parameters
$argvarray command-line arguments If specified, the first parameter should be the path to a tasks XML descriptor file (other than the default)

Definition at line 37 of file ScheduledTaskTool.inc.php.

References CommandLineTool\$argv, and DAORegistry\getDAO().

ScheduledTaskTool::usage ( )

Print command usage information.

Definition at line 57 of file ScheduledTaskTool.inc.php.


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