Inheritance diagram for Log_firebug:

Collaboration diagram for Log_firebug:

Public Member Functions
	Log_firebug ($name= '', $ident= 'PHP', $conf=array(), $level=PEAR_LOG_DEBUG)
	Constructs a new Log_firebug object.
	open ()
	Opens the firebug handler.
	_Log_firebug ()
	Destructor.
	close ()
	Closes the firebug handler.
	flush ()
	Flushes all pending ("buffered") data.
	log ($message, $priority=null)
	Writes $message to Firebug console.
Public Member Functions inherited from Log
	_classExists ($class)
	Utility function which wraps PHP's class_exists() function to ensure consistent behavior between PHP versions 4 and 5.
&	factory ($handler, $name= '', $ident= '', $conf=array(), $level=PEAR_LOG_DEBUG)
	Attempts to return a concrete Log instance of type $handler.
&	singleton ($handler, $name= '', $ident= '', $conf=array(), $level=PEAR_LOG_DEBUG)
	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.
	emerg ($message)
	A convenience function for logging a emergency event.
	alert ($message)
	A convenience function for logging an alert event.
	crit ($message)
	A convenience function for logging a critical event.
	err ($message)
	A convenience function for logging a error event.
	warning ($message)
	A convenience function for logging a warning event.
	notice ($message)
	A convenience function for logging a notice event.
	info ($message)
	A convenience function for logging a information event.
	debug ($message)
	A convenience function for logging a debug event.
	_extractMessage ($message)
	Returns the string representation of the message data.
	_getBacktraceVars ($depth)
	Using debug_backtrace(), returns the file, line, and enclosing function name of the source code context from which log() was invoked.
	_format ($format, $timestamp, $priority, $message)
	Produces a formatted log line based on a format string and a set of variables representing the current log record and state.
	priorityToString ($priority)
	Returns the string representation of a PEAR_LOG_* integer constant.
	stringToPriority ($name)
	Returns the the PEAR_LOG_* integer constant for the given string representation of a priority name.
	MASK ($priority)
	Calculate the log mask for the given priority.
	UPTO ($priority)
	Calculate the log mask for all priorities up to the given priority.
	MIN ($priority)
	Calculate the log mask for all priorities greater than or equal to the given priority.
	MAX ($priority)
	Calculate the log mask for all priorities less than or equal to the given priority.
	setMask ($mask)
	Set and return the level mask for the current Log instance.
	getMask ()
	Returns the current level mask.
	_isMasked ($priority)
	Check if the given priority is included in the current level mask.
	getPriority ()
	Returns the current default priority.
	setPriority ($priority)
	Sets the default priority to the specified value.
	attach (&$observer)
	Adds a Log_observer instance to the list of observers that are listening for messages emitted by this Log instance.
	detach ($observer)
	Removes a Log_observer instance from the list of observers.
	_announce ($event)
	Informs each registered observer instance that a new message has been logged.
	isComposite ()
	Indicates whether this is a composite class.
	setIdent ($ident)
	Sets this Log instance's identification string.
	getIdent ()
	Returns the current identification string.

Data Fields
	$_buffering = false
	$_buffer = array()
	$_lineFormat = '%2$s [%3$s] %4$s'
	$_timeFormat = '%b %d %H:%M:%S'
	$_methods
Data Fields inherited from Log
	$_opened = false
	$_id = 0
	$_ident = ''
	$_priority = PEAR_LOG_INFO
	$_mask = PEAR_LOG_ALL
	$_listeners = array()
	$_formatMap

Detailed Description

Definition at line 21 of file firebug.php.

Member Function Documentation

Log_firebug::_Log_firebug ( )

Destructor.

Definition at line 120 of file firebug.php.

References close().

    {
        $this->close();
    }

Here is the call graph for this function:

Log_firebug::close ( )

Closes the firebug handler.

public

Reimplemented from Log.

Definition at line 130 of file firebug.php.

References flush().

Referenced by _Log_firebug().

    {
        $this->flush();
        $this->_opened = false;
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Log_firebug::flush ( )

Flushes all pending ("buffered") data.

public

Reimplemented from Log.

Definition at line 142 of file firebug.php.

Referenced by close().

                     {
        if (count($this->_buffer)) {
            print '<script type="text/javascript">';
            print "\nif (('console' in window) && ('firebug' in console)) {\n";
            foreach ($this->_buffer as $line) {
                print "  $line\n";
            }
            print "}\n";
            print "</script>\n";
        };
        $this->_buffer = array();
    }

Here is the caller graph for this function:

Log_firebug::log	(	$message,
		$priority = `null`
	)

Writes $message to Firebug console.

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

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.

Returns: boolean True on success or false on failure. public

Reimplemented from Log.

Definition at line 167 of file firebug.php.

References Log\$_priority, Log\_announce(), Log\_extractMessage(), Log\_format(), and Log\_isMasked().

    {
        /* If a priority hasn't been specified, use the default value. */
        if ($priority === null) {
            $priority = $this->_priority;
        }
        /* Abort early if the priority is above the maximum logging level. */
        if (!$this->_isMasked($priority)) {
            return false;
        }
        /* Extract the string representation of the message. */
        $message = $this->_extractMessage($message);
        $method  = $this->_methods[$priority];
        
        /* normalize line breaks */
        $message = str_replace("\r\n", "\n", $message);
        
        /* escape line breaks */
        $message = str_replace("\n", "\\n\\\n", $message);
        
        /* escape quotes */
        $message = str_replace('"', '\\"', $message);
        
        /* Build the string containing the complete log line. */
        $line = $this->_format($this->_lineFormat,
                               strftime($this->_timeFormat),
                               $priority, 
                               $message);
        if ($this->_buffering) {
            $this->_buffer[] = sprintf('console.%s("%s");', $method, $line);
        } else {
            print '<script type="text/javascript">';
            print "\nif (('console' in window) && ('firebug' in console)) {\n";
            /* Build and output the complete log line. */
            printf('  console.%s("%s");', $method, $line);
            print "\n}\n";
            print "</script>\n";
        }
        /* Notify observers about this log message. */
        $this->_announce(array('priority' => $priority, 'message' => $message));
        return true;
    }

Here is the call graph for this function:

Log_firebug::Log_firebug	(	$name = `''`,
		$ident = `'PHP'`,
		$conf = `array()`,
		$level = `PEAR_LOG_DEBUG`
	)

Constructs a new Log_firebug object.

Parameters

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

Definition at line 81 of file firebug.php.

References Log\UPTO().

    {
        $this->_id = md5(microtime());
        $this->_ident = $ident;
        $this->_mask = Log::UPTO($level);
        if (isset($conf['buffering'])) {
            $this->_buffering = $conf['buffering'];
        }
        if ($this->_buffering) {
            register_shutdown_function(array(&$this, '_Log_firebug'));
        }
        if (!empty($conf['lineFormat'])) {
            $this->_lineFormat = str_replace(array_keys($this->_formatMap),
                                             array_values($this->_formatMap),
                                             $conf['lineFormat']);
        }
        if (!empty($conf['timeFormat'])) {
            $this->_timeFormat = $conf['timeFormat'];
        }
    }

Here is the call graph for this function:

Log_firebug::open ( )

Opens the firebug handler.

public

Reimplemented from Log.

Definition at line 111 of file firebug.php.

    {
        $this->_opened = true;
        return true;
    }

Field Documentation

Log_firebug::$_buffer = array()

Definition at line 35 of file firebug.php.

Log_firebug::$_buffering = false

Definition at line 28 of file firebug.php.

Log_firebug::$_lineFormat = '%2$s [%3$s] %4$s'

Definition at line 42 of file firebug.php.

Log_firebug::$_methods

Initial value:

 array(
                        PEAR_LOG_EMERG   => 'error',
                        PEAR_LOG_ALERT   => 'error',
                        PEAR_LOG_CRIT    => 'error',
                        PEAR_LOG_ERR     => 'error',
                        PEAR_LOG_WARNING => 'warn',
                        PEAR_LOG_NOTICE  => 'info',
                        PEAR_LOG_INFO    => 'info',
                        PEAR_LOG_DEBUG   => 'debug'
                    )

Definition at line 61 of file firebug.php.

Log_firebug::$_timeFormat = '%b %d %H:%M:%S'

Definition at line 54 of file firebug.php.

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

Services/PEAR/lib/Log/firebug.php

Public Member Functions

Data Fields

Detailed Description

Member Function Documentation

Field Documentation