contenido\classes\log\class.bufferedlog.php
Description: Buffered Log facility
Requirements:
- Author
- Timo A. Hummel
- Con_php_req
- 5.0
- Copyright
- four for business AG
- License
- http://www.contenido.org/license/LIZENZ.txt
- Link
- http://www.4fb.de
- Link
- {@internal created 2004-09-28 $Id: class.bufferedlog.php,v 1.2 2006/04/28 09:20:55 timo.hummel Exp $ }}
- Package
- Contenido Backend classes
- Version
- 1.2
\cBufferedLog
- Parent(s)
- \cLog
- Children
- \cModuleLog
Properties
Methods


_setShortcutHandler(\sShortcut $sShortcut, \sHandloer $sHandler) : boolean
_setShortcutHandler: Defines a custom shortcut handler.
Inherited from: \cLog::_setShortcutHandler()Each shortcut handler receives two parameters: - The message - The log level
Name | Type | Description |
---|---|---|
$sShortcut | \sShortcut | string Shortcut name |
$sHandler | \sHandloer | string Name of the function to call |
Type | Description |
---|---|
boolean | True if set was successful |
- Access
- public


_shLevel( $message, $loglevel) : \The
The canonical name is padded to 10 characters to achieve a better formatting.
Name | Type | Description |
---|---|---|
$message | ||
$loglevel |
Type | Description |
---|---|
\The | canonical log level |
- Access
- public


_shMessage( $message, $loglevel) : \The
Name | Type | Description |
---|---|---|
$message | ||
$loglevel |
Type | Description |
---|---|
\The | log message |
- Access
- public


buffer(\sMessage $sMessage, \bPriority $iPriority = null) : \none
buffer: Puts a log message on the buffering stack
Name | Type | Description |
---|---|---|
$sMessage | \sMessage | string Message to log |
$iPriority | \bPriority | integer PEAR Loglevel (or default if null / omitted) |
Type | Description |
---|---|
\none |
- Access
- public


cBufferedLog(\oLogger $oLogger = false) : array
cBufferedLog: Creates a new instance of the Contenido BufferedLog mechanism.
cBufferedLog is a logging facility which uses cLog to do its logging, and features buffered logging
Name | Type | Description |
---|---|---|
$oLogger | \oLogger | object The object to use for logging, or false if a new one should be created. |
Type | Description |
---|---|
array | Beschreibung |
- Access
- public
- See
- \cLog


cLog(\oLogger $oLogger = false) : \none
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.
Name | Type | Description |
---|---|---|
$oLogger | \oLogger | mixed Logger object (any subclass of PEAR::Log), or false if cLog should handle the logger creation |
Type | Description |
---|---|
\none |
- Access
- public


commit() : \none
commit: Commits all messages which are queued on the stack
Type | Description |
---|---|
\none |
- Access
- public


log(\sMessage $sMessage, \bPriority $bPriority = null) : \none
Name | Type | Description |
---|---|---|
$sMessage | \sMessage | string Message to log |
$bPriority | \bPriority | integer PEAR Loglevel (or default if null / omitted) |
Type | Description |
---|---|
\none |
- Access
- public


revoke() : \none
revoke: Revoke (discards) all messages which are queued on the stack
Type | Description |
---|---|
\none |
- Access
- public