Wildfire/Channel/HttpHeaders.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: Channel
version: $Id: HttpHeaders.php 23097 2010-10-12 20:40:19Z cadorn $
Classes: Zend_Wildfire_Channel_HttpHeaders

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_Channel_HttpHeaders
jump to top

Extends from: Zend_Controller_Plugin_Abstract
Implements: Zend_Wildfire_Channel_Interface
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: Channel
Properties: $_headerPrefix; $_instance; $_controllerPluginStackIndex; $_protocols
Methods: init; getInstance; destroyInstance; getProtocol; _initProtocol; flush; setControllerPluginStackIndex; _registerControllerPlugin; isReady; dispatchLoopShutdown; getRequest; getResponse

Description

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

Properties

$_controllerPluginStackIndex
jump to class

integer $_controllerPluginStackIndex = '999'

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

Details

$_controllerPluginStackIndex: integer
visibility: protected
default: 999
final: false
static: true

$_headerPrefix
jump to class

string $_headerPrefix = 'X-WF-'

The string to be used to prefix the headers.

Details

$_headerPrefix: string
visibility: protected
default: X-WF-
final: false
static: true

$_instance
jump to class

Zend_Wildfire_Channel_HttpHeaders $_instance = 'null'

Singleton instance

Details

$_instance: Zend_Wildfire_Channel_HttpHeaders
visibility: protected
default: null
final: false
static: true

$_protocols
jump to class

array $_protocols = 'null'

The protocol instances for this channel

Details

$_protocols: array
visibility: protected
default: null
final: false
static: false

Methods

_initProtocol
jump to class

_initProtocol(
          string $uri
          )
        
        :
        object

Initialize a new protocol

Arguments

$uri: string
The URI for the protocol to be initialized

Output

object: Returns the new initialized protocol instance

Details

visibility: protected
final: false
static: false
throws

_registerControllerPlugin
jump to class

_registerControllerPlugin(
          
          )
        
        :
        void

Details

visibility: protected
final: false
static: false

destroyInstance
jump to class

destroyInstance(
          
          )
        
        :
        void

Destroys the singleton instance

Primarily used for testing.

Details

visibility: public
final: false
static: true

dispatchLoopShutdown
jump to class

dispatchLoopShutdown(
          
          )
        
        :
        void

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

Details

visibility: public
final: false
static: false

flush
jump to class

flush(
          
          )
        
        :
        boolean

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

Output

boolean: Returns TRUE if data was flushed

Details

visibility: public
final: false
static: false

getInstance
jump to class

getInstance(
          $skipCreate $skipCreate
              =
              false
          )
        
        :
        Zend_Wildfire_Channel_HttpHeaders

Get or create singleton instance

Arguments

$skipCreate: $skipCreate
boolean True if an instance should not be created

Output

Zend_Wildfire_Channel_HttpHeaders

Details

visibility: public
final: false
static: true

getProtocol
jump to class

getProtocol(
          string $uri
          )
        
        :
        object

Get the instance of a give protocol for this channel

Arguments

$uri: string
The URI for the protocol

Output

object: Returns the protocol instance for the diven URI

Details

visibility: public
final: false
static: false

getRequest
jump to class

getRequest(
          
          )
        
        :
        Zend_Controller_Request_Abstract

Get the request object

Output

Zend_Controller_Request_Abstract

Details

visibility: public
final: false
static: false
throws

getResponse
jump to class

getResponse(
          
          )
        
        :
        Zend_Controller_Response_Abstract

Get the response object

Output

Zend_Controller_Response_Abstract

Details

visibility: public
final: false
static: false
throws

init
jump to class

init(
          string $class
              =
              null
          )
        
        :
        Zend_Wildfire_Channel_HttpHeaders

Initialize singleton instance.

Arguments

$class: string
OPTIONAL Subclass of Zend_Wildfire_Channel_HttpHeaders

Output

Zend_Wildfire_Channel_HttpHeaders: Returns the singleton Zend_Wildfire_Channel_HttpHeaders instance

Details

visibility: public
final: false
static: true
throws

isReady
jump to class

isReady(
          boolean $forceCheckRequest
              =
              false
          )
        
        :
        boolean

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.

Arguments

$forceCheckRequest: boolean
OPTIONAL Set to TRUE if the request must be checked

Output

boolean: Returns TRUE if channel is ready.

Details

visibility: public
final: false
static: false

setControllerPluginStackIndex
jump to class

setControllerPluginStackIndex(
          integer $index
          )
        
        :
        integer

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

Arguments

$index: integer
The index of the plugin in the stack

Output

integer: The previous index.

Details

visibility: public
final: false
static: true

API Documentation

Wildfire/Channel/HttpHeaders.php

Description

Zend_Wildfire_Channel_HttpHeadersjump to top

Description

Properties

$_controllerPluginStackIndexjump to class

Details

$_headerPrefixjump to class

Details

$_instancejump to class

Details

$_protocolsjump to class

Details

Methods

_initProtocoljump to class

Arguments

Output

Details

_registerControllerPluginjump to class

Details

destroyInstancejump to class

Details

dispatchLoopShutdownjump to class

Details

flushjump to class

Output

Details

getInstancejump to class

Arguments

Output

Details

getProtocoljump to class

Arguments

Output

Details

getRequestjump to class

Output

Details

getResponsejump to class

Output

Details

initjump to class

Arguments

Output

Details

isReadyjump to class

Arguments

Output

Details

setControllerPluginStackIndexjump to class

Arguments

Output

Details

Zend_Wildfire_Channel_HttpHeaders
jump to top

$_controllerPluginStackIndex
jump to class

$_headerPrefix
jump to class

$_instance
jump to class

$_protocols
jump to class

_initProtocol
jump to class

_registerControllerPlugin
jump to class

destroyInstance
jump to class

dispatchLoopShutdown
jump to class

flush
jump to class

getInstance
jump to class

getProtocol
jump to class

getRequest
jump to class

getResponse
jump to class

init
jump to class

isReady
jump to class

setControllerPluginStackIndex
jump to class