Class Zend_Wildfire_Channel_HttpHeaders

Description
Description | Vars (details) | Methods (details)

Implements interfaces:

Implements communication via HTTP request and response headers for Wildfire Protocols.

  • copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  • license: New BSD License

Located in /Wildfire/Channel/HttpHeaders.php (line 50) 

Zend_Controller_Plugin_Abstract
   |
   --Zend_Wildfire_Channel_HttpHeaders
Variable Summary
Description | Vars (details) | Methods (details)
static integer $_controllerPluginStackIndex
static string $_headerPrefix
static Zend_Wildfire_Channel_HttpHeaders $_instance
array $_protocols
Method Summary
Description | Vars (details) | Methods (details)
static void destroyInstance ()
static Zend_Wildfire_Channel_HttpHeaders getInstance ([$skipCreate $skipCreate = false])
static Zend_Wildfire_Channel_HttpHeaders init ([string $class = null])
static integer setControllerPluginStackIndex (integer $index)
void dispatchLoopShutdown ()
boolean flush ()
object Returns getProtocol (string $uri)
Zend_Controller_Request_Abstract getRequest ()
Zend_Controller_Response_Abstract getResponse ()
boolean isReady ([boolean $forceCheckRequest = false])
object Returns _initProtocol (string $uri)
void _registerControllerPlugin ()
Variables
Description | Vars (details) | Methods (details)
static integer $_controllerPluginStackIndex = 999 (line 68)

The index of the plugin in the controller dispatch loop plugin stack

  • access: protected
static string $_headerPrefix = 'X-WF-' (line 56)

The string to be used to prefix the headers.

  • access: protected
static Zend_Wildfire_Channel_HttpHeaders $_instance = null (line 62)

Singleton instance

  • access: protected
array $_protocols = null (line 74)

The protocol instances for this channel

  • access: protected

Inherited Variables

Inherited from Zend_Controller_Plugin_Abstract

Zend_Controller_Plugin_Abstract::$_request
 Zend_Controller_Plugin_Abstract::$_response
Methods
Description | Vars (details) Methods (details)
static destroyInstance (line 136)

Destroys the singleton instance

Primarily used for testing.

  • access: public
static void destroyInstance ()
static getInstance (line 121)

Get or create singleton instance

  • access: public
static Zend_Wildfire_Channel_HttpHeaders getInstance ([$skipCreate $skipCreate = false])
  • $skipCreate $skipCreate: boolean True if an instance should not be created
static init (line 83)

Initialize singleton instance.

  • return: Returns the singleton Zend_Wildfire_Channel_HttpHeaders instance
  • throws: Zend_Wildfire_Exception
  • access: public
static Zend_Wildfire_Channel_HttpHeaders init ([string $class = null])
  • string $class: OPTIONAL Subclass of Zend_Wildfire_Channel_HttpHeaders
static setControllerPluginStackIndex (line 208)

Set the index of the plugin in the controller dispatch loop plugin stack

  • return: The previous index.
  • access: public
static integer setControllerPluginStackIndex (integer $index)
  • integer $index: The index of the plugin in the stack
dispatchLoopShutdown (line 295)

Flush messages to headers as late as possible but before headers have been sent.

  • access: public
void dispatchLoopShutdown ()
Redefinition of:
Zend_Controller_Plugin_Abstract::dispatchLoopShutdown()
Called before Zend_Controller_Front exits its dispatch loop.
flush (line 181)

Flush all data from all protocols and send all data to response headers.

  • return: Returns TRUE if data was flushed
  • access: public
boolean flush ()
getProtocol (line 147)

Get the instance of a give protocol for this channel

  • return: the protocol instance for the diven URI
  • access: public
object Returns getProtocol (string $uri)
  • string $uri: The URI for the protocol
getRequest (line 306)

Get the request object

  • throws: Zend_Wildfire_Exception
  • access: public
Zend_Controller_Request_Abstract getRequest ()
Redefinition of:
Zend_Controller_Plugin_Abstract::getRequest()
Get request object
getResponse (line 325)

Get the response object

  • throws: Zend_Wildfire_Exception
  • access: public
Zend_Controller_Response_Abstract getResponse ()
Redefinition of:
Zend_Controller_Plugin_Abstract::getResponse()
Get response object
isReady (line 264)

Determine if channel is ready.

The channel is ready as long as the request and response objects are initialized, can send headers and the FirePHP header exists in the User-Agent.

If the header does not exist in the User-Agent, no appropriate client is making this request and the messages should not be sent.

A timing issue arises when messages are logged before the request/response objects are initialized. In this case we do not yet know if the client will be able to accept the messages. If we consequently indicate that the channel is not ready, these messages will be dropped which is in most cases not the intended behaviour. The intent is to send them at the end of the request when the request/response objects will be available for sure.

If the request/response objects are not yet initialized we assume if messages are logged, the client will be able to receive them. As soon as the request/response objects are availoable and a message is logged this assumption is challenged. If the client cannot accept the messages any further messages are dropped and messages sent prior are kept but discarded when the channel is finally flushed at the end of the request.

When the channel is flushed the $forceCheckRequest option is used to force a check of the request/response objects. This is the last verification to ensure messages are only sent when the client can accept them.

  • return: Returns TRUE if channel is ready.
  • access: public
boolean isReady ([boolean $forceCheckRequest = false])
  • boolean $forceCheckRequest: OPTIONAL Set to TRUE if the request must be checked
Implementation of:
Zend_Wildfire_Channel_Interface::isReady()
Determine if channel is ready.
_initProtocol (line 165)

Initialize a new protocol

  • return: the new initialized protocol instance
  • throws: Zend_Wildfire_Exception
  • access: protected
object Returns _initProtocol (string $uri)
  • string $uri: The URI for the protocol to be initialized
_registerControllerPlugin (line 220)

Register this object as a controller plugin.

  • access: protected
void _registerControllerPlugin ()

Inherited Methods

Inherited From Zend_Controller_Plugin_Abstract

Zend_Controller_Plugin_Abstract::dispatchLoopShutdown()
Zend_Controller_Plugin_Abstract::dispatchLoopStartup()
Zend_Controller_Plugin_Abstract::getRequest()
Zend_Controller_Plugin_Abstract::getResponse()
Zend_Controller_Plugin_Abstract::postDispatch()
Zend_Controller_Plugin_Abstract::preDispatch()
Zend_Controller_Plugin_Abstract::routeShutdown()
Zend_Controller_Plugin_Abstract::routeStartup()
Zend_Controller_Plugin_Abstract::setRequest()
Zend_Controller_Plugin_Abstract::setResponse()

Documentation generated on Mon, 21 Jun 2010 15:27:44 -0400 by phpDocumentor 1.4.3