API Documentation

Feed/Pubsubhubbub/CallbackAbstract.php

Includes Classes 
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_Feed_Pubsubhubbub
subpackage
Callback
Classes
Zend_Feed_Pubsubhubbub_CallbackAbstract

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_Feed_Pubsubhubbub_CallbackAbstract

Implements
Zend_Feed_Pubsubhubbub_CallbackInterface
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_Feed_Pubsubhubbub
subpackage
Callback
Properties
$_storage
$_httpResponse
$_subscriberCount
Methods
__construct
setConfig
sendResponse
setStorage
getStorage
setHttpResponse
getHttpResponse
setSubscriberCount
getSubscriberCount
_detectCallbackUrl
_getHttpHost
_getHeader
_getRawBody

Description

Properties

$_httpResponse

Zend_Feed_Pubsubhubbub_HttpResponse|Zend_Controller_Response_Http $_httpResponse = 'null'

An instance of a class handling Http Responses. This is implemented in Zend_Feed_Pubsubhubbub_HttpResponse which shares an unenforced interface with (i.e. not inherited from) Zend_Controller_Response_Http.

Details

$_httpResponse
Zend_Feed_Pubsubhubbub_HttpResponse|Zend_Controller_Response_Http
visibility
protected
default
null
final
false
static
false

$_storage

Zend_Feed_Pubsubhubbub_Model_SubscriptionInterface $_storage = 'null'

An instance of Zend_Feed_Pubsubhubbub_Model_SubscriptionInterface used to background save any verification tokens associated with a subscription or other.

Details

$_storage
Zend_Feed_Pubsubhubbub_Model_SubscriptionInterface
visibility
protected
default
null
final
false
static
false

$_subscriberCount

int $_subscriberCount = '1'

The number of Subscribers for which any updates are on behalf of.

Details

$_subscriberCount
int
visibility
protected
default
1
final
false
static
false

Methods

__construct

__construct(  $config = null ) :

Constructor; accepts an array or Zend_Config instance to preset options for the Subscriber without calling all supported setter methods in turn.

Arguments
$config
Details
visibility
public
final
false
static
false

_detectCallbackUrl

_detectCallbackUrl( ) :

Attempt to detect the callback URL (specifically the path forward)

Details
visibility
protected
final
false
static
false

_getHeader

_getHeader( string $header ) :

Retrieve a Header value from either $_SERVER or Apache

Arguments
$header
string
Details
visibility
protected
final
false
static
false

_getHttpHost

_getHttpHost( ) : string

Get the HTTP host

Output
string
Details
visibility
protected
final
false
static
false

_getRawBody

_getRawBody( ) : string|false

Return the raw body of the request

Output
string|false
Raw body, or false if not present
Details
visibility
protected
final
false
static
false

getHttpResponse

getHttpResponse( ) : Zend_Feed_Pubsubhubbub_HttpResponse|Zend_Controller_Response_Http

An instance of a class handling Http Responses. This is implemented in Zend_Feed_Pubsubhubbub_HttpResponse which shares an unenforced interface with (i.e. not inherited from) Zend_Controller_Response_Http.

Details
visibility
public
final
false
static
false

getStorage

getStorage( ) : Zend_Feed_Pubsubhubbub_Model_SubscriptionInterface

Gets an instance of Zend_Feed_Pubsubhubbub_Model_SubscriptionInterface used to background save any verification tokens associated with a subscription or other.

Details
visibility
public
final
false
static
false

getSubscriberCount

getSubscriberCount( ) : int

Gets the number of Subscribers for which any updates are on behalf of.

In other words, is this class serving one or more subscribers? How many?

Output
int
Details
visibility
public
final
false
static
false

sendResponse

sendResponse( ) : void

Send the response, including all headers.

If you wish to handle this via Zend_Controller, use the getter methods to retrieve any data needed to be set on your HTTP Response object, or simply give this object the HTTP Response instance to work with for you!

Details
visibility
public
final
false
static
false

setConfig

setConfig(  $config ) : Zend_Feed_Pubsubhubbub_CallbackAbstract

Process any injected configuration options

Arguments
$config
Details
visibility
public
final
false
static
false

setHttpResponse

setHttpResponse( Zend_Feed_Pubsubhubbub_HttpResponse|Zend_Controller_Response_Http $httpResponse ) : Zend_Feed_Pubsubhubbub_CallbackAbstract

An instance of a class handling Http Responses. This is implemented in Zend_Feed_Pubsubhubbub_HttpResponse which shares an unenforced interface with (i.e. not inherited from) Zend_Controller_Response_Http.

Arguments
$httpResponse
Zend_Feed_Pubsubhubbub_HttpResponseZend_Controller_Response_Http
Details
visibility
public
final
false
static
false

setStorage

setStorage( Zend_Feed_Pubsubhubbub_Model_SubscriptionInterface $storage ) : Zend_Feed_Pubsubhubbub_CallbackAbstract

Sets an instance of Zend_Feed_Pubsubhubbub_Model_SubscriptionInterface used to background save any verification tokens associated with a subscription or other.

Arguments
$storage
Zend_Feed_Pubsubhubbub_Model_SubscriptionInterface
Details
visibility
public
final
false
static
false

setSubscriberCount

setSubscriberCount( string|int $count ) : Zend_Feed_Pubsubhubbub_CallbackAbstract

Sets the number of Subscribers for which any updates are on behalf of.

In other words, is this class serving one or more subscribers? How many? Defaults to 1 if left unchanged.

Arguments
$count
stringint
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.