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.
| category | Zend |
|---|---|
| package | Zend_Feed |
| copyright | Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) |
| license | New BSD License |
| inherited_from | \Zend_Feed_Abstract |
__call(string $var, mixed $unused) : mixed
Map method calls to get the string value of the requested element. If there are multiple elements that match, this will return an array of those objects.
stringThe element to get the string value of.
mixedThis parameter is not used.
mixedThe node's value, null, or an array of nodes.__construct(\DOMElement $element = null) : void
\DOMElementThe DOM element we're encapsulating.
__get(string $var) : mixed
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).
stringThe property to access.
mixed__get(string $var) : mixed
Get-style access returns a Zend_Feed_Element representing the child element accessed. To get string values, use method syntax with the __call() overriding.
stringThe property to access.
mixed__isset(string $var) : boolean
string
boolean__set(string $var, string $val) : void
stringThe property to change.
stringThe property's new value.
\Zend_Feed_Exception |
|---|
__sleep() : array
array__toString() : string
string__unset(string $var) : void
string
__wakeup() : void
| inherited_from | \Zend_Feed_Abstract::__wakeup() |
|---|
\Zend_Feed_Exception |
|---|
__wakeup() : void
\Zend_Feed_Exception |
|---|
count() : integer
integerEntry count.current() : mixed
mixedThe current row, or null if no rows.getDOM() : \DOMDocument
Returns the underlying DOM object, which can then be manipulated with full DOM methods.
\DOMDocumentgetEncoding() : string
stringkey() : mixed
mixedThe current row number (starts at 0), or NULL if no rowslink(string $rel = null) : mixed
If $elt->link() is called with no arguments, we will attempt to return the value of the 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 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 in the entry.
stringThe "rel" attribute to look for.
mixednext() : mixed
mixedThe next row, or null if no more rows.offsetExists(string $offset) : boolean
string
booleanoffsetGet(string $offset) : string
string
stringoffsetSet(string $offset, string $value) : string
string
string
stringoffsetUnset(string $offset) : boolean
string
booleanrewind() : void
saveXml() : string
stringsaveXml() : string
Returns a string of this element's XML, including the XML prologue.
stringsaveXmlFragment() : string
Returns a string of this element's XML without prologue.
stringsend() : void
| inherited_from | \Zend_Feed_Abstract::send() |
|---|
\Zend_Feed_Exception |
if headers have already been sent |
|---|
send() : void
\Zend_Feed_Exception |
if headers have already been sent |
|---|
setDOM(\DOMElement $element) : void
Take a DOMElement object, which may be originally from a call to getDOM() or may be custom created, and use it as the DOM tree for this Zend_Feed_Element.
\DOMElement
setEncoding(string $value) : \Zend_Feed_Element
stringEncoding to use
\Zend_Feed_ElementsetParent(\Zend_Feed_Element $element) : void
\Zend_Feed_Element
valid() : boolean
booleanWhether the iteration is valid_buildEntryCache() : void
_children(string $var) : array
Similar to SimpleXML's children() method.
stringTagname to match, can be either namespace:tagName or just tagName.
array_importFeedFromString(string $feed) : string
Protects against XXE attack vectors.
string
\Zend_Feed_Exception |
on detection of an XXE vector |
|---|
string_mapFeedEntries(\DOMElement $root, array $array) : void
The following nodes are constructed for each feed entry
| inherited_from | \Zend_Feed_Abstract::_mapFeedEntries() |
|---|
\DOMElementthe root node to use
arraythe data to use
_mapFeedEntries(\DOMElement $root, array $array) : \DOMElement
\DOMElementthe root node to use
arraythe data to use
\DOMElementroot node_mapFeedHeaders(array $array) : \DOMElement
| inherited_from | \Zend_Feed_Abstract::_mapFeedHeaders() |
|---|
arraythe data to use
\DOMElementroot node_mapFeedHeaders(array $array) : \DOMElement
arraythe data to use
\DOMElementroot nodeensureAppended() : void
$_appended : boolean
true$_defaultNamespace : string
'atom'$_element : \DOMElement
$_encoding : string
'UTF-8'$_entries : array
$_entryClassName : string
'Zend_Feed_Entry_Atom'$_entryElementName : string
'entry'$_entryIndex : integer
0$_parentElement : \Zend_Feed_Element