Class: Log_display

Source Location: /pear/Log/display.php

Class Overview

Log
   |
   --Log_display

The Log_display class is a concrete implementation of the Log:: abstract class which writes message into browser in usual PHP maner.

Author(s):

Paul Yanchenko <pusher@inaco.ru>

Methods

Inherited Methods

Class: Log

Log::alert(): A convenience function for logging an alert event. It will log a message at the PEAR_LOG_ALERT log level.
Log::attach(): Adds a Log_observer instance to the list of observers that are listening for messages emitted by this Log instance.
Log::close(): Abstract implementation of the close() method.
Log::crit(): A convenience function for logging a critical event. It will log a message at the PEAR_LOG_CRIT log level.
Log::debug(): A convenience function for logging a debug event. It will log a message at the PEAR_LOG_DEBUG log level.
Log::detach(): Removes a Log_observer instance from the list of observers.
Log::emerg(): A convenience function for logging a emergency event. It will log a message at the PEAR_LOG_EMERG log level.
Log::err(): A convenience function for logging a error event. It will log a message at the PEAR_LOG_ERR log level.
Log::factory(): Attempts to return a concrete Log instance of type $handler.
Log::flush(): Abstract implementation of the flush() method.
Log::getIdent(): Returns the current identification string.
Log::getMask(): Returns the current level mask.
Log::getPriority(): Returns the current default priority.
Log::info(): A convenience function for logging a information event. It will log a message at the PEAR_LOG_INFO log level.
Log::isComposite(): Indicates whether this is a composite class.
Log::log(): Abstract implementation of the log() method.
Log::MASK(): Calculate the log mask for the given priority.
Log::MAX(): Calculate the log mask for all priorities less than or equal to the given priority. In other words, $priority will be the highests priority matched by the resulting mask.
Log::MIN(): Calculate the log mask for all priorities greater than or equal to the given priority. In other words, $priority will be the lowest priority matched by the resulting mask.
Log::notice(): A convenience function for logging a notice event. It will log a message at the PEAR_LOG_NOTICE log level.
Log::open(): Abstract implementation of the open() method.
Log::priorityToString(): Returns the string representation of a PEAR_LOG_* integer constant.
Log::setIdent(): Sets this Log instance's identification string.
Log::setMask(): Set and return the level mask for the current Log instance.
Log::setPriority(): Sets the default priority to the specified value.
Log::singleton(): Attempts to return a reference to a concrete Log instance of type $handler, only creating a new instance if no log instance with the same parameters currently exists.
Log::stringToPriority(): Returns the the PEAR_LOG_* integer constant for the given string representation of a priority name. This function performs a case-insensitive search.
Log::UPTO(): Calculate the log mask for all priorities up to the given priority.
Log::warning(): A convenience function for logging a warning event. It will log a message at the PEAR_LOG_WARNING log level.

Class Details

[line 22]
The Log_display class is a concrete implementation of the Log:: abstract class which writes message into browser in usual PHP maner.

This may be useful because when you use PEAR::setErrorHandling in PEAR_ERROR_CALLBACK mode error messages are not displayed by PHP error handler.

Tags:

author:	Paul Yanchenko <pusher@inaco.ru>
since:	Log 1.8.0
example:	example not found

[ Top ]

Class Methods

constructor Log_display [line 54]

Log_display Log_display(
[string
$name = ''], [string
$ident = ''], [array
$conf = array()], [int
$level = PEAR_LOG_DEBUG])

Constructs a new Log_display object.

Tags:

access:

public

Parameters:

string	$name	Ignored.
string	$ident	The identity string.
array	$conf	The configuration array.
int	$level	Log messages up to and including this level.

[ Top ]

method close [line 96]

void close(
)

Closes the display handler.

Tags:

since:	Log 1.9.6
access:	public

Overrides Log::close() (Abstract implementation of the close() method.)

[ Top ]

method log [line 114]

boolean log(
mixed
$message, [string
$priority = null])

Writes $message to the text browser. Also, passes the message along to any Log_observer instances that are observing this Log.

Tags:

return:	True on success or false on failure.
access:	public

Overrides Log::log() (Abstract implementation of the log() method.)

Parameters:

mixed	$message	String or object containing the message to log.
string	$priority	The priority of the message. Valid values are: PEAR_LOG_EMERG, PEAR_LOG_ALERT, PEAR_LOG_CRIT, PEAR_LOG_ERR, PEAR_LOG_WARNING, PEAR_LOG_NOTICE, PEAR_LOG_INFO, and PEAR_LOG_DEBUG.

[ Top ]

method open [line 84]

void open(
)

Opens the display handler.

Tags:

since:	Log 1.9.6
access:	public

Overrides Log::open() (Abstract implementation of the open() method.)

[ Top ]

Documentation generated on Sun, 08 Jan 2012 17:51:46 +0100 by phpDocumentor 1.4.3