contenido\classes\log\class.modulelog.php

Show: PublicProtectedPrivateinherited
Table of Contents
Project: Contenido Content Management System

Description: MySQL Driver for GenericDB

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.modulelog.php,v 1.3 2006/04/28 09:20:55 timo.hummel Exp $ }}  
Package
Contenido Backend classes  
Version
1.3  

\cModuleLog
jump to top

Package: Default
Parent(s)
\cBufferedLog < \cLog

Properties

>VPropertypublicarray $_aMessages
inherited

Contains all buffered messages to be written

Inherited from: \cBufferedLog::$$_aMessages
Details
Type
array
Access
private  
Inherited_from
\cBufferedLog::$$_aMessages  
>VPropertypublicarray $_aShortcutHandlers
inherited

Contains all shortcut handlers

Inherited from: \cLog::$$_aShortcutHandlers\cBufferedLog::$$_aShortcutHandlers
Details
Type
array
Access
private  
Inherited_from
\cLog::$$_aShortcutHandlers  
Inherited_from
\cBufferedLog::$$_aShortcutHandlers  
>VPropertypublicobject $_oLogger
inherited

Contains the logger object

Inherited from: \cLog::$$_oLogger\cBufferedLog::$$_oLogger
Details
Type
object
Access
private  
Inherited_from
\cLog::$$_oLogger  
Inherited_from
\cBufferedLog::$$_oLogger  
>VPropertypublic$_oModule
Details
Type
n/a
>VPropertypublicstring $_sLogFormat
inherited

Contains the Log Format string

Inherited from: \cLog::$$_sLogFormat\cBufferedLog::$$_sLogFormat
Details
Type
string
Access
private  
Inherited_from
\cLog::$$_sLogFormat  
Inherited_from
\cBufferedLog::$$_sLogFormat  

Methods

methodpublic_setShortcutHandler(\sShortcut $sShortcut, \sHandloer $sHandler) : boolean
inherited

_setShortcutHandler: Defines a custom shortcut handler.

Inherited from: \cLog::_setShortcutHandler()\cBufferedLog::_setShortcutHandler()

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

Parameters
NameTypeDescription
$sShortcut\sShortcut

string Shortcut name

$sHandler\sHandloer

string Name of the function to call

Returns
TypeDescription
booleanTrue if set was successful
Details
Access
public  
methodpublic_shDate() : \The
inherited

_shDate: Returns the current date

Inherited from: \cLog::_shDate()\cBufferedLog::_shDate()
Returns
TypeDescription
\Thecurrent date
Details
Access
public  
methodpublic_shLevel( $message,  $loglevel) : \The
inherited

_shLevel: Returns the canonical name of the priority.

Inherited from: \cLog::_shLevel()\cBufferedLog::_shLevel()

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

Parameters
NameTypeDescription
$message
$loglevel
Returns
TypeDescription
\Thecanonical log level
Details
Access
public  
methodpublic_shMessage( $message,  $loglevel) : \The
inherited

_shMessage: Returns the log message.

Inherited from: \cLog::_shMessage()\cBufferedLog::_shMessage()
Parameters
NameTypeDescription
$message
$loglevel
Returns
TypeDescription
\Thelog message
Details
Access
public  
methodpublic_shModule() : \id

_shModule: shortcut handler for the module id / name

Returns
TypeDescription
\idand name of the module
Details
Access
public  
methodpublic_shSession() : \The
inherited

_shSession: Returns the current session, if existant

Inherited from: \cLog::_shSession()\cBufferedLog::_shSession()
Returns
TypeDescription
\Thecurrent session
Details
Access
public  
methodpublicbuffer(\sMessage $sMessage, \bPriority $iPriority = null) : \none
inherited

buffer: Puts a log message on the buffering stack

Inherited from: \cBufferedLog::buffer()
Parameters
NameTypeDescription
$sMessage\sMessage

string Message to log

$iPriority\bPriority

integer PEAR Loglevel (or default if null / omitted)

Returns
TypeDescription
\none
Details
Access
public  
methodpubliccBufferedLog(\oLogger $oLogger = false) : array
inherited

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

Inherited from: \cBufferedLog::cBufferedLog()

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

Parameters
NameTypeDescription
$oLogger\oLogger

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

Returns
TypeDescription
arrayBeschreibung
Details
Access
public  
See
\cLog  
methodpubliccLog(\oLogger $oLogger = false) : \none
inherited

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

Inherited from: \cLog::cLog()\cBufferedLog::cLog()

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.

Parameters
NameTypeDescription
$oLogger\oLogger

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

Returns
TypeDescription
\none
Details
Access
public  
methodpubliccModuleLog(\oLogger $oLogger = false, \idmod $idmod = 0) : void

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

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

Parameters
NameTypeDescription
$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

Details
Access
public  
See
\cBufferedLog  
methodpubliccommit() : \none

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

Returns
TypeDescription
\none
Details
Access
public  
methodpubliclog(\sMessage $sMessage, \bPriority $bPriority = null) : \none
inherited

log: Logs a message using the logger object

Inherited from: \cLog::log()\cBufferedLog::log()
Parameters
NameTypeDescription
$sMessage\sMessage

string Message to log

$bPriority\bPriority

integer PEAR Loglevel (or default if null / omitted)

Returns
TypeDescription
\none
Details
Access
public  
methodpublicrevoke() : \none
inherited

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

Inherited from: \cBufferedLog::revoke()
Returns
TypeDescription
\none
Details
Access
public  
methodpublicsetLogFormat(\sLogFormat $sLogFormat) : \none
inherited

setLogFormat: Sets user-defined log formats

Inherited from: \cLog::setLogFormat()\cBufferedLog::setLogFormat()

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

Parameters
NameTypeDescription
$sLogFormat\sLogFormat

string Format string

Returns
TypeDescription
\none
Details
Access
public  
methodpublicsetModule(\idmod $idmod) : void

setModule: Sets the module to use.

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

Parameters
NameTypeDescription
$idmod\idmod

integer The module ID to use

Details
Access
public  
Documentation was generated by phpDocumentor 2.0.0a12.