category Zend
package Zend_Feed_Pubsubhubbub

 Methods

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

__construct(array | \Traversable $options) 

Parameters

$options

array\Traversable

Add a Hub Server URL supported by Publisher

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

Add an array of Hub Server URLs supported by Publisher

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

Parameters

$urls

array

Returns

Add a URL to a topic (Atom or RSS feed) which has been updated

addUpdatedTopicUrl(string $url) : \Zend\Feed\PubSubHubbub\Publisher

Add an array of Topic URLs which have been updated

addUpdatedTopicUrls(array $urls) : \Zend\Feed\PubSubHubbub\Publisher

Parameters

$urls

array

Returns

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

Return an array of optional parameters for notification requests

getParameters() : array

Returns

array

Return an array of unique updated topic URLs currently available

getUpdatedTopicUrls() : array

Returns

array

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

Notifies all Hub Server URLs of changes

notifyAll() : void

If a Hub notification fails, certain data will be retained in an an array retrieved using getErrors(), if a failure occurs for any Hubs the isSuccess() check will return FALSE. This method is designed not to needlessly fail with an Exception/Error unless from Zend_Http_Client.

Exceptions

\Zend\Feed\PubSubHubbub\Exception\RuntimeException

Notifies a single Hub Server URL of changes

notifyHub(string $url) : void

Remove a Hub Server URL

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

Parameters

$url

string

Returns

Remove an optional parameter for the notification requests

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

Remove an updated topic URL

removeUpdatedTopicUrl(string $url) : \Zend\Feed\PubSubHubbub\Publisher

Parameters

$url

string

Returns

Process any injected configuration options

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

Parameters

$options

array\Traversable

Options array or Traversable object

Exceptions

\Zend\Feed\PubSubHubbub\Exception\InvalidArgumentException

Returns

Add an optional parameter to the update notification requests

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

Parameters

$name

string

$value

stringnull

Exceptions

\Zend\Feed\PubSubHubbub\Exception\InvalidArgumentException

Returns

Add an optional parameter to the update notification requests

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

Parameters

$parameters

array

Returns

Get a basic prepared HTTP client for use

_getHttpClient() : \Zend\Http\Client

 Properties

 

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 used by the Publisher, and to which all topic update notifications will be sent.

$hubUrls : array

 

An array of topic (Atom or RSS feed) URLs which have been updated and whose updated status will be notified to all Hub Servers.

$parameters : array

 

An array of topic (Atom or RSS feed) URLs which have been updated and whose updated status will be notified to all Hub Servers.

$updatedTopicUrls : array