Wildfire/Plugin/FirePhp/Message.php
Show:
inherited
inherited
Classes
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_Message
Package: Zend_Wildfire\Plugin
Returns
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-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
boolean $_buffered = falseFlag indicating if message buffering is enabled
Default value
falseDetails- Type
- boolean
boolean $_destroy = falseFlag indicating if message should be destroyed and not delivered
Default value
falseDetails- Type
- boolean
string $_label = nullThe label of the message
Default value
nullDetails- Type
- string
mixed $_message = nullThe message value
Default value
nullDetails- Type
- mixed
array $_options = array('traceOffset' => null, 'includeLineNumbers' => null)Options for the object
Default value
array('traceOffset' => null, 'includeLineNumbers' => null)Details- Type
- array
string $_ruid = falseRandom unique ID used to identify message in comparison operations
Default value
falseDetails- Type
- string
string $_style = nullThe style of the message
Default value
nullDetails- Type
- string
Methods
__construct(string $style, mixed $message) : voidCreates a new message with the given style and message
Parameters
| Name | Type | Description |
|---|---|---|
| $style | string | Style of the message. |
| $message | mixed | The message |
getBuffered() : booleanDetermine if buffering is enabled or disabled
Returns
| Type | Description |
|---|---|
| boolean | Returns TRUE if buffering is enabled, FALSE otherwise. |
getDestroy() : booleanDetermine if message should be destroyed
Returns
| Type | Description |
|---|---|
| boolean | Returns TRUE if message should be destroyed, FALSE otherwise. |
getLabel() : stringGet the label of the message
Returns
| Type | Description |
|---|---|
| string | The label of the message |
getMessage() : mixedGet the actual message to be sent in its final format.
Returns
| Type | Description |
|---|---|
| mixed | Returns the message to be sent. |
getOption(string $key) : mixedRetrieve a single option
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $key | string | The name of the option |
| Type | Description |
|---|---|
| mixed | The value of the option |
getOptions() : arrayRetrieve all options
Returns
| Type | Description |
|---|---|
| array | All options |
getStyle() : stringGet the style of the message
Returns
| Type | Description |
|---|---|
| string | The style of the message |
setBuffered(boolean $buffered) : booleanEnable 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 |
| Type | Description |
|---|---|
| boolean | Returns previous buffering value |
setDestroy(boolean $destroy) : booleanDestroy the message to prevent delivery
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $destroy | boolean | TRUE to destroy FALSE otherwise |
| Type | Description |
|---|---|
| boolean | Returns previous destroy value |
setLabel(string $label) : voidSet the label of the message
Parameters
| Name | Type | Description |
|---|---|---|
| $label | string | The label to be set |
setMessage( $message) : voidSet the actual message to be sent in its final format.
Parameters
| Name | Type | Description |
|---|---|---|
| $message |
setOption(string $key, mixed $value) : mixedSet a single option
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $key | string | The name of the option |
| $value | mixed | The value of the option |
| Type | Description |
|---|---|
| mixed | The previous value of the option |
setStyle( $style) : voidSet the style of the message
Parameters
| Name | Type | Description |
|---|---|---|
| $style |