Zend\Feed\PubSubHubbub\Publisher
Synopsis
class Publisher
{
- // members
- protected array $hubUrls;
- protected array $updatedTopicUrls;
- protected array $errors;
- protected array $parameters;
- // methods
- public void __construct()
- public Publisher setOptions()
- public Publisher addHubUrl()
- public Publisher addHubUrls()
- public Publisher removeHubUrl()
- public array getHubUrls()
- public Publisher addUpdatedTopicUrl()
- public Publisher addUpdatedTopicUrls()
- public Publisher removeUpdatedTopicUrl()
- public array getUpdatedTopicUrls()
- public void notifyHub()
- public void notifyAll()
- public Publisher setParameter()
- public Publisher setParameters()
- public Publisher removeParameter()
- public array getParameters()
- public bool isSuccess()
- public array getErrors()
- protected Client _getHttpClient()
Members
protected
- $errors
—
array
An array of any errors including keys for 'response', 'hubUrl'. - $hubUrls
—
array
An array of URLs for all Hub Servers used by the Publisher, and to which all topic update notifications will be sent. - $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
An array of topic (Atom or RSS feed) URLs which have been updated and whose updated status will be notified to all Hub Servers.
Methods
protected
- _getHttpClient() — Get a basic prepared HTTP client for use
public
- __construct() — Constructor; accepts an array or Zend\Config\Config instance to preset options for the Publisher without calling all supported setter methods in turn.
- addHubUrl() — Add a Hub Server URL supported by Publisher
- addHubUrls() — Add an array of Hub Server URLs supported by Publisher
- addUpdatedTopicUrl() — Add a URL to a topic (Atom or RSS feed) which has been updated
- addUpdatedTopicUrls() — Add an array of Topic URLs which have been updated
- getErrors() — 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
- getHubUrls() — Return an array of unique Hub Server URLs currently available
- getParameters() — Return an array of optional parameters for notification requests
- getUpdatedTopicUrls() — Return an array of unique updated topic URLs currently available
- isSuccess() — Returns a boolean indicator of whether the notifications to Hub Servers were ALL successful. If even one failed, FALSE is returned.
- notifyAll() — Notifies all Hub Server URLs of changes
- notifyHub() — Notifies a single Hub Server URL of changes
- removeHubUrl() — Remove a Hub Server URL
- removeParameter() — Remove an optional parameter for the notification requests
- removeUpdatedTopicUrl() — Remove an updated topic URL
- setOptions() — Process any injected configuration options
- setParameter() — Add an optional parameter to the update notification requests
- setParameters() — Add an optional parameter to the update notification requests