Class Zend_Feed_Rss

Description

RSS channel class

The Zend_Feed_Rss class is a concrete subclass of Zend_Feed_Abstract 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.

  • copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  • license: New BSD License

Located in /Feed/Rss.php (line 49)

Zend_Feed_Element
   |
   --Zend_Feed_Abstract
      |
      --Zend_Feed_Rss
Variable Summary
Method Summary
 string saveXml ()
 void send ()
 void _mapFeedEntries ( $root, array $array)
 DOMElement _mapFeedHeaders (array $array)
 mixed __get (string $var)
 void __wakeup ()
Variables
string $_defaultNamespace = 'rss' (line 70)

The default namespace for RSS channels.

  • access: protected
string $_entryClassName = 'Zend_Feed_Entry_Rss' (line 56)

The classname for individual channel elements.

  • access: protected
string $_entryElementName = 'item' (line 63)

The element name for individual channel elements (RSS <item>s).

  • access: protected

Inherited Variables

Inherited from Zend_Feed_Abstract

Zend_Feed_Abstract::$_entries
Zend_Feed_Abstract::$_entryIndex

Inherited from Zend_Feed_Element

Zend_Feed_Element::$_appended
Zend_Feed_Element::$_element
Zend_Feed_Element::$_encoding
Zend_Feed_Element::$_parentElement
Methods
saveXml (line 485)

Override Zend_Feed_Element to include <rss> root node

  • access: public
string saveXml ()

Redefinition of:
Zend_Feed_Element::saveXml()
Get an XML string representation of this element
send (line 514)

Send feed to a http client with the correct header

  • throws: Zend_Feed_Exception if headers have already been sent
  • access: public
void send ()

Redefinition of:
Zend_Feed_Abstract::send()
Send feed to a http client with the correct header
_mapFeedEntries (line 393)

Generate the entries of the feed when working in write mode

The following nodes are constructed for each feed entry <item> <title>entry title</title> <link>url to feed entry</link> <guid>url to feed entry</guid> <description>short text</description> <content:encoded>long version, can contain html</content:encoded> </item>

  • access: protected
void _mapFeedEntries ( $root, array $array)
  • DOMElement $root: the root node to use
  • array $array: the data to use

Redefinition of:
Zend_Feed_Abstract::_mapFeedEntries()
Generate the entries of the feed when working in write mode
_mapFeedHeaders (line 133)

Generate the header of the feed when working in write mode

  • return: root node
  • access: protected
DOMElement _mapFeedHeaders (array $array)
  • array $array: the data to use

Redefinition of:
Zend_Feed_Abstract::_mapFeedHeaders()
Generate the header of the feed when working in write mode
__get (line 114)

Make accessing some individual elements of the channel easier.

Special accessors 'item' and 'items' are provided so that if you wish to iterate over an RSS channel's items, you can do so using foreach ($channel->items as $item) or foreach ($channel->item as $item).

  • access: public
mixed __get (string $var)
  • string $var: The property to access.

Redefinition of:
Zend_Feed_Element::__get()
Map variable access onto the underlying entry representation.
__wakeup (line 78)

Override Zend_Feed_Abstract to set up the $_element and $_entries aliases.

  • throws: Zend_Feed_Exception
  • access: public
void __wakeup ()

Redefinition of:
Zend_Feed_Abstract::__wakeup()
Load the feed as an XML DOMDocument object

Inherited Methods

Inherited From Zend_Feed_Abstract

 Zend_Feed_Abstract::__construct()
 Zend_Feed_Abstract::count()
 Zend_Feed_Abstract::current()
 Zend_Feed_Abstract::key()
 Zend_Feed_Abstract::next()
 Zend_Feed_Abstract::rewind()
 Zend_Feed_Abstract::send()
 Zend_Feed_Abstract::valid()
 Zend_Feed_Abstract::_buildEntryCache()
 Zend_Feed_Abstract::_mapFeedEntries()
 Zend_Feed_Abstract::_mapFeedHeaders()
 Zend_Feed_Abstract::__sleep()
 Zend_Feed_Abstract::__wakeup()

Inherited From Zend_Feed_Element

 Zend_Feed_Element::__construct()
 Zend_Feed_Element::ensureAppended()
 Zend_Feed_Element::getDOM()
 Zend_Feed_Element::getEncoding()
 Zend_Feed_Element::offsetExists()
 Zend_Feed_Element::offsetGet()
 Zend_Feed_Element::offsetSet()
 Zend_Feed_Element::offsetUnset()
 Zend_Feed_Element::saveXml()
 Zend_Feed_Element::saveXmlFragment()
 Zend_Feed_Element::setDOM()
 Zend_Feed_Element::setEncoding()
 Zend_Feed_Element::setParent()
 Zend_Feed_Element::_children()
 Zend_Feed_Element::__call()
 Zend_Feed_Element::__get()
 Zend_Feed_Element::__isset()
 Zend_Feed_Element::__set()
 Zend_Feed_Element::__toString()
 Zend_Feed_Element::__unset()

Documentation generated on Mon, 21 Jun 2010 15:43:11 -0400 by phpDocumentor 1.4.3