API Documentation

Zend/Wildfire/Plugin/FirePhp/Message.php

Show: inherited
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 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Wildfire_Plugin_FirePhp_Message

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

Propertyprotectedboolean  $_buffered= 'false'

Flag indicating if message buffering is enabled

Default valuefalseDetails
Type
boolean
Propertyprotectedboolean  $_destroy= 'false'

Flag indicating if message should be destroyed and not delivered

Default valuefalseDetails
Type
boolean
Propertyprotectedstring  $_label= 'null'

The label of the message

Default valuenullDetails
Type
string
Propertyprotectedmixed  $_message= 'null'

The message value

Default valuenullDetails
Type
mixed
Propertyprotectedarray  $_options= 'array( 'traceOffset' => null'

Options for the object

Default valuearray( 'traceOffset' => nullDetails
Type
array
Propertyprotectedstring  $_ruid= 'false'

Random unique ID used to identify message in comparison operations

Default valuefalseDetails
Type
string
Propertyprotectedstring  $_style= 'null'

The style of the message

Default valuenullDetails
Type
string

Methods

methodpublic__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

methodpublicgetBuffered( ) : boolean

Determine if buffering is enabled or disabled

Returns
Type Description
boolean Returns TRUE if buffering is enabled, FALSE otherwise.
methodpublicgetDestroy( ) : boolean

Determine if message should be destroyed

Returns
Type Description
boolean Returns TRUE if message should be destroyed, FALSE otherwise.
methodpublicgetLabel( ) : string

Get the label of the message

Returns
Type Description
string The label of the message
methodpublicgetMessage( ) : mixed

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

Returns
Type Description
mixed Returns the message to be sent.
methodpublicgetOption( 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
methodpublicgetOptions( ) : array

Retrieve all options

Returns
Type Description
array All options
methodpublicgetStyle( ) : string

Get the style of the message

Returns
Type Description
string The style of the message
methodpublicsetBuffered( 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
methodpublicsetDestroy( 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
methodpublicsetLabel( string $label ) : void

Set the label of the message

Parameters
Name Type Description
$label string

The label to be set

methodpublicsetMessage(  $message ) : void

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

Parameters
Name Type Description
$message
methodpublicsetOption( 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
methodpublicsetStyle(  $style ) : void

Set the style of the message

Parameters
Name Type Description
$style
Documentation was generated by DocBlox 0.15.1.