Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
FileLoader Class Reference
Inheritance diagram for FileLoader:
ScheduledTask

Public Member Functions

 checkFolderStructure ($install=false)
 
 execute ()
 
 FileLoader ($args)
 
 getArchivePath ()
 
 getProcessingPath ()
 
 getRejectPath ()
 
 getStagePath ()
 
- Public Member Functions inherited from ScheduledTask
 execute ()
 

Protected Member Functions

 processFile ($filePath)
 

Additional Inherited Members

- Public Attributes inherited from ScheduledTask
 $args
 

Detailed Description

Base scheduled task class to reliably handle files processing.

Definition at line 26 of file FileLoader.inc.php.

Member Function Documentation

FileLoader::checkFolderStructure (   $install = false)

A public helper function that can be used to ensure that the file structure has actually been installed.

Parameters
$installboolean Set this parameter to true to install the folder structure if it is missing.
Returns
boolean True if the folder structure exists, otherwise false.

Definition at line 213 of file FileLoader.inc.php.

FileLoader::execute ( )

Execute the specified command.

Returns
boolean True if no errors, otherwise false.

Definition at line 173 of file FileLoader.inc.php.

FileLoader::FileLoader (   $args)

Constructor.

Parameters
$argsarray script arguments

Definition at line 92 of file FileLoader.inc.php.

FileLoader::getArchivePath ( )

Return the archive path.

Returns
string

Definition at line 160 of file FileLoader.inc.php.

FileLoader::getProcessingPath ( )

Return the processing path.

Returns
string

Definition at line 144 of file FileLoader.inc.php.

FileLoader::getRejectPath ( )

Return the reject path.

Returns
string

Definition at line 152 of file FileLoader.inc.php.

FileLoader::getStagePath ( )

Return the staging path.

Returns
string

Definition at line 136 of file FileLoader.inc.php.

FileLoader::processFile (   $filePath)
abstractprotected

Process the passed file.

Parameters
$filePathstring
Returns
mixed
See Also
FileLoader::execute to understand the expected return values.

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