API Documentation
\

\Horde_Feed_Atom

Atom feed class

The Horde_Feed_Atom class is a concrete subclass of the general Horde_Feed_Base class, tailored for representing an Atom feed. It shares all of the same methods with its parent. The distinction is made in the format of data that Horde_Feed_Atom expects, and as a further pointer for users as to what kind of feed object they have been passed.

Summary

Methods
Properties
Constants
__construct()
__wakeup()
link()
No public properties found
No constants found
_buildListItemCache()
$_uri
$_httpClient
$_listItemClassName
$_defaultNamespace
$_emptyXml
N/A
No private methods found
No private properties found
N/A

Properties

$_uri

$_uri : string

Our root ("home") URI

Type

string

$_httpClient

$_httpClient : \Horde_Http_Client

Type

\Horde_Http_Client

$_listItemClassName

$_listItemClassName : string

The classname for individual feed elements.

Type

string

$_defaultNamespace

$_defaultNamespace : string

The default namespace for Atom feeds.

Type

string

$_emptyXml

$_emptyXml : string

The XML string for an "empty" Atom feed.

Type

string

Methods

__construct()

__construct(mixed  $xml = null, string  $uri = null, \Horde_Http_Client  $httpClient = null)

Feed constructor

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

Parameters

mixed $xml

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

The full URI of the feed, or null if unknown.
\Horde_Http_Client $httpClient

Throws

\Horde_Feed_Exception

If loading the feed failed.

__wakeup()

__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.

link()

link(string  $rel = null) : mixed

Easy access to <link> tags keyed by "rel" attributes.

Parameters

string $rel

The "rel" attribute to look for.

Returns

mixed

_buildListItemCache()

_buildListItemCache() : array

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

Returns

array