Class Zend_Feed_Atom

Description

Atom feed class

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

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

Located in /Zend/Feed/Atom.php (line 48)

Zend_Feed_Element
   |
   --Zend_Feed_Abstract
      |
      --Zend_Feed_Atom
Variable Summary
Method Summary
 mixed link ([string $rel = null])
 mixed __get (string $var)
 void __wakeup ()
Variables
string $_defaultNamespace = 'atom' (line 71)

The default namespace for Atom feeds.

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

The classname for individual feed elements.

  • access: protected
string $_entryElementName = 'entry' (line 64)

The element name for individual feed elements (Atom <entry> elements).

  • 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::$_parentElement
Methods
link (line 121)

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

If $elt->link() is called with no arguments, we will attempt to return the value of the <link> tag(s) like all other method-syntax attribute access. If an argument is passed to link(), however, then we will return the "href" value of the first <link> tag that has a "rel" attribute matching $rel:

$elt->link(): returns the value of the link tag. $elt->link('self'): returns the href from the first <link rel="self"> in the entry.

  • access: public
mixed link ([string $rel = null])
  • string $rel: The "rel" attribute to look for.
__get (line 161)

Make accessing some individual elements of the feed easier.

Special accessors 'entry' and 'entries' are provided so that if you wish to iterate over an Atom feed's entries, you can do so using foreach ($feed->entries as $entry) or foreach ($feed->entry as $entry).

  • 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 77)

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

  • 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::valid()
 Zend_Feed_Abstract::_buildEntryCache()
 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::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::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 Wed, 21 Feb 2007 11:45:50 -0800 by phpDocumentor 1.3.1