Documentation

Horde_Feed_Rss extends Horde_Feed_Base
in package

RSS channel class

The Horde_Feed_Rss class is a concrete subclass of Horde_Feed_Base meant for representing RSS channels. It does not add any methods to its parent, just provides a classname to check against with the instanceof operator, and expects to be handling RSS-formatted data instead of Atom.

Tags
author

Chuck Hagenbuch chuck@horde.org

category

Horde

copyright

2005-2007 Zend Technologies USA Inc.

copyright

2007-2017 Horde LLC

license

http://www.horde.org/licenses/bsd BSD

Table of Contents

$_defaultNamespace  : string
The default namespace for RSS channels.
$_emptyXml  : string
The XML string for an "empty" RSS feed.
$_httpClient  : Horde_Http_Client
$_listItemClassName  : string
The classname for individual channel elements.
$_uri  : string
Our root ("home") URI
__construct()  : mixed
Feed constructor
__wakeup()  : mixed
Handle null or array values for $this->_element by initializing with $this->_emptyXml, and importing the array with Horde_Xml_Element::fromArray() if necessary.
_buildListItemCache()  : array<string|int, mixed>
Cache the individual feed elements so they don't need to be searched for on every operation.

Properties

$_defaultNamespace

The default namespace for RSS channels.

protected string $_defaultNamespace = 'rss'

$_emptyXml

The XML string for an "empty" RSS feed.

protected string $_emptyXml = '<?xml version="1.0" encoding="utf-8"?><rss version="2.0"><channel></channel></rss>'

$_httpClient

protected Horde_Http_Client $_httpClient

$_listItemClassName

The classname for individual channel elements.

protected string $_listItemClassName = 'Horde_Feed_Entry_Rss'

$_uri

Our root ("home") URI

protected string $_uri

Methods

__construct()

Feed constructor

public __construct([mixed $xml = null ][, string $uri = null ][, Horde_Http_Client $httpClient = null ]) : mixed

The Horde_Feed_Base constructor takes the URI of a feed or a feed represented as a string and loads it as XML.

Parameters
$xml : mixed = null

The feed as a string, a DOMElement, or null.

$uri : string = null

The full URI of the feed, or null if unknown.

$httpClient : Horde_Http_Client = null
Tags
throws
Horde_Feed_Exception

If loading the feed failed.

Return values
mixed

__wakeup()

Handle null or array values for $this->_element by initializing with $this->_emptyXml, and importing the array with Horde_Xml_Element::fromArray() if necessary.

public __wakeup() : mixed
Tags
see
Horde_Xml_Element::__wakeup
see
Horde_Xml_Element::fromArray
Return values
mixed

_buildListItemCache()

Cache the individual feed elements so they don't need to be searched for on every operation.

protected _buildListItemCache() : array<string|int, mixed>
Return values
array<string|int, mixed>

Search results