|
CInbox (Common-Inbox)
0.1
Common functionality for ingesting files for archiving.
|
Public Member Functions | |
| run () | |
| getFilename () | |
 Public Member Functions inherited from TaskDirListing | |
| __construct (&$CIFolder) | |
| init () | |
| run () | |
| Public Member Functions inherited from CITask | |
| __construct (&$CIFolder, $label) | |
| getName () | |
| setLabel ($label) | |
| getLabel () | |
| setDescription ($description) | |
| getDescription () | |
| skip () | |
| skipIt () | |
| setItemSubDirs ($itemSubDirs) | |
| getStatus () | |
| statusUndefined () | |
| statusRunning () | |
| statusWait () | |
| statusDone () | |
| statusPBCT () | |
| statusPBC () | |
| statusSkipped () | |
| statusError () | |
| statusConfigError () | |
| init () | |
| run () | |
| finalize () | |
Static Public Member Functions | |
| static | getDirListAsCSV ($dirList) |
| Static Public Member Functions inherited from TaskDirListing | |
| static | generateDirListArray ($folderName) |
| Static Public Member Functions inherited from CITask | |
| static | isRecursive () |
| static | oncePerItem () |
| static | getTaskByName ($taskName, $CIFolder) |
| static | getTaskClassName ($taskName) |
Public Attributes | |
| const | TASK_LABEL = 'Directory listing (CSV)' |
| const | FILE_SUFFIX = 'csv' |
| Public Attributes inherited from TaskDirListing | |
| const | TASK_LABEL = 'Directory listing (base)' |
| const | ONCE_PER_ITEM = true |
| const | CONF_DIRLIST_FILE = 'DIRLIST_FILE' |
| Public Attributes inherited from CITask | |
| const | STATUS_UNDEFINED = 0 |
| Undefined. Default unless task changes it. | |
| const | STATUS_RUNNING = 1 |
| Undefined, but indicates that the task is in progress. | |
| const | STATUS_WAIT = 2 |
| Task decided that Item is not ready yet and shall be moved back to 'to-do'. | |
| const | STATUS_DONE = 5 |
| Success! This means the task completed successfully. | |
| const | STATUS_PBCT = 6 |
| There were problems, but the task may continue. | |
| const | STATUS_PBC = 7 |
| There were problems, but subsequent task may continue. | |
| const | STATUS_ERROR = 10 |
| An error occurred. Abort execution as soon as possible. | |
| const | STATUS_CONFIG_ERROR = 11 |
| If a config option was not valid. | |
| const | STATUS_SKIPPED = 15 |
| If task was skipped. | |
| const | ONCE_PER_ITEM = false |
| True: Run this task only once per item. | |
| const | IS_RECURSIVE = false |
| Default (false): one task = one folder. True: The task performs actions on subfolders too. | |
| const | CONF_COPY_EXCLUDE = 'COPY_EXCLUDE' |
| Patterns which files to exclude from copying. | |
| const | MASK_TARGET_TEMP = 'temp_%s' |
Static Protected Attributes | |
| static | $formatFileTime = DateTime::ISO8601 |
| Static Protected Attributes inherited from CITask | |
| static | $statusGlobal |
| Status of the sum of tasks of this type. // TODO! Implement and use this. | |
Additional Inherited Members | |
| Protected Member Functions inherited from TaskDirListing | |
| loadSettings () | |
| saveToFile ($fileName) | |
| Protected Member Functions inherited from CITask | |
| setName ($name) | |
| exclude ($file, $excludePatterns) | |
| optionIsArray ($option, $optionName) | |
| resolveTargetFolderTemp ($CIFolder=null) | |
| setStatus ($status) | |
| setStatusUndefined () | |
| setStatusRunning () | |
| setStatusWait () | |
| setStatusDone () | |
| setStatusPBCT () | |
| setStatusPBC () | |
| setStatusSkipped () | |
| setStatusError () | |
| setStatusConfigError () | |
| checkTempFolder () | |
| getTempFolder () | |
| setTempFolder ($tempFolder=null) | |
| loadSettings () | |
| Protected Attributes inherited from TaskDirListing | |
| $tempFile | |
| $dirListFilename | |
| $dirListFile | |
| $dirList | |
| $dirListing | |
| Protected Attributes inherited from CITask | |
| $logger | |
| Logging handler. | |
| $name | |
| Class name of this task. | |
| $label | |
| Human readable Task label. | |
| $description | |
| Human readable description of Task's purpose/actions. | |
| $CIFolder | |
| CIFolder object that provides all information needed for this task. | |
| $sourceFolder | |
| Source folder of this task. | |
| $targetFolder | |
| Target folder of this task (read from config). | |
| $targetFolderTemp | |
| Temporary name of Target folder of this task. Used until inbox processing completed successfully. | |
| $itemSubDirs | |
| Array of Item subfolders: key=foldername, value=CIFolder (initialized with its config). | |
| $tempFolder | |
| Path of the temp folder for this task. | |
| $copyExclude | |
| Contains the value of CONF_COPY_EXCLUDE. | |
| $skip = false | |
| True: Skip execution. Default=false (=normal execution). | |
| $status | |
| Status of this task (=for current item subfolder). | |
Saves a directory listing in CSV format. It adds the file suffix 'self::FILE_SUFFIX', which defaults to "csv". Relies on TaskDirListing to create a list of files/folders of this item.
| TaskDirListCSV::getFilename | ( | ) |
Returns the actual filename (including path) for the directory listing.
| TaskDirListCSV::run | ( | ) |
Perform the actual steps of this task.
1.8.11
