__construct()
addAuthentication()
addAuthentications()
addHubUrl()
addHubUrls()
getAsyncHubs()
getAuthentications()
getCallbackUrl()
getErrors()
getHubUrls()
getLeaseSeconds()
getParameters()
getPreferredVerificationMode()
getStorage()
getTopicUrl()
isSuccess()
removeHubUrl()
removeParameter()
setCallbackUrl()
setLeaseSeconds()
setOptions()
setParameter()
setParameters()
setPreferredVerificationMode()
setStorage()
setTestStaticToken()
setTopicUrl()
subscribeAll()
unsubscribeAll()
usePathParameter()
_doRequest()
_generateSubscriptionKey()
_generateVerifyToken()
_getHttpClient()
_getRequestParameters()
_toByteValueOrderedString()
_urlEncode()
$asyncHubs
$authentications
$callbackUrl
$errors
$hubUrls
$leaseSeconds
$parameters
$preferredVerificationMode
$storage
$testStaticToken
$topicUrl
$usePathParameter
__construct(array | \Traversable $options)
array\Traversable
addAuthentication(string $url, array $authentication) : \Zend\Feed\PubSubHubbub\Subscriber
string
array
\Zend\Feed\PubSubHubbub\Exception\InvalidArgumentException |
|---|
addAuthentications(array $authentications) : \Zend\Feed\PubSubHubbub\Subscriber
addHubUrl(string $url) : \Zend\Feed\PubSubHubbub\Subscriber
string
\Zend\Feed\PubSubHubbub\Exception\InvalidArgumentException |
|---|
addHubUrls(array $urls) : \Zend\Feed\PubSubHubbub\Subscriber
getAsyncHubs() : array
they will not confirm any (un)subscription immediately but at a later time (Hubs may be doing this as a batch process when load balancing)
arraygetAuthentications() : array
arraygetCallbackUrl() : string
getErrors() : array
arraygetHubUrls() : array
arraygetLeaseSeconds() : int
intgetParameters() : array
arraygetPreferredVerificationMode() : string
stringgetStorage() : \Zend\Feed\PubSubHubbub\Model\SubscriptionPersistenceInterface
getTopicUrl() : string
isSuccess() : bool
If even one failed, FALSE is returned.
boolremoveParameter(string $name) : \Zend\Feed\PubSubHubbub\Subscriber
string
\Zend\Feed\PubSubHubbub\Exception\InvalidArgumentException |
|---|
setCallbackUrl(string $url) : \Zend\Feed\PubSubHubbub\Subscriber
string
\Zend\Feed\PubSubHubbub\Exception\InvalidArgumentException |
|---|
setLeaseSeconds(int $seconds) : \Zend\Feed\PubSubHubbub\Subscriber
int
\Zend\Feed\PubSubHubbub\Exception\InvalidArgumentException |
|---|
setOptions(array | \Traversable $options) : \Zend\Feed\PubSubHubbub\Subscriber
array\Traversable
\Zend\Feed\PubSubHubbub\Exception\InvalidArgumentException |
|---|
setParameter(string $name, string | null $value) : \Zend\Feed\PubSubHubbub\Subscriber
string
stringnull
\Zend\Feed\PubSubHubbub\Exception\InvalidArgumentException |
|---|
setParameters(array $parameters) : \Zend\Feed\PubSubHubbub\Subscriber
setPreferredVerificationMode(string $mode) : \Zend\Feed\PubSubHubbub\Subscriber
By default, this Subscriber prefers synchronous verification, but does support asynchronous if that's the Hub Server's utilised mode.
Zend\Feed\Pubsubhubbub\Subscriber will always send both modes, whose order of occurrence in the parameter list determines this preference.
stringShould be 'sync' or 'async'
\Zend\Feed\PubSubHubbub\Exception\InvalidArgumentException |
|---|
setStorage(\Zend\Feed\PubSubHubbub\Model\SubscriptionPersistenceInterface $storage) : \Zend\Feed\PubSubHubbub\Subscriber
setTestStaticToken($token)
setTopicUrl(string $url) : \Zend\Feed\PubSubHubbub\Subscriber
string
\Zend\Feed\PubSubHubbub\Exception\InvalidArgumentException |
|---|
subscribeAll() : void
unsubscribeAll() : void
usePathParameter(bool $bool) : \Zend\Feed\PubSubHubbub\Subscriber
_doRequest(string $mode) : void
_generateSubscriptionKey(array $params, string $hubUrl) : string
array
stringThe Hub Server URL for which this token will apply
string_generateVerifyToken() : string
Follows no particular method, which means it might be improved/changed in future.
string_getRequestParameters(string $hubUrl, string $mode) : string
string
string
\Zend\Feed\PubSubHubbub\Exception\InvalidArgumentException |
|---|
string_toByteValueOrderedString(array $params) : array
array
array_urlEncode(array $params) : array
array
array$asyncHubs : array
$authentications : array
The array is indexed by Hub Endpoint URI and the value is a simple array of the username and password to apply.
$callbackUrl : string
$errors : array
The response is the actual Zend\Http\Response object.
$hubUrls : array
$leaseSeconds : int
Defaults to null, i.e. not sent, to setup a permanent subscription if possible.
$parameters : array
$preferredVerificationMode : string
By default, this Subscriber prefers synchronous verification, but is considered desirable to support asynchronous verification if possible.
Zend\Feed\Pubsubhubbub\Subscriber will always send both modes, whose order of occurrence in the parameter list determines this preference.
$storage : \Zend\Feed\PubSubHubbub\Model\SubscriptionPersistenceInterface
$testStaticToken
..
$topicUrl : string
$usePathParameter : string
E.g. an identifier "subkey1" would be added to the callback URL "http://www.example.com/callback" to create a subscription specific Callback URL of "http://www.example.com/callback/subkey1".
This is required for all Hubs using the Pubsubhubbub 0.1 Specification. It should be manually intercepted and passed to the Callback class using Zend\Feed\Pubsubhubbub\Subscriber\Callback::setSubscriptionKey(). Will require a route in the form "callback/:subkey" to allow the parameter be retrieved from an action using the Zend\Controller\Action::\getParam() method.