Open Journal Systems
3.3.0
|
Public Member Functions | |
__construct ($args) | |
checkFolderStructure ($install=false) | |
getArchivePath () | |
getCompressArchives () | |
getProcessingPath () | |
getRejectPath () | |
getStagePath () | |
setCompressArchives ($compressArchives) | |
Public Member Functions inherited from ScheduledTask | |
addExecutionLogEntry ($message, $type=null) | |
execute () | |
getHelper () | |
getName () | |
getProcessId () | |
Protected Member Functions | |
executeActions () | |
moveFile ($sourceDir, $destDir, $filename) | |
processFile ($filePath) | |
Base scheduled task class to reliably handle files processing.
Definition at line 26 of file FileLoader.inc.php.
FileLoader::__construct | ( | $args | ) |
Constructor.
$args | array script arguments |
Reimplemented from ScheduledTask.
Reimplemented in UsageStatsLoader.
Definition at line 92 of file FileLoader.inc.php.
References DAORegistry\getDAO(), and AppLocale\requireComponents().
FileLoader::checkFolderStructure | ( | $install = false | ) |
A public helper function that can be used to ensure that the file structure has actually been installed.
$install | boolean Set this parameter to true to install the folder structure if it is missing. |
Definition at line 233 of file FileLoader.inc.php.
References ScheduledTask\addExecutionLogEntry(), and Config\getVar().
Referenced by UsageStatsLoader\__construct(), and executeActions().
|
protected |
Implement this method to execute the task actions.
Reimplemented from ScheduledTask.
Reimplemented in UsageStatsLoader.
Definition at line 186 of file FileLoader.inc.php.
References ScheduledTask\addExecutionLogEntry(), checkFolderStructure(), and processFile().
FileLoader::getArchivePath | ( | ) |
FileLoader::getCompressArchives | ( | ) |
Return whether the archives must be compressed or not.
Definition at line 167 of file FileLoader.inc.php.
FileLoader::getProcessingPath | ( | ) |
Return the processing path.
Definition at line 143 of file FileLoader.inc.php.
Referenced by UsageStatsLoader\autoStage(), and UsageStatsLoader\executeActions().
FileLoader::getRejectPath | ( | ) |
FileLoader::getStagePath | ( | ) |
Return the staging path.
Definition at line 135 of file FileLoader.inc.php.
Referenced by UsageStatsLoader\autoStage().
|
protected |
Move file between filesystem directories.
$sourceDir | string |
$destDir | string |
$filename | string |
Definition at line 295 of file FileLoader.inc.php.
References ScheduledTask\addExecutionLogEntry(), and fatalError().
Referenced by UsageStatsLoader\autoStage().
|
abstractprotected |
Process the passed file.
$filePath | string |
Reimplemented in UsageStatsLoader.
Referenced by executeActions().
FileLoader::setCompressArchives | ( | $compressArchives | ) |
Set whether the archives must be compressed or not.
$compressArchives | boolean |
Definition at line 175 of file FileLoader.inc.php.
Referenced by UsageStatsLoader\__construct().