Wildfire/Plugin/FirePhp/Message.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Wildfire
subpackage: Plugin
version: $Id: Message.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Wildfire_Plugin_FirePhp_Message

Description

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.

Zend_Wildfire_Plugin_FirePhp_Message
jump to top

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Wildfire
subpackage: Plugin
Properties: $_style; $_label; $_message; $_buffered; $_destroy; $_ruid; $_options
Methods: __construct; setLabel; getLabel; setBuffered; getBuffered; setDestroy; getDestroy; setStyle; getStyle; setMessage; getMessage; setOption; getOption; getOptions

Description

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

Properties

$_buffered
jump to class

boolean $_buffered = 'false'

Flag indicating if message buffering is enabled

Details

$_buffered: boolean
visibility: protected
default: false
final: false
static: false

$_destroy
jump to class

boolean $_destroy = 'false'

Flag indicating if message should be destroyed and not delivered

Details

$_destroy: boolean
visibility: protected
default: false
final: false
static: false

$_label
jump to class

string $_label = 'null'

The label of the message

Details

$_label: string
visibility: protected
default: null
final: false
static: false

$_message
jump to class

mixed $_message = 'null'

The message value

Details

$_message: mixed
visibility: protected
default: null
final: false
static: false

$_options
jump to class

array $_options = 'array'

Options for the object

Details

$_options: array
visibility: protected
default: array
final: false
static: false

$_ruid
jump to class

string $_ruid = 'false'

Random unique ID used to identify message in comparison operations

Details

$_ruid: string
visibility: protected
default: false
final: false
static: false

$_style
jump to class

string $_style = 'null'

The style of the message

Details

$_style: string
visibility: protected
default: null
final: false
static: false

Methods

__construct
jump to class

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

Creates a new message with the given style and message

Arguments

$style: string
Style of the message.
$message: mixed
The message

Details

visibility: public
final: false
static: false

getBuffered
jump to class

getBuffered(
          
          )
        
        :
        boolean

Determine if buffering is enabled or disabled

Output

boolean: Returns TRUE if buffering is enabled, FALSE otherwise.

Details

visibility: public
final: false
static: false

getDestroy
jump to class

getDestroy(
          
          )
        
        :
        boolean

Determine if message should be destroyed

Output

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

Details

visibility: public
final: false
static: false

getLabel
jump to class

getLabel(
          
          )
        
        :
        string

Get the label of the message

Output

string: The label of the message

Details

visibility: public
final: false
static: false

getMessage
jump to class

getMessage(
          
          )
        
        :
        mixed

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

Output

mixed: Returns the message to be sent.

Details

visibility: public
final: false
static: false

getOption
jump to class

getOption(
          string $key
          )
        
        :
        mixed

Retrieve a single option

Arguments

$key: string
The name of the option

Output

mixed: The value of the option

Details

visibility: public
final: false
static: false

getOptions
jump to class

getOptions(
          
          )
        
        :
        array

Retrieve all options

Output

array: All options

Details

visibility: public
final: false
static: false

getStyle
jump to class

getStyle(
          
          )
        
        :
        string

Get the style of the message

Output

string: The style of the message

Details

visibility: public
final: false
static: false

setBuffered
jump to class

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.

Arguments

$buffered: boolean
TRUE to enable buffering FALSE otherwise

Output

boolean: Returns previous buffering value

Details

visibility: public
final: false
static: false

setDestroy
jump to class

setDestroy(
          boolean $destroy
          )
        
        :
        boolean

Destroy the message to prevent delivery

Arguments

$destroy: boolean
TRUE to destroy FALSE otherwise

Output

boolean: Returns previous destroy value

Details

visibility: public
final: false
static: false

setLabel
jump to class

setLabel(
          string $label
          )
        
        :
        void

Set the label of the message

Arguments

$label: string
The label to be set

Details

visibility: public
final: false
static: false

setMessage
jump to class

setMessage(
           $message
          )
        
        :
        void

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

Arguments

$message

Details

visibility: public
final: false
static: false

setOption
jump to class

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

Set a single option

Arguments

$key: string
The name of the option
$value: mixed
The value of the option

Output

mixed: The previous value of the option

Details

visibility: public
final: false
static: false

setStyle
jump to class

setStyle(
           $style
          )
        
        :
        void

Set the style of the message

Arguments

$style

Details

visibility: public
final: false
static: false

API Documentation

Wildfire/Plugin/FirePhp/Message.php

Description

Zend_Wildfire_Plugin_FirePhp_Messagejump to top

Description

Properties

$_bufferedjump to class

Details

$_destroyjump to class

Details

$_labeljump to class

Details

$_messagejump to class

Details

$_optionsjump to class

Details

$_ruidjump to class

Details

$_stylejump to class

Details

Methods

__constructjump to class

Arguments

Details

getBufferedjump to class

Output

Details

getDestroyjump to class

Output

Details

getLabeljump to class

Output

Details

getMessagejump to class

Output

Details

getOptionjump to class

Arguments

Output

Details

getOptionsjump to class

Output

Details

getStylejump to class

Output

Details

setBufferedjump to class

Arguments

Output

Details

setDestroyjump to class

Arguments

Output

Details

setLabeljump to class

Arguments

Details

setMessagejump to class

Arguments

Details

setOptionjump to class

Arguments

Output

Details

setStylejump to class

Arguments

Details

Zend_Wildfire_Plugin_FirePhp_Message
jump to top

$_buffered
jump to class

$_destroy
jump to class

$_label
jump to class

$_message
jump to class

$_options
jump to class

$_ruid
jump to class

$_style
jump to class

__construct
jump to class

getBuffered
jump to class

getDestroy
jump to class

getLabel
jump to class

getMessage
jump to class

getOption
jump to class

getOptions
jump to class

getStyle
jump to class

setBuffered
jump to class

setDestroy
jump to class

setLabel
jump to class

setMessage
jump to class

setOption
jump to class

setStyle
jump to class