CInbox (Common-Inbox)  0.1
Common functionality for ingesting files for archiving.
Public Member Functions | Public Attributes | Private Member Functions | Private Attributes | List of all members
FileCV Class Reference

Public Member Functions

 __construct ($cv_type=self::CV_TYPE_PER_ITEM)
 
 log ($archive_item, $operator_name= 'auto', $entry_type=self::LOG_ENTRY_TYPE_MISC, $log_level=self::LOG_LEVEL_NORMAL, $comment= '')
 
 importlog ($archive_item, $filename, $operator_name= 'import-log', $entry_type=self::LOG_ENTRY_TYPE_MISC, $log_level=self::LOG_LEVEL_NORMAL)
 
 setOverrideLogfile ($filepath)
 

Public Attributes

const ARCHIVE_LOG_NAME = 'archive.log'
 
const ITEM_LOG_SUFFIX = '.log'
 
const ITEMLOG_DIR = 'HIRES'
 
const CV_TYPE_PER_ITEM = 0
 
const CV_TYPE_PER_ARCHIVE = 1
 
const CV_TYPE_PER_DIRECTORY = 2
 
const LOG_ENTRY_ALLOWED_TYPES = array('ADD','DEL','MOD','VFY','COR','DIV')
 
const LOG_ENTRY_TYPE_ADD = 'ADD'
 
const LOG_ENTRY_TYPE_DELETE = 'DEL'
 
const LOG_ENTRY_TYPE_MODIFY = 'MOD'
 
const LOG_ENTRY_TYPE_VERIFY = 'VFY'
 
const LOG_ENTRY_TYPE_CORRECTION = 'COR'
 
const LOG_ENTRY_TYPE_MISC = 'DIV'
 
const LOG_LEVEL_ALLOWED = array('E','A','W','N','I','D')
 
const LOG_LEVEL_ERROR = 'E'
 
const LOG_LEVEL_ALWAYS = 'A'
 
const LOG_LEVEL_WARNING = 'W'
 
const LOG_LEVEL_NORMAL = 'N'
 
const LOG_LEVEL_INFO = 'I'
 
const LOG_LEVEL_DEBUG = 'D'
 

Private Member Functions

 _get_file_path ($archive_item)
 
 _cvfile_append_line ($filename, $csv_fields)
 

Private Attributes

 $cv_type = self::CV_TYPE_PER_ITEM
 
 $override_logfile = false
 
 $escape_contents = true
 
 $csv_separator = ';'
 
 $csv_textquote = '"'
 

Member Function Documentation

FileCV::setOverrideLogfile (   $filepath)

Set a log file path/name to override the default derived from the archive item's info. Set to empty or false to use default again.


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