Methods

_setShortcutHandler: Defines a custom shortcut handler.

_setShortcutHandler(\sShortcut $sShortcut, \sHandloer $sHandler) : boolean
Inherited

Each shortcut handler receives two parameters: - The message - The log level

access public
inherited_from \cLog::_setShortcutHandler()
inherited_from \cBufferedLog::_setShortcutHandler()

Parameters

$sShortcut

\sShortcut

string Shortcut name

$sHandler

\sHandloer

string Name of the function to call

Returns

booleanTrue if set was successful

_shDate: Returns the current date

_shDate() : \The
Inherited

access public
inherited_from \cLog::_shDate()
inherited_from \cBufferedLog::_shDate()

Returns

\Thecurrent date

_shLevel: Returns the canonical name of the priority.

_shLevel($message, $loglevel) : \The
Inherited

The canonical name is padded to 10 characters to achieve a better formatting.

access public
inherited_from \cLog::_shLevel()
inherited_from \cBufferedLog::_shLevel()

Parameters

$message

$loglevel

Returns

\Thecanonical log level

_shMessage: Returns the log message.

_shMessage($message, $loglevel) : \The
Inherited

access public
inherited_from \cLog::_shMessage()
inherited_from \cBufferedLog::_shMessage()

Parameters

$message

$loglevel

Returns

\Thelog message

_shModule: shortcut handler for the module id / name

_shModule() : \id

access public

Returns

\idand name of the module

_shSession: Returns the current session, if existant

_shSession() : \The
Inherited

access public
inherited_from \cLog::_shSession()
inherited_from \cBufferedLog::_shSession()

Returns

\Thecurrent session

buffer: Puts a log message on the buffering stack

buffer(\sMessage $sMessage, \bPriority $iPriority) : \none
Inherited

access public
inherited_from \cBufferedLog::buffer()

Parameters

$sMessage

\sMessage

string Message to log

$iPriority

\bPriority

integer PEAR Loglevel (or default if null / omitted)

Returns

\none

cBufferedLog: Creates a new instance of the Contenido BufferedLog mechanism.

cBufferedLog(\oLogger $oLogger) : array
Inherited

cBufferedLog is a logging facility which uses cLog to do its logging, and features buffered logging

see \cLog
access public
inherited_from \cBufferedLog::cBufferedLog()

Parameters

$oLogger

\oLogger

object The object to use for logging, or false if a new one should be created.

Returns

arrayBeschreibung

cLog: Creates a new instance of the Contenido Log mechanism.

cLog(\oLogger $oLogger) : \none
Inherited

cLog is a logging facility which uses PEAR::Log to do its logging, and features log categories.

The log format interface of cLog is capable of being extended by subclasses. See the note about the log shortcuts below.

About Log Shortcuts

Log shortcuts are placeholders which are replaced when a log entry is created. Placeholders start with a percentage sign (%) and contain one or more characters. Each placeholder is handled by an own function which decides what to do.

access public
inherited_from \cLog::cLog()
inherited_from \cBufferedLog::cLog()

Parameters

$oLogger

\oLogger

mixed Logger object (any subclass of PEAR::Log), or false if cLog should handle the logger creation

Returns

\none

cModuleLog: Creates a new instance of the Contenido ModuleLog mechanism.

cModuleLog(\oLogger $oLogger, \idmod $idmod) 

cModuleLog is a logging facility which uses cBufferedLog to do its logging, and features automatic module handling.

see \cBufferedLog
access public

Parameters

$oLogger

\oLogger

object The object to use for logging, or false if a new one should be created.

$idmod

\idmod

integer The module ID to use

commit: Appends "REQUEST END" to the stack and commits all messages which are queued on the stack

commit() : \none

access public

Returns

\none

log: Logs a message using the logger object

log(\sMessage $sMessage, \bPriority $bPriority) : \none
Inherited

access public
inherited_from \cLog::log()
inherited_from \cBufferedLog::log()

Parameters

$sMessage

\sMessage

string Message to log

$bPriority

\bPriority

integer PEAR Loglevel (or default if null / omitted)

Returns

\none

revoke: Revoke (discards) all messages which are queued on the stack

revoke() : \none
Inherited

access public
inherited_from \cBufferedLog::revoke()

Returns

\none

setLogFormat: Sets user-defined log formats

setLogFormat(\sLogFormat $sLogFormat) : \none
Inherited

The following placeholders are defined in this class: %date Date and Time %session Session-ID %level Log Level %message Message

access public
inherited_from \cLog::setLogFormat()
inherited_from \cBufferedLog::setLogFormat()

Parameters

$sLogFormat

\sLogFormat

string Format string

Returns

\none

setModule: Sets the module to use.

setModule(\idmod $idmod) 

setModule automatically buffers basic module information to the log to assist the developer in debugging his modules.

access public

Parameters

$idmod

\idmod

integer The module ID to use

 Properties

 

Contains all buffered messages to be written

$_aMessages : array
Inherited

access private
inherited_from \cBufferedLog::$$_aMessages
 

Contains all shortcut handlers

$_aShortcutHandlers : array
Inherited

access private
inherited_from \cLog::$$_aShortcutHandlers
inherited_from \cBufferedLog::$$_aShortcutHandlers
 

Contains the logger object

$_oLogger : object
Inherited

access private
inherited_from \cLog::$$_oLogger
inherited_from \cBufferedLog::$$_oLogger
 

$_oModule

$_oModule 

 

Contains the Log Format string

$_sLogFormat : string
Inherited

access private
inherited_from \cLog::$$_sLogFormat
inherited_from \cBufferedLog::$$_sLogFormat