__construct()
getFeedUpdate()
getHttpResponse()
getStorage()
getSubscriberCount()
handle()
hasFeedUpdate()
isValidHubVerification()
sendResponse()
setFeedUpdate()
setHttpResponse()
setOptions()
setStorage()
setSubscriberCount()
setSubscriptionKey()
_detectCallbackUrl()
_detectVerifyTokenKey()
_getHeader()
_getHttpHost()
_getRawBody()
_hasValidVerifyToken()
_parseQueryString()
$currentSubscriptionData
$feedUpdate
$httpResponse
$storage
$subscriberCount
$subscriptionKey
__construct(array | \Traversable $options)
| inherited_from | \Zend\Feed\PubSubHubbub\AbstractCallback::__construct() |
|---|
array\TraversableOptions array or Traversable object
getFeedUpdate() : string
stringgetHttpResponse() : \Zend\Feed\PubSubHubbub\HttpResponse | \Zend\Http\PhpEnvironment\Response
This is implemented in Zend\Feed\Pubsubhubbub\HttpResponse which shares an unenforced interface with (i.e. not inherited from) Zend\Controller\Response\Http.
| inherited_from | \Zend\Feed\PubSubHubbub\AbstractCallback::getHttpResponse() |
|---|
getStorage() : \Zend\Feed\PubSubHubbub\Model\SubscriptionPersistenceInterface
| inherited_from | \Zend\Feed\PubSubHubbub\AbstractCallback::getStorage() |
|---|
\Zend\Feed\PubSubHubbub\Exception\RuntimeException |
|---|
getSubscriberCount() : int
In other words, is this class serving one or more subscribers? How many?
| inherited_from | \Zend\Feed\PubSubHubbub\AbstractCallback::getSubscriberCount() |
|---|
inthandle(array $httpGetData, bool $sendResponseNow) : void
This should be the Hub Server confirming the the request prior to taking action on it.
arrayGET data if available and not in $_GET
boolWhether to send response now or when asked
hasFeedUpdate() : bool
boolisValidHubVerification(array $httpGetData) : bool
array
boolsendResponse() : void
If you wish to handle this via Zend\Http, 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\AbstractCallback::sendResponse() |
|---|
setFeedUpdate(string $feed) : \Zend\Feed\PubSubHubbub\Subscriber\Callback
setHttpResponse(\Zend\Feed\PubSubHubbub\HttpResponse | \Zend\Http\PhpEnvironment\Response $httpResponse) : \Zend\Feed\PubSubHubbub\AbstractCallback
This is implemented in Zend\Feed\Pubsubhubbub\HttpResponse which shares an unenforced interface with (i.e. not inherited from) Zend\Controller\Response\Http.
| inherited_from | \Zend\Feed\PubSubHubbub\AbstractCallback::setHttpResponse() |
|---|
\Zend\Feed\PubSubHubbub\Exception\InvalidArgumentException |
|---|
setOptions(array | \Traversable $options) : \Zend\Feed\PubSubHubbub\AbstractCallback
| inherited_from | \Zend\Feed\PubSubHubbub\AbstractCallback::setOptions() |
|---|
array\TraversableOptions array or Traversable object
\Zend\Feed\PubSubHubbub\Exception\InvalidArgumentException |
|---|
setStorage(\Zend\Feed\PubSubHubbub\Model\SubscriptionPersistenceInterface $storage) : \Zend\Feed\PubSubHubbub\AbstractCallback
| inherited_from | \Zend\Feed\PubSubHubbub\AbstractCallback::setStorage() |
|---|
setSubscriberCount(string | int $count) : \Zend\Feed\PubSubHubbub\AbstractCallback
In other words, is this class serving one or more subscribers? How many? Defaults to 1 if left unchanged.
| inherited_from | \Zend\Feed\PubSubHubbub\AbstractCallback::setSubscriberCount() |
|---|
stringint
\Zend\Feed\PubSubHubbub\Exception\InvalidArgumentException |
|---|
setSubscriptionKey(string $key) : \Zend\Feed\PubSubHubbub\Subscriber\Callback
Required if usePathParameter is enabled for the Subscriber.
string
_detectCallbackUrl() : string
| inherited_from | \Zend\Feed\PubSubHubbub\AbstractCallback::_detectCallbackUrl() |
|---|
string_detectVerifyTokenKey(array $httpGetData) : false | string
This would be passed in the Callback URL (which we are handling with this class!) as a URI path part (the last part by convention).
nullarray
falsestring
_getHeader(string $header) : bool | string
| inherited_from | \Zend\Feed\PubSubHubbub\AbstractCallback::_getHeader() |
|---|
string
boolstring
_getHttpHost() : string
| inherited_from | \Zend\Feed\PubSubHubbub\AbstractCallback::_getHttpHost() |
|---|
string_getRawBody() : string | false
| inherited_from | \Zend\Feed\PubSubHubbub\AbstractCallback::_getRawBody() |
|---|
stringfalseRaw body, or false if not present_hasValidVerifyToken(array $httpGetData, bool $checkValue) : bool
By default attempts to compare values with that sent from Hub, otherwise merely ascertains its existence.
array
bool
bool_parseQueryString() : array | void
This bypasses $_GET which munges parameter names and cannot accept multiple parameters with the same key.
arrayvoid
$currentSubscriptionData : array
$feedUpdate : string
$httpResponse : \Zend\Feed\PubSubHubbub\HttpResponse | \Zend\Http\PhpEnvironment\Response
This is implemented in Zend\Feed\Pubsubhubbub\HttpResponse which shares an unenforced interface with (i.e. not inherited from) Zend\Controller\Response\Http.
| inherited_from | \Zend\Feed\PubSubHubbub\AbstractCallback::$$httpResponse |
|---|
$storage : \Zend\Feed\PubSubHubbub\Model\SubscriptionPersistenceInterface
| inherited_from | \Zend\Feed\PubSubHubbub\AbstractCallback::$$storage |
|---|
$subscriberCount : int
| inherited_from | \Zend\Feed\PubSubHubbub\AbstractCallback::$$subscriberCount |
|---|
$subscriptionKey : string
identifies a unique subscription) which is typical when it is not passed in the query string but is part of the Callback URL path, requiring manual retrieval e.g. using a route and the \Zend\Mvc\Router\RouteMatch::getParam() method.