Wildfire/Plugin/FirePhp/Message.php

Show:

inherited

Classes
- \Zend_Wildfire_Plugin_FirePhp_Message

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-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Wildfire
Subpackage: Plugin
Version: $Id: Message.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Wildfire_Plugin_FirePhp_Message
jump to top

Package: Zend\Wildfire\Plugin

A message envelope that can be passed to Zend_Wildfire_Plugin_FirePhp to be logged to Firebug instead of a variable.

Children: \Zend_Wildfire_Plugin_FirePhp_TableMessage
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

boolean $_buffered = false

Flag indicating if message buffering is enabled

Default valuefalseDetails

Type: boolean

boolean $_destroy = false

Flag indicating if message should be destroyed and not delivered

Default valuefalseDetails

Type: boolean

string $_label = null

The label of the message

Default valuenullDetails

Type: string

mixed $_message = null

The message value

Default valuenullDetails

Type: mixed

array $_options = array('traceOffset' => null, 'includeLineNumbers' => null)

Options for the object

Default valuearray('traceOffset' => null, 'includeLineNumbers' => null)Details

Type: array

string $_ruid = false

Random unique ID used to identify message in comparison operations

Default valuefalseDetails

Type: string

string $_style = null

The style of the message

Default valuenullDetails

Type: string

Methods

__construct(string $style, mixed $message) : void

Creates a new message with the given style and message

Parameters

Name	Type	Description
$style	string	Style of the message.
$message	mixed	The message

getBuffered() : boolean

Determine if buffering is enabled or disabled

Returns

Type	Description
boolean	Returns TRUE if buffering is enabled, FALSE otherwise.

getDestroy() : boolean

Determine if message should be destroyed

Returns

Type	Description
boolean	Returns TRUE if message should be destroyed, FALSE otherwise.

getLabel() : string

Get the label of the message

Returns

Type	Description
string	The label of the message

getMessage() : mixed

Get the actual message to be sent in its final format.

Returns

Type	Description
mixed	Returns the message to be sent.

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

getStyle() : string

Get the style of the message

Returns

Type	Description
string	The style of the message

setBuffered(boolean $buffered) : boolean

Enable or disable message buffering

If a message is buffered it can be updated for the duration of the request and is only flushed at the end of the request.

Parameters

Name	Type	Description
$buffered	boolean	TRUE to enable buffering FALSE otherwise

Returns

Type	Description
boolean	Returns previous buffering value

setDestroy(boolean $destroy) : boolean

Destroy the message to prevent delivery

Parameters

Name	Type	Description
$destroy	boolean	TRUE to destroy FALSE otherwise

Returns

Type	Description
boolean	Returns previous destroy value

setLabel(string $label) : void

Set the label of the message

Parameters

Name	Type	Description
$label	string	The label to be set

setMessage( $message) : void

Set the actual message to be sent in its final format.

Parameters

Name	Type	Description
$message

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

setStyle( $style) : void

Set the style of the message

Parameters

Name	Type	Description
$style

Wildfire/Plugin/FirePhp/Message.php

\Zend_Wildfire_Plugin_FirePhp_Messagejump to top

Properties

Methods

\Zend_Wildfire_Plugin_FirePhp_Message
jump to top