|
Zend Framework
1.12
|
Public Member Functions | |
| __construct ($config=null) | |
| Constructor; accepts an array or Zend_Config instance to preset options for the Publisher without calling all supported setter methods in turn. | |
| setConfig ($config) | |
| Process any injected configuration options. | |
| addHubUrl ($url) | |
| Add a Hub Server URL supported by Publisher. | |
| addHubUrls (array $urls) | |
| Add an array of Hub Server URLs supported by Publisher. | |
| removeHubUrl ($url) | |
| Remove a Hub Server URL. | |
| getHubUrls () | |
| Return an array of unique Hub Server URLs currently available. | |
| addUpdatedTopicUrl ($url) | |
| Add a URL to a topic (Atom or RSS feed) which has been updated. | |
| addUpdatedTopicUrls (array $urls) | |
| Add an array of Topic URLs which have been updated. | |
| removeUpdatedTopicUrl ($url) | |
| Remove an updated topic URL. | |
| getUpdatedTopicUrls () | |
| Return an array of unique updated topic URLs currently available. | |
| notifyHub ($url) | |
| Notifies a single Hub Server URL of changes. | |
| notifyAll () | |
| Notifies all Hub Server URLs of changes. | |
| setParameter ($name, $value=null) | |
| Add an optional parameter to the update notification requests. | |
| setParameters (array $parameters) | |
| Add an optional parameter to the update notification requests. | |
| removeParameter ($name) | |
| Remove an optional parameter for the notification requests. | |
| getParameters () | |
| Return an array of optional parameters for notification requests. | |
| isSuccess () | |
| Returns a boolean indicator of whether the notifications to Hub Servers were ALL successful. | |
| 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. | |
Protected Member Functions | |
| _getHttpClient () | |
| Get a basic prepared HTTP client for use. | |
Protected Attributes | |
| $_hubUrls = array() | |
| $_updatedTopicUrls = array() | |
| $_errors = array() | |
| $_parameters = array() | |
| __construct | ( | $config = null | ) |
Constructor; accepts an array or Zend_Config instance to preset options for the Publisher without calling all supported setter methods in turn.
| array | Zend_Config | $options | Options array or Zend_Config instance |
|
protected |
Get a basic prepared HTTP client for use.
| addHubUrl | ( | $url | ) |
Add a Hub Server URL supported by Publisher.
| string | $url |
| addHubUrls | ( | array | $urls | ) |
Add an array of Hub Server URLs supported by Publisher.
| array | $urls |
| addUpdatedTopicUrl | ( | $url | ) |
Add a URL to a topic (Atom or RSS feed) which has been updated.
| string | $url |
| addUpdatedTopicUrls | ( | array | $urls | ) |
Add an array of Topic URLs which have been updated.
| array | $urls |
| 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.
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.
| Zend_Feed_Pubsubhubbub_Exception | Thrown if no hubs attached |
| notifyHub | ( | $url | ) |
Notifies a single Hub Server URL of changes.
| string | $url | The Hub Server's URL |
| Zend_Feed_Pubsubhubbub_Exception | Thrown on failure |
| removeHubUrl | ( | $url | ) |
| removeParameter | ( | $name | ) |
Remove an optional parameter for the notification requests.
| string | $name |
| removeUpdatedTopicUrl | ( | $url | ) |
| setConfig | ( | $config | ) |
Process any injected configuration options.
| array | Zend_Config | $options | Options array or Zend_Config instance |
| setParameter | ( | $name, | |
$value = null |
|||
| ) |
Add an optional parameter to the update notification requests.
| string | $name | |
| string | null | $value |
| setParameters | ( | array | $parameters | ) |
Add an optional parameter to the update notification requests.
| array | $parameters |
|
protected |
|
protected |
|
protected |
|
protected |
1.8.3