\Zend_Feed_Atom
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.
- Copyright: Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)
- License: http://framework.zend.com/license/new-bsd New BSD License
Synopsis
class Zend_Feed_Atom
extends Zend_Feed_Abstract
{
- // members
- protected string $_entryClassName = 'Zend_Feed_Entry_Atom';
- protected string $_entryElementName = 'entry';
- protected string $_defaultNamespace = 'atom';
- // Inherited members from Zend_Feed_Abstract
- protected integer $_entryIndex;
- protected $_entries;
- // Inherited members from Zend_Feed_Element
- protected DOMElement $_element;
- protected Zend_Feed_Element $_parentElement;
- protected boolean $_appended;
- // methods
- public void __wakeup()
- public mixed link()
- public mixed __get()
- protected DOMElement _mapFeedHeaders()
- protected void _mapFeedEntries()
- public string saveXml()
- public void send()
- // Inherited methods from Zend_Feed_Abstract
- public void __construct()
- public void __wakeup()
- public array __sleep()
- protected void _buildEntryCache()
- public integer count()
- public void rewind()
- public mixed current()
- public mixed key()
- public mixed next()
- public boolean valid()
- protected abstract DOMElement _mapFeedHeaders()
- protected abstract DOMElement _mapFeedEntries()
- public abstract void send()
- // Inherited methods from Zend_Feed_Element
- public void __construct()
- public DOMDocument getDOM()
- public void setDOM()
- public void setParent()
- protected void ensureAppended()
- public string saveXml()
- public string saveXmlFragment()
- public mixed __get()
- public void __set()
- public boolean __isset()
- public mixed __call()
- public void __unset()
- public string __toString()
- protected array _children()
- public boolean offsetExists()
- public string offsetGet()
- public string offsetSet()
- public boolean offsetUnset()
Hierarchy
Extends
Members
protected
- $_appended — boolean
- $_defaultNamespace
—
string
The default namespace for Atom feeds. - $_element — DOMElement
- $_entries
—
array
Cache of feed entries. - $_entryClassName
—
string
The classname for individual feed elements. - $_entryElementName
—
string
The element name for individual feed elements (Atom <entry> elements). - $_entryIndex
—
integer
Current index on the collection of feed entries for the Iterator implementation. - $_parentElement — Zend_Feed_Element
Methods
protected
- _mapFeedEntries() — Generate the entries of the feed when working in write mode
- _mapFeedHeaders() — Generate the header of the feed when working in write mode
public
- __get() — Make accessing some individual elements of the feed easier.
- __wakeup() — Override Zend_Feed_Abstract to set up the $_element and $_entries aliases.
- link() — Easy access to <link> tags keyed by "rel" attributes.
- saveXml() — Override Zend_Feed_Element to allow formated feeds
- send() — Send feed to a http client with the correct header
Inherited from Zend_Feed_Abstract
protected
- _buildEntryCache() — Cache the individual feed elements so they don't need to be searched for on every operation.
- _mapFeedEntries() — Generate the entries of the feed when working in write mode
- _mapFeedHeaders() — Generate the header of the feed when working in write mode
public
- __sleep() — Prepare for serialiation
- __wakeup() — Load the feed as an XML DOMDocument object
- count() — Get the number of entries in this feed object.
- current() — Required by the Iterator interface.
- key() — Required by the Iterator interface.
- next() — Required by the Iterator interface.
- rewind() — Required by the Iterator interface.
- send() — Send feed to a http client with the correct header
- valid() — Required by the Iterator interface.
Inherited from Zend_Feed_Element
protected
- _children() — Finds children with tagnames matching $var
- ensureAppended() — Appends this element to its parent if necessary.
public
- __call() — Get the value of an element with method syntax.
- __get() — Map variable access onto the underlying entry representation.
- __isset() — Map isset calls onto the underlying entry representation.
- __set() — Map variable sets onto the underlying entry representation.
- __toString() — Returns the nodeValue of this element when this object is used in a string context.
- __unset() — Remove all children matching $var.
- getDOM() — Get a DOM representation of the element
- offsetExists() — Required by the ArrayAccess interface.
- offsetGet() — Required by the ArrayAccess interface.
- offsetSet() — Required by the ArrayAccess interface.
- offsetUnset() — Required by the ArrayAccess interface.
- saveXml() — Get an XML string representation of this element
- saveXmlFragment() — Get the XML for only this element
- setDOM() — Update the object from a DOM element
- setParent() — Set the parent element of this object to another Zend_Feed_Element.