Public Member Functions | |
| __construct ($argv=array()) | |
| execute () | |
| executeTask ($className, $args) | |
| parseTasks ($file) | |
| usage () | |
Data Fields | |
| $file | |
| $taskDao | |
 Data Fields inherited from CommandLineTool | |
| $argv | |
| $scriptName | |
Detailed Description
CLI tool to execute a set of scheduled tasks.
Definition at line 24 of file ScheduledTaskTool.inc.php.
Constructor & Destructor Documentation
◆ __construct()
| ScheduledTaskTool::__construct | ( | $argv = array() | ) |
Constructor.
- Parameters
-
$argv array command-line arguments If specified, the first parameter should be the path to a tasks XML descriptor file (other than the default)
Reimplemented from CommandLineTool.
Reimplemented in runScheduledTasks.
Definition at line 43 of file ScheduledTaskTool.inc.php.
References CommandLineTool\$argv, and DAORegistry\getDAO().
Member Function Documentation
◆ execute()
| ScheduledTaskTool::execute | ( | ) |
Parse and execute the scheduled tasks.
Definition at line 71 of file ScheduledTaskTool.inc.php.
References parseTasks().
◆ executeTask()
| ScheduledTaskTool::executeTask | ( | $className, | |
| $args | |||
| ) |
Execute the specified task.
- Parameters
-
$className string the class name to execute $args array the array of arguments to pass to the class constructors
Definition at line 110 of file ScheduledTaskTool.inc.php.
References fatalError(), and instantiate().
Referenced by parseTasks().
◆ parseTasks()
| ScheduledTaskTool::parseTasks | ( | $file | ) |
Parse and execute the scheduled tasks in the specified file.
- Parameters
-
$file string
Definition at line 79 of file ScheduledTaskTool.inc.php.
References $file, ScheduledTaskHelper\checkFrequency(), executeTask(), and ScheduledTaskHelper\getTaskArgs().
Referenced by execute().
◆ usage()
| ScheduledTaskTool::usage | ( | ) |
Print command usage information.
Reimplemented from CommandLineTool.
Definition at line 63 of file ScheduledTaskTool.inc.php.
Field Documentation
◆ $file
| string ScheduledTaskTool::$file |
the XML file listing the tasks to be executed
Definition at line 29 of file ScheduledTaskTool.inc.php.
Referenced by parseTasks().
◆ $taskDao
| ScheduledTaskDAO ScheduledTaskTool::$taskDao |
the DAO object
Definition at line 35 of file ScheduledTaskTool.inc.php.
The documentation for this class was generated from the following file:
