Feed/Pubsubhubbub/Publisher.php
inherited
Classes
Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to [email protected] so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Feed_Pubsubhubbub
- Version
- $Id: Publisher.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Feed_Pubsubhubbub_Publisher
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
array $_errors = array()An array of any errors including keys for 'response', 'hubUrl'.
The response is the actual Zend_Http_Response object.
array()Details- Type
- array
array $_hubUrls = array()An array of URLs for all Hub Servers used by the Publisher, and to which all topic update notifications will be sent.
array()Details- Type
- array
array $_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.
array()Details- Type
- array
array $_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.
array()Details- Type
- array
Methods
__construct( $config = null) : voidConstructor; accepts an array or Zend_Config instance to preset options for the Publisher without calling all supported setter methods in turn.
| Name | Type | Description |
|---|---|---|
| $config |
_getHttpClient() : \Zend_Http_ClientGet a basic prepared HTTP client for use
| Type | Description |
|---|---|
| \Zend_Http_Client |
addHubUrl(string $url) : \Zend_Feed_Pubsubhubbub_PublisherAdd a Hub Server URL supported by Publisher
| Name | Type | Description |
|---|---|---|
| $url | string |
| Type | Description |
|---|---|
| \Zend_Feed_Pubsubhubbub_Publisher |
addHubUrls(array $urls) : \Zend_Feed_Pubsubhubbub_PublisherAdd an array of Hub Server URLs supported by Publisher
| Name | Type | Description |
|---|---|---|
| $urls | array |
| Type | Description |
|---|---|
| \Zend_Feed_Pubsubhubbub_Publisher |
addUpdatedTopicUrl(string $url) : \Zend_Feed_Pubsubhubbub_PublisherAdd a URL to a topic (Atom or RSS feed) which has been updated
| Name | Type | Description |
|---|---|---|
| $url | string |
| Type | Description |
|---|---|
| \Zend_Feed_Pubsubhubbub_Publisher |
addUpdatedTopicUrls(array $urls) : \Zend_Feed_Pubsubhubbub_PublisherAdd an array of Topic URLs which have been updated
| Name | Type | Description |
|---|---|---|
| $urls | array |
| Type | Description |
|---|---|
| \Zend_Feed_Pubsubhubbub_Publisher |
getErrors() : arrayReturn 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
| Type | Description |
|---|---|
| array |
getHubUrls() : arrayReturn an array of unique Hub Server URLs currently available
| Type | Description |
|---|---|
| array |
getParameters() : arrayReturn an array of optional parameters for notification requests
| Type | Description |
|---|---|
| array |
getUpdatedTopicUrls() : arrayReturn an array of unique updated topic URLs currently available
| Type | Description |
|---|---|
| array |
isSuccess() : boolReturns a boolean indicator of whether the notifications to Hub Servers were ALL successful.
If even one failed, FALSE is returned.
| Type | Description |
|---|---|
| bool |
notifyAll() : voidNotifies 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.
| Exception | Description |
|---|---|
| \Zend_Feed_Pubsubhubbub_Exception | Thrown if no hubs attached |
notifyHub(string $url) : voidNotifies a single Hub Server URL of changes
| Name | Type | Description |
|---|---|---|
| $url | string | The Hub Server's URL |
| Exception | Description |
|---|---|
| \Zend_Feed_Pubsubhubbub_Exception | Thrown on failure |
removeHubUrl(string $url) : \Zend_Feed_Pubsubhubbub_PublisherRemove a Hub Server URL
| Name | Type | Description |
|---|---|---|
| $url | string |
| Type | Description |
|---|---|
| \Zend_Feed_Pubsubhubbub_Publisher |
removeParameter(string $name) : \Zend_Feed_Pubsubhubbub_PublisherRemove an optional parameter for the notification requests
| Name | Type | Description |
|---|---|---|
| $name | string |
| Type | Description |
|---|---|
| \Zend_Feed_Pubsubhubbub_Publisher |
removeUpdatedTopicUrl(string $url) : \Zend_Feed_Pubsubhubbub_PublisherRemove an updated topic URL
| Name | Type | Description |
|---|---|---|
| $url | string |
| Type | Description |
|---|---|
| \Zend_Feed_Pubsubhubbub_Publisher |
setConfig( $config) : \Zend_Feed_Pubsubhubbub_PublisherProcess any injected configuration options
| Name | Type | Description |
|---|---|---|
| $config |
| Type | Description |
|---|---|
| \Zend_Feed_Pubsubhubbub_Publisher |
setParameter(string $name, string | null $value = null) : \Zend_Feed_Pubsubhubbub_PublisherAdd an optional parameter to the update notification requests
| Name | Type | Description |
|---|---|---|
| $name | string | |
| $value | string | null |
| Type | Description |
|---|---|
| \Zend_Feed_Pubsubhubbub_Publisher |
setParameters(array $parameters) : \Zend_Feed_Pubsubhubbub_PublisherAdd an optional parameter to the update notification requests
| Name | Type | Description |
|---|---|---|
| $parameters | array |
| Type | Description |
|---|---|
| \Zend_Feed_Pubsubhubbub_Publisher |