category Zend
package Zend_Feed_Pubsubhubbub

 Methods

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

__construct(array | \Traversable $options) 

Parameters

$options

array\Traversable

Add authentication credentials for a given URL

addAuthentication(string $url, array $authentication) : \Zend\Feed\PubSubHubbub\Subscriber

Parameters

$url

string

$authentication

array

Exceptions

\Zend\Feed\PubSubHubbub\Exception\InvalidArgumentException

Returns

Add authentication credentials for hub URLs

addAuthentications(array $authentications) : \Zend\Feed\PubSubHubbub\Subscriber

Parameters

$authentications

array

Returns

Add a Hub Server URL supported by Publisher

addHubUrl(string $url) : \Zend\Feed\PubSubHubbub\Subscriber

Add an array of Hub Server URLs supported by Publisher

addHubUrls(array $urls) : \Zend\Feed\PubSubHubbub\Subscriber

Parameters

$urls

array

Returns

Return an array of Hub Server URLs who returned a response indicating operation in Asynchronous Verification Mode, i.e.

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)

Returns

array

Get all hub URL authentication credentials

getAuthentications() : array

Returns

array

Get the callback URL to be used by Hub Servers when communicating with this Subscriber

getCallbackUrl() : string

Return an array of errors met from any failures, including keys: 'response' => the Zend\Http\Response object from the failure 'hubUrl' => the URL of the Hub Server whose notification failed

getErrors() : array

Returns

array

Return an array of unique Hub Server URLs currently available

getHubUrls() : array

Returns

array

Get the number of lease seconds on subscriptions

getLeaseSeconds() : int

Returns

int

Return an array of optional parameters for (un)subscribe requests

getParameters() : array

Returns

array

Get preferred verification mode (sync or async).

getPreferredVerificationMode() : string

Returns

string

Gets an instance of Zend\Feed\Pubsubhubbub\Storage\StoragePersistence used to background save any verification tokens associated with a subscription or other.

getStorage() : \Zend\Feed\PubSubHubbub\Model\SubscriptionPersistenceInterface

Set the topic URL (RSS or Atom feed) to which the intended (un)subscribe event will relate

getTopicUrl() : string

Returns a boolean indicator of whether the notifications to Hub Servers were ALL successful.

isSuccess() : bool

If even one failed, FALSE is returned.

Returns

bool

Remove a Hub Server URL

removeHubUrl(string $url) : \Zend\Feed\PubSubHubbub\Subscriber

Parameters

$url

string

Returns

Remove an optional parameter for the (un)subscribe requests

removeParameter(string $name) : \Zend\Feed\PubSubHubbub\Subscriber

Set the callback URL to be used by Hub Servers when communicating with this Subscriber

setCallbackUrl(string $url) : \Zend\Feed\PubSubHubbub\Subscriber

Set the number of seconds for which any subscription will remain valid

setLeaseSeconds(int $seconds) : \Zend\Feed\PubSubHubbub\Subscriber

Process any injected configuration options

setOptions(array | \Traversable $options) : \Zend\Feed\PubSubHubbub\Subscriber

Add an optional parameter to the (un)subscribe requests

setParameter(string $name, string | null $value) : \Zend\Feed\PubSubHubbub\Subscriber

Parameters

$name

string

$value

stringnull

Exceptions

\Zend\Feed\PubSubHubbub\Exception\InvalidArgumentException

Returns

Add an optional parameter to the (un)subscribe requests

setParameters(array $parameters) : \Zend\Feed\PubSubHubbub\Subscriber

Parameters

$parameters

array

Returns

Set preferred verification mode (sync or async).

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.

Parameters

$mode

string

Should be 'sync' or 'async'

Exceptions

\Zend\Feed\PubSubHubbub\Exception\InvalidArgumentException

Returns

Sets an instance of Zend\Feed\Pubsubhubbub\Model\SubscriptionPersistence used to background save any verification tokens associated with a subscription or other.

setStorage(\Zend\Feed\PubSubHubbub\Model\SubscriptionPersistenceInterface $storage) : \Zend\Feed\PubSubHubbub\Subscriber

setTestStaticToken()

setTestStaticToken($token) 

Parameters

$token

Set the topic URL (RSS or Atom feed) to which the intended (un)subscribe event will relate

setTopicUrl(string $url) : \Zend\Feed\PubSubHubbub\Subscriber

Subscribe to one or more Hub Servers using the stored Hub URLs for the given Topic URL (RSS or Atom feed)

subscribeAll() : void

Unsubscribe from one or more Hub Servers using the stored Hub URLs for the given Topic URL (RSS or Atom feed)

unsubscribeAll() : void

Set flag indicating whether or not to use a path parameter

usePathParameter(bool $bool) : \Zend\Feed\PubSubHubbub\Subscriber

Parameters

$bool

bool

Returns

Executes an (un)subscribe request

_doRequest(string $mode) : void

Parameters

$mode

string

Exceptions

\Zend\Feed\PubSubHubbub\Exception\RuntimeException

Simple helper to generate a verification token used in (un)subscribe requests to a Hub Server.

_generateSubscriptionKey(array $params, string $hubUrl) : string

Parameters

$params

array

$hubUrl

string

The Hub Server URL for which this token will apply

Returns

string

Simple helper to generate a verification token used in (un)subscribe requests to a Hub Server.

_generateVerifyToken() : string

Follows no particular method, which means it might be improved/changed in future.

Returns

string

Get a basic prepared HTTP client for use

_getHttpClient() : \Zend\Http\Client

Return a list of standard protocol/optional parameters for addition to client's POST body that are specific to the current Hub Server URL

_getRequestParameters(string $hubUrl, string $mode) : string

Parameters

$hubUrl

string

$mode

string

Exceptions

\Zend\Feed\PubSubHubbub\Exception\InvalidArgumentException

Returns

string

Order outgoing parameters

_toByteValueOrderedString(array $params) : array

Parameters

$params

array

Returns

array

URL Encode an array of parameters

_urlEncode(array $params) : array

Parameters

$params

array

Returns

array

 Properties

 

An array of Hub Server URLs for Hubs operating at this time in asynchronous verification mode.

$asyncHubs : array

 

An array of authentication credentials for HTTP Basic Authentication if required by specific Hubs.

$authentications : array

The array is indexed by Hub Endpoint URI and the value is a simple array of the username and password to apply.

 

The URL Hub Servers must use when communicating with this Subscriber

$callbackUrl : string

 

An array of any errors including keys for 'response', 'hubUrl'.

$errors : array

The response is the actual Zend\Http\Response object.

 

An array of URLs for all Hub Servers to subscribe/unsubscribe.

$hubUrls : array

 

The number of seconds for which the subscriber would like to have the subscription active.

$leaseSeconds : int

Defaults to null, i.e. not sent, to setup a permanent subscription if possible.

 

An array of optional parameters to be included in any (un)subscribe requests.

$parameters : array

 

The preferred verification mode (sync or async).

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

 

An instance of Zend\Feed\Pubsubhubbub\Model\SubscriptionPersistence used to background save any verification tokens associated with a subscription or other.

$storage : \Zend\Feed\PubSubHubbub\Model\SubscriptionPersistenceInterface

 

This is STRICTLY for testing purposes only.

$testStaticToken 

..

 

The URL of the topic (Rss or Atom feed) which is the subject of our current intent to subscribe to/unsubscribe from updates from the currently configured Hub Servers.

$topicUrl : string

 

Tells the Subscriber to append any subscription identifier to the path of the base Callback URL.

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