Feed/Pubsubhubbub/CallbackAbstract.php

Show: PublicProtectedPrivateinherited
Table of Contents
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_Feed_Pubsubhubbub  
Subpackage
Callback  
Version
$Id$  

\Zend_Feed_Pubsubhubbub_CallbackAbstract
jump to top

Package: Zend_Feed_Pubsubhubbub\Callback
Implements
Children
\Zend_Feed_Pubsubhubbub_Subscriber_Callback
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotected\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.
Default valuenullDetails
Type
\Zend_Feed_Pubsubhubbub_HttpResponse | \Zend_Controller_Response_Http
>VPropertyprotected\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.
Default valuenullDetails
Type
\Zend_Feed_Pubsubhubbub_Model_SubscriptionInterface
>VPropertyprotectedint $_subscriberCount = 1
The number of Subscribers for which any updates are on behalf of.
Default value1Details
Type
int

Methods

methodpublic__construct( $config = null) : void

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

Parameters
NameTypeDescription
$config
methodprotected_detectCallbackUrl() : void

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

methodprotected_getHeader(string $header) : void

Retrieve a Header value from either $_SERVER or Apache

Parameters
NameTypeDescription
$headerstring
methodprotected_getHttpHost() : string

Get the HTTP host

Returns
TypeDescription
string
methodprotected_getRawBody() : string | false

Return the raw body of the request

Returns
TypeDescription
string | falseRaw body, or false if not present
methodpublicgetHttpResponse() : \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.

Returns
TypeDescription
\Zend_Feed_Pubsubhubbub_HttpResponse | \Zend_Controller_Response_Http
methodpublicgetStorage() : \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.

Returns
TypeDescription
\Zend_Feed_Pubsubhubbub_Model_SubscriptionInterface
methodpublicgetSubscriberCount() : 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?
Returns
TypeDescription
int
methodpublicsendResponse() : 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!
methodpublicsetConfig( $config) : \Zend_Feed_Pubsubhubbub_CallbackAbstract

Process any injected configuration options

Parameters
NameTypeDescription
$config
Returns
TypeDescription
\Zend_Feed_Pubsubhubbub_CallbackAbstract
methodpublicsetHttpResponse(\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.

Parameters
NameTypeDescription
$httpResponse\Zend_Feed_Pubsubhubbub_HttpResponse | \Zend_Controller_Response_Http
Returns
TypeDescription
\Zend_Feed_Pubsubhubbub_CallbackAbstract
methodpublicsetStorage(\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.

Parameters
NameTypeDescription
$storage\Zend_Feed_Pubsubhubbub_Model_SubscriptionInterface
Returns
TypeDescription
\Zend_Feed_Pubsubhubbub_CallbackAbstract
methodpublicsetSubscriberCount(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.
Parameters
NameTypeDescription
$countstring | int
Returns
TypeDescription
\Zend_Feed_Pubsubhubbub_CallbackAbstract
Documentation was generated by phpDocumentor 2.2.0 .