CInbox (Common-Inbox)  0.1
Common functionality for ingesting files for archiving.
Public Member Functions | Public Attributes
TaskFilesWait Class Reference
Inheritance diagram for TaskFilesWait:
TaskFilesMatch CITask

List of all members.

Public Member Functions

 __construct (&$CIFolder)

Public Attributes

const TASK_LABEL = 'Wait for files'
Task Settings

Names of config settings used by this task

const CONF_FILES_WAIT = 'FILES_WAIT'
 Patterns of files to wait for.

Common task functions

 init ()
 run ()
 loadSettings ()

Detailed Description

Checks if certain file/folder entries in this folder are present which are configured as FILES_WAIT.

This is handy in cases where an Item is incomplete for a longer period of time, and considered ready for processing until certain files are present.

See also:
TaskFilesMustExist
Author:
Peter Bubestinger-Steindl (pb@av-rd.com)
See also:

Member Function Documentation

Prepare everything so it's ready for processing.

Return values:
booleanTrue if task shall proceed. False if not.

Reimplemented from TaskFilesMatch.

TaskFilesWait::loadSettings ( ) [protected]

Load settings from config that are relevant for this task.

Return values:
booleanTrue if everything went fine. False if not.

Reimplemented from CITask.

Perform the actual steps of this task.

Return values:
booleanTrue if task shall proceed. False if not.

Reimplemented from CITask.


The documentation for this class was generated from the following file:
 All Classes Functions Variables