category Zend
package Zend_Feed_Pubsubhubbub
subpackage Callback
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License

 Methods

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

__construct(array|\Zend_Config|null $config = null

Parameters

$config

array\Zend_Confignull

Options array or Zend_Config instance

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.

getHttpResponse() : \Zend_Feed_Pubsubhubbub_HttpResponse | \Zend_Controller_Response_Http
inherited_from \Zend_Feed_Pubsubhubbub_CallbackInterface::getHttpResponse()

Returns

\Zend_Feed_Pubsubhubbub_HttpResponse\Zend_Controller_Response_Http

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

getStorage() : \Zend_Feed_Pubsubhubbub_Model_SubscriptionInterface

Exceptions

\Zend_Feed_Pubsubhubbub_Exception

Returns

\Zend_Feed_Pubsubhubbub_Model_SubscriptionInterface

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

getSubscriberCount() : integer

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

Returns

integer

Send the response, including all headers.

sendResponse() : void

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!

inherited_from \Zend_Feed_Pubsubhubbub_CallbackInterface::sendResponse()

Process any injected configuration options

setConfig(array|\Zend_Config $config) : \Zend_Feed_Pubsubhubbub_CallbackAbstract

Parameters

$config

array\Zend_Config

Options array or Zend_Config instance

Exceptions

\Zend_Feed_Pubsubhubbub_Exception

Returns

\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.

setHttpResponse(\Zend_Feed_Pubsubhubbub_HttpResponse|\Zend_Controller_Response_Http $httpResponse) : \Zend_Feed_Pubsubhubbub_CallbackAbstract
inherited_from \Zend_Feed_Pubsubhubbub_CallbackInterface::setHttpResponse()

Parameters

$httpResponse

\Zend_Feed_Pubsubhubbub_HttpResponse\Zend_Controller_Response_Http

Exceptions

\Zend_Feed_Pubsubhubbub_Exception

Returns

\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.

setStorage(\Zend_Feed_Pubsubhubbub_Model_SubscriptionInterface $storage) : \Zend_Feed_Pubsubhubbub_CallbackAbstract

Parameters

$storage

\Zend_Feed_Pubsubhubbub_Model_SubscriptionInterface

Returns

\Zend_Feed_Pubsubhubbub_CallbackAbstract

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

setSubscriberCount(string|integer $count) : \Zend_Feed_Pubsubhubbub_CallbackAbstract

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

Parameters

$count

stringinteger

Exceptions

\Zend_Feed_Pubsubhubbub_Exception

Returns

\Zend_Feed_Pubsubhubbub_CallbackAbstract

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

_detectCallbackUrl() 

Retrieve a Header value from either $_SERVER or Apache

_getHeader(string $header) : boolean

Parameters

$header

string

Returns

boolean

Get the HTTP host

_getHttpHost() : string

Returns

string

Return the raw body of the request

_getRawBody() : string | false

Returns

stringfalseRaw body, or false if not present

 Properties

 

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.

$_httpResponse : \Zend_Feed_Pubsubhubbub_HttpResponse | \Zend_Controller_Response_Http

Default

null
 

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

$_storage : \Zend_Feed_Pubsubhubbub_Model_SubscriptionInterface

Default

null
 

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

$_subscriberCount : integer

Default

1