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

List of all members.

Public Member Functions

 init ()

Public Attributes

const TASK_LABEL = 'Matching filenames (abstract)'

Protected Member Functions

Task-specific methods
 getMatchingFiles ($CIFolder, $patterns)
 getNonMatchingFiles ($CIFolder, $patterns)
 hasMissingFiles ($CIFolder, $patterns)

Detailed Description

Checks if entries in this folder (files/subfolders) exist, according to a given glob pattern.

This class is abstract and should be used as parent class for tasks that require checking existence of certain files.

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

Member Function Documentation

TaskFilesMatch::getMatchingFiles ( CIFolder,
patterns 
) [protected]

Returns array with files/folders within the folder that match the glob patterns in '$patterns'.

TaskFilesMatch::getNonMatchingFiles ( CIFolder,
patterns 
) [protected]

Returns array with files/folders within the folder that do *not* match the glob patterns in '$patterns'.

TaskFilesMatch::hasMissingFiles ( CIFolder,
patterns 
) [protected]

Checks for missing entries of files/folders in $CIFolder defined by $patterns.

Return values:
integerReturns the number of files missing.
booleanIf $pattern is empty, False is returned.

Prepare everything so it's ready for processing.

Reimplemented from CITask.

Reimplemented in TaskCleanFilenames, and TaskFilesWait.


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