Primary class for communicating with the FirePHP Firefox Extension.

category Zend
package Zend_Wildfire
subpackage Plugin
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License

 Methods

Destroys the singleton instance

destroyInstance() : void
Static

Primarily used for testing.

Flush any buffered data.

flushMessages(string $protocolUri) : void
inherited_from \Zend_Wildfire_Plugin_Interface::flushMessages()

Parameters

$protocolUri

string

The URI of the protocol that should be flushed to

Determine if logging to user-agent is enabled.

getEnabled() : boolean

Returns

booleanReturns TRUE if logging is enabled.

Get or create singleton instance

getInstance(boolean $skipCreate = false) : \Zend_Wildfire_Plugin_FirePhp
Static

Parameters

$skipCreate

boolean

True if an instance should not be created

Returns

\Zend_Wildfire_Plugin_FirePhp

Retrieve a single option

getOption(string $key) : mixed

Parameters

$key

string

The name of the option

Returns

mixedThe value of the option

Retrieve all options

getOptions() : array

Returns

arrayAll options

Get the unique indentifier for this plugin.

getUri() : string
inherited_from \Zend_Wildfire_Plugin_Interface::getUri()

Returns

stringReturns the URI of the plugin.

Starts a group in the Firebug Console

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

Parameters

$title

string

The title of the group

$options

array

OPTIONAL Setting 'Collapsed' to true will initialize group collapsed instead of expanded

Returns

TRUEif the group instruction was added to the response headers or buffered.

Ends a group in the Firebug Console

groupEnd() : TRUE
Static

Returns

TRUEif the group instruction was added to the response headers or buffered.

Create singleton instance.

init(string $class = null) : \Zend_Wildfire_Plugin_FirePhp
Static

Parameters

$class

string

OPTIONAL Subclass of Zend_Wildfire_Plugin_FirePhp

Exceptions

\Zend_Wildfire_Exception

Returns

\Zend_Wildfire_Plugin_FirePhpReturns the singleton Zend_Wildfire_Plugin_FirePhp instance

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

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

Parameters

$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

Exceptions

\Zend_Wildfire_Exception

Returns

booleanReturns TRUE if the variable was added to the response headers or buffered.

Enable or disable sending of messages to user-agent.

setEnabled(boolean $enabled) : boolean

If disabled all headers to be sent will be removed.

Parameters

$enabled

boolean

Set to TRUE to enable sending of messages.

Returns

booleanThe previous value.

Specify a filter to be used when encoding an object

setObjectFilter($class, $filter) : void

Filters are used to exclude object members.

Parameters

$class

$filter

Set a single option

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

Parameters

$key

string

The name of the option

$value

mixed

The value of the option

Returns

mixedThe previous value of the option

Constructor

__construct() : void

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

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

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

Parameters

$object

mixed

The object/array/value to be encoded

$objectDepth

$arrayDepth

Returns

arrayThe encoded object

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

_encodeTable($table) : array

Parameters

$table

Returns

array

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

_encodeTrace($trace) : array

Parameters

$trace

Returns

arrayThe encoded trace

Gets a stack trace

_getStackTrace(array $options) : array

Parameters

$options

array

Options to change how the stack trace is returned

Returns

arrayThe stack trace

Record a message with the given data in the given structure

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

Parameters

$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

Exceptions

\Zend_Wildfire_Exception

Returns

booleanReturns TRUE if message was recorded

 Properties

 

The channel via which to send the encoded messages.

$_channel : \Zend_Wildfire_Channel_Interface

Default

null
 

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

$_enabled : boolean

Default

true
 

Singleton instance

$_instance : \Zend_Wildfire_Plugin_FirePhp

Default

null
Static
 

Messages that are buffered to be sent when protocol flushes

$_messages : array

Default

array()
 

Filters used to exclude object members when encoding

$_objectFilters : array

Default

array()
 

A stack of objects used during encoding to detect recursion

$_objectStack : array

Default

array()
 

Options for the object

$_options : array

Default

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

 Constants

 

Dump variable to Server panel in Firebug Request Inspector

DUMP = 'DUMP' 
 

Error style that increments Firebug's error counter.

ERROR = 'ERROR' 
 

Exception style showing message and expandable full stack trace.

EXCEPTION = 'EXCEPTION' 

Also increments Firebug's error counter.

 

End a group in the Firebug Console

GROUP_END = 'GROUP_END' 
 

Start a group in the Firebug Console

GROUP_START = 'GROUP_START' 
 

Information style.

INFO = 'INFO' 
 

Plain log style.

LOG = 'LOG' 
 

The plugin URI for this plugin

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

The protocol URI for this plugin

PROTOCOL_URI = \Zend_Wildfire_Protocol_JsonStream::PROTOCOL_URI 
 

The structure URI for the Dump structure

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

The structure URI for the Firebug Console structure

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

Table style showing summary line and expandable table

TABLE = 'TABLE' 
 

Trace style showing message and expandable full stack trace.

TRACE = 'TRACE' 
 

Warning style.

WARN = 'WARN'