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_ConfignullOptions array or Zend_Config instance
Exceptions
\Zend_Feed_Pubsubhubbub_Exception |
|
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 |
|
Returns
\Zend_Feed_Pubsubhubbub_Subscriber
Add authentication credentials for hub URLs
addAuthentications(array $authentications) : \Zend_Feed_Pubsubhubbub_Subscriber
Parameters
$authentications
array
Returns
\Zend_Feed_Pubsubhubbub_Subscriber
Add a Hub Server URL supported by Publisher
addHubUrl(string $url) : \Zend_Feed_Pubsubhubbub_Subscriber
Parameters
$url
string
Exceptions
\Zend_Feed_Pubsubhubbub_Exception |
|
Returns
\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
\Zend_Feed_Pubsubhubbub_Subscriber
Return an array of Hub Server URLs who returned a response indicating
operation in Asynchronous Verification Mode, i.e. 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)
getAsyncHubs() : array
Get all hub URL authentication credentials
getAuthentications() : array
Get the callback URL to be used by Hub Servers when communicating with
this Subscriber
getCallbackUrl() : string
Exceptions
\Zend_Feed_Pubsubhubbub_Exception |
|
Returns
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
Return an array of unique Hub Server URLs currently available
getHubUrls() : array
Get the number of lease seconds on subscriptions
getLeaseSeconds() : integer
Return an array of optional parameters for (un)subscribe requests
getParameters() : array
Get preferred verification mode (sync or async).
getPreferredVerificationMode() : string
Gets an instance of Zend_Feed_Pubsubhubbub_Storage_StorageInterface 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
Set the topic URL (RSS or Atom feed) to which the intended (un)subscribe
event will relate
getTopicUrl() : string
Exceptions
\Zend_Feed_Pubsubhubbub_Exception |
|
Returns
string
Returns a boolean indicator of whether the notifications to Hub
Servers were ALL successful. If even one failed, FALSE is returned.
isSuccess() : boolean
Remove a Hub Server URL
removeHubUrl(string $url) : \Zend_Feed_Pubsubhubbub_Subscriber
Parameters
$url
string
Returns
\Zend_Feed_Pubsubhubbub_Subscriber
Remove an optional parameter for the (un)subscribe requests
removeParameter(string $name) : \Zend_Feed_Pubsubhubbub_Subscriber
Parameters
$name
string
Exceptions
\Zend_Feed_Pubsubhubbub_Exception |
|
Returns
\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
Parameters
$url
string
Exceptions
\Zend_Feed_Pubsubhubbub_Exception |
|
Returns
\Zend_Feed_Pubsubhubbub_Subscriber
Process any injected configuration options
setConfig(array|\Zend_Config $config) : \Zend_Feed_Pubsubhubbub_Subscriber
Parameters
$config
array\Zend_ConfigOptions array or Zend_Config instance
Exceptions
\Zend_Feed_Pubsubhubbub_Exception |
|
Returns
\Zend_Feed_Pubsubhubbub_Subscriber
Set the number of seconds for which any subscription will remain valid
setLeaseSeconds(integer $seconds) : \Zend_Feed_Pubsubhubbub_Subscriber
Parameters
$seconds
integer
Exceptions
\Zend_Feed_Pubsubhubbub_Exception |
|
Returns
\Zend_Feed_Pubsubhubbub_Subscriber
Add an optional parameter to the (un)subscribe requests
setParameter(string $name, string|null $value = null) : \Zend_Feed_Pubsubhubbub_Subscriber
Parameters
$name
string
$value
stringnull
Exceptions
\Zend_Feed_Pubsubhubbub_Exception |
|
Returns
\Zend_Feed_Pubsubhubbub_Subscriber
Add an optional parameter to the (un)subscribe requests
setParameters(array $parameters) : \Zend_Feed_Pubsubhubbub_Subscriber
Parameters
$parameters
array
Exceptions
\Zend_Feed_Pubsubhubbub_Exception |
|
Returns
\Zend_Feed_Pubsubhubbub_Subscriber
Set preferred verification mode (sync or async). By default, this
Subscriber prefers synchronous verification, but does support
asynchronous if that's the Hub Server's utilised mode.
setPreferredVerificationMode(string $mode) : \Zend_Feed_Pubsubhubbub_Subscriber
Zend_Feed_Pubsubhubbub_Subscriber will always send both modes, whose
order of occurance in the parameter list determines this preference.
Parameters
$mode
stringShould be 'sync' or 'async'
Exceptions
\Zend_Feed_Pubsubhubbub_Exception |
|
Returns
\Zend_Feed_Pubsubhubbub_Subscriber
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_Subscriber
Parameters
$storage
\Zend_Feed_Pubsubhubbub_Model_SubscriptionInterface
Returns
\Zend_Feed_Pubsubhubbub_Subscriber
setTestStaticToken()
setTestStaticToken($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
Parameters
$url
string
Exceptions
\Zend_Feed_Pubsubhubbub_Exception |
|
Returns
\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()
Unsubscribe from one or more Hub Servers using the stored Hub URLs
for the given Topic URL (RSS or Atom feed)
unsubscribeAll()
Set flag indicating whether or not to use a path parameter
usePathParameter(boolean $bool = true) : \Zend_Feed_Pubsubhubbub_Subscriber
Parameters
$bool
boolean
Returns
\Zend_Feed_Pubsubhubbub_Subscriber
Executes an (un)subscribe request
_doRequest(string $mode)
Parameters
$mode
string
Exceptions
\Zend_Feed_Pubsubhubbub_Exception |
|
\Zend_Http_Client_Exception |
|
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
stringThe 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. Follows no particular method, which means
it might be improved/changed in future.
_generateVerifyToken() : string
Get a basic prepared HTTP client for use
_getHttpClient() : \Zend_Http_Client
Returns
\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 |
|
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. The array is indexed by Hub Endpoint URI
and the value is a simple array of the username and password to apply.
$_authentications : array
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. Defaults to null, i.e. not sent, to setup a
permanent subscription if possible.
$_leaseSeconds : integer
An array of optional parameters to be included in any
(un)subscribe requests.
$_parameters : array
The preferred verification mode (sync or async). By default, this
Subscriber prefers synchronous verification, but is considered
desireable to support asynchronous verification if possible.
$_preferredVerificationMode : string
Default
\Zend_Feed_Pubsubhubbub::VERIFICATION_MODE_SYNC
Zend_Feed_Pubsubhubbub_Subscriber will always send both modes, whose
order of occurance in the parameter list determines this preference.
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
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. 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".
$_usePathParameter : string
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.