Methods
Constructor; accepts an array or Zend\Config\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 URL to a topic (Atom or RSS feed) which has been updated
addUpdatedTopicUrl(string $url) : \Zend\Feed\PubSubHubbub\Publisher
Parameters
$url
string
Exceptions
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
Return an array of unique Hub Server URLs currently available
getHubUrls() : array
Return an array of optional parameters for notification requests
getParameters() : array
Return an array of unique updated topic URLs currently available
getUpdatedTopicUrls() : 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
Notifies a single Hub Server URL of changes
notifyHub(string $url) : void
Parameters
$url
stringThe Hub Server's URL
Exceptions
Remove an optional parameter for the notification requests
removeParameter(string $name) : \Zend\Feed\PubSubHubbub\Publisher
Parameters
$name
string
Exceptions
Returns
Process any injected configuration options
setOptions(array | \Traversable $options) : \Zend\Feed\PubSubHubbub\Publisher
Parameters
$options
array\TraversableOptions array or Traversable object
Exceptions
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
Returns
Add an optional parameter to the update notification requests
setParameters(array $parameters) : \Zend\Feed\PubSubHubbub\Publisher
Parameters
$parameters
array
Returns
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