Feed/Pubsubhubbub/Publisher.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Feed_Pubsubhubbub
Classes: Zend_Feed_Pubsubhubbub_Publisher

Description

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 license@zend.com so we can send you a copy immediately.

Zend_Feed_Pubsubhubbub_Publisher
jump to top

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Feed_Pubsubhubbub
Properties: $_hubUrls; $_updatedTopicUrls; $_errors; $_parameters
Methods: __construct; setConfig; addHubUrl; addHubUrls; removeHubUrl; getHubUrls; addUpdatedTopicUrl; addUpdatedTopicUrls; removeUpdatedTopicUrl; getUpdatedTopicUrls; notifyHub; notifyAll; setParameter; setParameters; removeParameter; getParameters; isSuccess; getErrors; _getHttpClient

Description

Properties

$_errors
jump to class

array $_errors = 'array'

An array of any errors including keys for 'response', 'hubUrl'.

The response is the actual Zend_Http_Response object.

Details

$_errors: array
visibility: protected
default: array
final: false
static: false

$_hubUrls
jump to class

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.

Details

$_hubUrls: array
visibility: protected
default: array
final: false
static: false

$_parameters
jump to class

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.

Details

$_parameters: array
visibility: protected
default: array
final: false
static: false

$_updatedTopicUrls
jump to class

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.

Details

$_updatedTopicUrls: array
visibility: protected
default: array
final: false
static: false

Methods

__construct
jump to class

__construct(
           $config
              =
              null
          )
        
        :
        void

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

Arguments

$config

Details

visibility: public
final: false
static: false

_getHttpClient
jump to class

_getHttpClient(
          
          )
        
        :
        Zend_Http_Client

Get a basic prepared HTTP client for use

Output

Zend_Http_Client

Details

visibility: protected
final: false
static: false

addHubUrl
jump to class

addHubUrl(
          string $url
          )
        
        :
        Zend_Feed_Pubsubhubbub_Publisher

Add a Hub Server URL supported by Publisher

Arguments

$url: string

Output

Zend_Feed_Pubsubhubbub_Publisher

Details

visibility: public
final: false
static: false

addHubUrls
jump to class

addHubUrls(
          array $urls
          )
        
        :
        Zend_Feed_Pubsubhubbub_Publisher

Add an array of Hub Server URLs supported by Publisher

Arguments

$urls: array

Output

Zend_Feed_Pubsubhubbub_Publisher

Details

visibility: public
final: false
static: false

addUpdatedTopicUrl
jump to class

addUpdatedTopicUrl(
          string $url
          )
        
        :
        Zend_Feed_Pubsubhubbub_Publisher

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

Arguments

$url: string

Output

Zend_Feed_Pubsubhubbub_Publisher

Details

visibility: public
final: false
static: false

addUpdatedTopicUrls
jump to class

addUpdatedTopicUrls(
          array $urls
          )
        
        :
        Zend_Feed_Pubsubhubbub_Publisher

Add an array of Topic URLs which have been updated

Arguments

$urls: array

Output

Zend_Feed_Pubsubhubbub_Publisher

Details

visibility: public
final: false
static: false

getErrors
jump to class

getErrors(
          
          )
        
        :
        array

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

Output

array

Details

visibility: public
final: false
static: false

getHubUrls
jump to class

getHubUrls(
          
          )
        
        :
        array

Return an array of unique Hub Server URLs currently available

Output

array

Details

visibility: public
final: false
static: false

getParameters
jump to class

getParameters(
          
          )
        
        :
        array

Return an array of optional parameters for notification requests

Output

array

Details

visibility: public
final: false
static: false

getUpdatedTopicUrls
jump to class

getUpdatedTopicUrls(
          
          )
        
        :
        array

Return an array of unique updated topic URLs currently available

Output

array

Details

visibility: public
final: false
static: false

isSuccess
jump to class

isSuccess(
          
          )
        
        :
        bool

Returns a boolean indicator of whether the notifications to Hub Servers were ALL successful. If even one failed, FALSE is returned.

Output

bool

Details

visibility: public
final: false
static: false

notifyAll
jump to class

notifyAll(
          
          )
        
        :
        void

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.

Details

visibility: public
final: false
static: false
throws: Thrown if no hubs attached

notifyHub
jump to class

notifyHub(
          string $url
          )
        
        :
        void

Notifies a single Hub Server URL of changes

Arguments

$url: string
The Hub Server's URL

Details

visibility: public
final: false
static: false
throws: Thrown on failure

removeHubUrl
jump to class

removeHubUrl(
          string $url
          )
        
        :
        Zend_Feed_Pubsubhubbub_Publisher

Remove a Hub Server URL

Arguments

$url: string

Output

Zend_Feed_Pubsubhubbub_Publisher

Details

visibility: public
final: false
static: false

removeParameter
jump to class

removeParameter(
          string $name
          )
        
        :
        Zend_Feed_Pubsubhubbub_Publisher

Remove an optional parameter for the notification requests

Arguments

$name: string

Output

Zend_Feed_Pubsubhubbub_Publisher

Details

visibility: public
final: false
static: false

removeUpdatedTopicUrl
jump to class

removeUpdatedTopicUrl(
          string $url
          )
        
        :
        Zend_Feed_Pubsubhubbub_Publisher

Remove an updated topic URL

Arguments

$url: string

Output

Zend_Feed_Pubsubhubbub_Publisher

Details

visibility: public
final: false
static: false

setConfig
jump to class

setConfig(
           $config
          )
        
        :
        Zend_Feed_Pubsubhubbub_Publisher

Process any injected configuration options

Arguments

$config

Output

Zend_Feed_Pubsubhubbub_Publisher

Details

visibility: public
final: false
static: false

setParameter
jump to class

setParameter(
          string $name, string|null $value
              =
              null
          )
        
        :
        Zend_Feed_Pubsubhubbub_Publisher

Add an optional parameter to the update notification requests

Arguments

$name: string
$value: stringnull

Output

Zend_Feed_Pubsubhubbub_Publisher

Details

visibility: public
final: false
static: false

setParameters
jump to class

setParameters(
          array $parameters
          )
        
        :
        Zend_Feed_Pubsubhubbub_Publisher

Add an optional parameter to the update notification requests

Arguments

$parameters: array

Output

Zend_Feed_Pubsubhubbub_Publisher

Details

visibility: public
final: false
static: false

API Documentation

Feed/Pubsubhubbub/Publisher.php

Description

Zend_Feed_Pubsubhubbub_Publisherjump to top

Description

Properties

$_errorsjump to class

Details

$_hubUrlsjump to class

Details

$_parametersjump to class

Details

$_updatedTopicUrlsjump to class

Details

Methods

__constructjump to class

Arguments

Details

_getHttpClientjump to class

Output

Details

addHubUrljump to class

Arguments

Output

Details

addHubUrlsjump to class

Arguments

Output

Details

addUpdatedTopicUrljump to class

Arguments

Output

Details

addUpdatedTopicUrlsjump to class

Arguments

Output

Details

getErrorsjump to class

Output

Details

getHubUrlsjump to class

Output

Details

getParametersjump to class

Output

Details

getUpdatedTopicUrlsjump to class

Output

Details

isSuccessjump to class

Output

Details

notifyAlljump to class

Details

notifyHubjump to class

Arguments

Details

removeHubUrljump to class

Arguments

Output

Details

removeParameterjump to class

Arguments

Output

Details

removeUpdatedTopicUrljump to class

Arguments

Output

Details

setConfigjump to class

Arguments

Output

Details

setParameterjump to class

Arguments

Output

Details

setParametersjump to class

Arguments

Output

Zend_Feed_Pubsubhubbub_Publisher
jump to top

$_errors
jump to class

$_hubUrls
jump to class

$_parameters
jump to class

$_updatedTopicUrls
jump to class

__construct
jump to class

_getHttpClient
jump to class

addHubUrl
jump to class

addHubUrls
jump to class

addUpdatedTopicUrl
jump to class

addUpdatedTopicUrls
jump to class

getErrors
jump to class

getHubUrls
jump to class

getParameters
jump to class

getUpdatedTopicUrls
jump to class

isSuccess
jump to class

notifyAll
jump to class

notifyHub
jump to class

removeHubUrl
jump to class

removeParameter
jump to class

removeUpdatedTopicUrl
jump to class

setConfig
jump to class

setParameter
jump to class

setParameters
jump to class