Wildfire/Plugin/FirePhp.php

Show:

inherited

Classes
- \Zend_Wildfire_Plugin_FirePhp

Table of Contents

Zend Framework

LICENSE This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Wildfire
Subpackage: Plugin
Version: $Id$

\Zend_Wildfire_Plugin_FirePhp
jump to top

Package: Zend_Wildfire\Plugin

Primary class for communicating with the FirePHP Firefox Extension.

Implements
Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Constants

 
                LOG
                = 'LOG'

Plain log style.

 
                INFO
                = 'INFO'

Information style.

 
                WARN
                = 'WARN'

Warning style.

 
                ERROR
                = 'ERROR'

Error style that increments Firebug's error counter.

 
                TRACE
                = 'TRACE'

Trace style showing message and expandable full stack trace.

 
                EXCEPTION
                = 'EXCEPTION'

Exception style showing message and expandable full stack trace.

Also increments Firebug's error counter.

 
                TABLE
                = 'TABLE'

Table style showing summary line and expandable table

 
                DUMP
                = 'DUMP'

Dump variable to Server panel in Firebug Request Inspector

 
                GROUP_START
                = 'GROUP_START'

Start a group in the Firebug Console

 
                GROUP_END
                = 'GROUP_END'

End a group in the Firebug Console

 
                PLUGIN_URI
                = 'http://meta.firephp.org/Wildfire/Plugin/ZendFramework/FirePHP/1.6.2'

The plugin URI for this plugin

 
                PROTOCOL_URI
                = \Zend_Wildfire_Protocol_JsonStream::PROTOCOL_URI

The protocol URI for this plugin

 
                STRUCTURE_URI_DUMP
                = 'http://meta.firephp.org/Wildfire/Structure/FirePHP/Dump/0.1'

The structure URI for the Dump structure

 
                STRUCTURE_URI_FIREBUGCONSOLE
                = 'http://meta.firephp.org/Wildfire/Structure/FirePHP/FirebugConsole/0.1'

The structure URI for the Firebug Console structure

Properties

\Zend_Wildfire_Channel_Interface $_channel = null

The channel via which to send the encoded messages.

Default valuenullDetails

Type: \Zend_Wildfire_Channel_Interface

boolean $_enabled = true

Flag indicating whether FirePHP should send messages to the user-agent.

Default valuetrueDetails

Type: boolean

\Zend_Wildfire_Plugin_FirePhp $_instance = null

static

Singleton instance

Default valuenullDetails

Type: \Zend_Wildfire_Plugin_FirePhp

array $_messages = array()

Messages that are buffered to be sent when protocol flushes

Default valuearray()Details

Type: array

array $_objectFilters = array()

Filters used to exclude object members when encoding

Default valuearray()Details

Type: array

array $_objectStack = array()

A stack of objects used during encoding to detect recursion

Default valuearray()Details

Type: array

array $_options = array('traceOffset' => 1, 'maxTraceDepth' => 99, 'maxObjectDepth' => 10, 'maxArrayDepth' => 20, 'includeLineNumbers' => true)

Options for the object

Default value

array('traceOffset' => 1, 'maxTraceDepth' => 99, 'maxObjectDepth' => 10, 'maxArrayDepth' => 20, 'includeLineNumbers' => true)

Details

Type: array

Methods

__construct() : void

Constructor

_encodeObject(mixed $object, $objectDepth = 1, $arrayDepth = 1) : array

Encode an object by generating an array containing all object members.

All private and protected members are included. Some meta info about the object class is added.

Parameters

Name	Type	Description
$object	mixed	The object/array/value to be encoded
$objectDepth
$arrayDepth

Returns

Type	Description
array	The encoded object

_encodeTable( $table) : array

Encodes a table by encoding each row and column with _encodeObject()

Parameters

Name	Type	Description
$table

Returns

Type	Description
array

_encodeTrace( $trace) : array

Encodes a trace by encoding all "args" with _encodeObject()

Parameters

Name	Type	Description
$trace

Returns

Type	Description
array	The encoded trace

_getStackTrace(array $options) : array

Gets a stack trace

Parameters

Name	Type	Description
$options	array	Options to change how the stack trace is returned

Returns

Type	Description
array	The stack trace

_recordMessage(string $structure, array $data, boolean $skipEncode = false) : boolean

Record a message with the given data in the given structure

Parameters

Name	Type	Description
$structure	string	The structure to be used for the data
$data	array	The data to be recorded
$skipEncode	boolean	TRUE if variable encoding should be skipped

Returns

Type	Description
boolean	Returns TRUE if message was recorded

Throws

Exception	Description
\Zend_Wildfire_Exception

destroyInstance() : void

static

Destroys the singleton instance

Primarily used for testing.

flushMessages(string $protocolUri) : void

Flush any buffered data.

Parameters

Name	Type	Description
$protocolUri	string	The URI of the protocol that should be flushed to

getEnabled() : boolean

Determine if logging to user-agent is enabled.

Returns

Type	Description
boolean	Returns TRUE if logging is enabled.

getInstance(bool $skipCreate = false) : \Zend_Wildfire_Plugin_FirePhp

static

Get or create singleton instance

Parameters

Name	Type	Description
$skipCreate	bool	True if an instance should not be created

Returns

Type	Description
\Zend_Wildfire_Plugin_FirePhp

getOption(string $key) : mixed

Retrieve a single option

Parameters

Name	Type	Description
$key	string	The name of the option

Returns

Type	Description
mixed	The value of the option

getOptions() : array

Retrieve all options

Returns

Type	Description
array	All options

getUri() : string

Get the unique indentifier for this plugin.

Returns

Type	Description
string	Returns the URI of the plugin.

group(string $title, array $options = array()) : TRUE

static

Starts a group in the Firebug Console

Parameters

Name	Type	Description
$title	string	The title of the group
$options	array	OPTIONAL Setting 'Collapsed' to true will initialize group collapsed instead of expanded

Returns

Type	Description
TRUE	if the group instruction was added to the response headers or buffered.

groupEnd() : TRUE

static

Ends a group in the Firebug Console

Returns

Type	Description
TRUE	if the group instruction was added to the response headers or buffered.

init(string $class = null) : \Zend_Wildfire_Plugin_FirePhp

static

Create singleton instance.

Parameters

Name	Type	Description
$class	string	OPTIONAL Subclass of Zend_Wildfire_Plugin_FirePhp

Returns

Type	Description
\Zend_Wildfire_Plugin_FirePhp	Returns the singleton Zend_Wildfire_Plugin_FirePhp instance

Throws

Exception	Description
\Zend_Wildfire_Exception

send(mixed $var, string $label = null, string $style = null, array $options = array()) : boolean

static

Logs variables to the Firebug Console via HTTP response headers and the FirePHP Firefox Extension.

Parameters

Name	Type	Description
$var	mixed	The variable to log.
$label	string	OPTIONAL Label to prepend to the log event.
$style	string	OPTIONAL Style of the log event.
$options	array	OPTIONAL Options to change how messages are processed and sent

Returns

Type	Description
boolean	Returns TRUE if the variable was added to the response headers or buffered.

Throws

Exception	Description
\Zend_Wildfire_Exception

setEnabled(boolean $enabled) : boolean

Enable or disable sending of messages to user-agent.

If disabled all headers to be sent will be removed.

Parameters

Name	Type	Description
$enabled	boolean	Set to TRUE to enable sending of messages.

Returns

Type	Description
boolean	The previous value.

setObjectFilter( $class, $filter) : void

Specify a filter to be used when encoding an object

Filters are used to exclude object members.

Parameters

Name	Type	Description
$class
$filter

setOption(string $key, mixed $value) : mixed

Set a single option

Parameters

Name	Type	Description
$key	string	The name of the option
$value	mixed	The value of the option

Returns

Type	Description
mixed	The previous value of the option

Wildfire/Plugin/FirePhp.php

\Zend_Wildfire_Plugin_FirePhpjump to top

Constants

Properties

Methods

\Zend_Wildfire_Plugin_FirePhp
jump to top