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

List of all members.

Public Member Functions

 __construct (&$CIFolder)
 init ()
 run ()

Static Public Member Functions

static generateDirListArray ($folderName)

Public Attributes

const TASK_LABEL = 'Directory listing (base)'
const ONCE_PER_ITEM = true
 True: Run this task only once per item.
const CONF_DIRLIST_FILE = 'DIRLIST_FILE'

Protected Member Functions

 loadSettings ()
 saveToFile ($fileName)

Protected Attributes

 $tempFile
 $dirListFilename
 $dirListFile
 $dirList
 $dirListing

Detailed Description

Base class for preparing a directory listing.

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

Member Function Documentation

static TaskDirListing::generateDirListArray ( folderName) [static]

Traverses the directory structure starting in '$folderName', and returns an array, alphabetically sorted by filename, that contains key=filename, value=SplFileInfo Object.

Prepare everything so it's ready for processing.

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

Reimplemented from CITask.

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.

Reimplemented in TaskDirListCSV.

TaskDirListing::saveToFile ( fileName) [protected]

Writes the contents of $this->dirListing into a file. It will not overwrite an existing file.


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