Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
The Zend_Feed_Abstract class is an abstract class representing feeds.
Zend_Feed_Abstract implements two core PHP 5 interfaces: ArrayAccess and Iterator. In both cases the collection being treated as an array is considered to be the entry collection, such that iterating over the feed takes you through each of the feed.s entries.

__call(
string $var, mixed $unused
)
:
mixed
Get the value of an element with method syntax.
Inherited from: \Zend_Feed_Element::__call()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.
Name | Type | Description |
---|---|---|
$var | string | The element to get the string value of. |
$unused | mixed | This parameter is not used. |
Type | Description |
---|---|
mixed | The node's value, null, or an array of nodes. |

__construct(
string $uri
=
null, string $string
=
null, \Zend_Feed_Builder_Interface $builder
=
null
)
:
void
Feed constructor
The Zend_Feed_Abstract constructor takes the URI of a feed or a feed represented as a string and loads it as XML.
Name | Type | Description |
---|---|---|
$uri | string | The full URI of the feed to load, or NULL if not retrieved via HTTP or as an array. |
$string | string | The feed as a string, or NULL if retrieved via HTTP or as an array. |
$builder | \Zend_Feed_Builder_Interface | The feed as a builder instance or NULL if retrieved as a string or via HTTP. |
Exception | Description |
---|---|
\Zend_Feed_Exception | If loading the feed failed. |

__get(
string $var
)
:
mixed
Map variable access onto the underlying entry representation.
Inherited from: \Zend_Feed_Element::__get()Get-style access returns a Zend_Feed_Element representing the child element accessed. To get string values, use method syntax with the __call() overriding.
Name | Type | Description |
---|---|---|
$var | string | The property to access. |
Type | Description |
---|---|
mixed |

__isset(
string $var
)
:
boolean
Map isset calls onto the underlying entry representation.
Inherited from: \Zend_Feed_Element::__isset()Name | Type | Description |
---|---|---|
$var | string |
Type | Description |
---|---|
boolean |

__set(
string $var, string $val
)
:
void
Map variable sets onto the underlying entry representation.
Inherited from: \Zend_Feed_Element::__set()Name | Type | Description |
---|---|---|
$var | string | The property to change. |
$val | string | The property's new value. |
Exception | Description |
---|---|
\Zend_Feed_Exception |

__toString(
)
:
string
Returns the nodeValue of this element when this object is used in a string context.
Inherited from: \Zend_Feed_Element::__toString()Type | Description |
---|---|
string |

__unset(
string $var
)
:
void
Remove all children matching $var.
Inherited from: \Zend_Feed_Element::__unset()Name | Type | Description |
---|---|---|
$var | string |

__wakeup(
)
:
void
Load the feed as an XML DOMDocument object
Exception | Description |
---|---|
\Zend_Feed_Exception |

_buildEntryCache(
)
:
void
Cache the individual feed elements so they don't need to be searched for on every operation.

_children(
string $var
)
:
array
Finds children with tagnames matching $var
Inherited from: \Zend_Feed_Element::_children()Similar to SimpleXML's children() method.
Name | Type | Description |
---|---|---|
$var | string | Tagname to match, can be either namespace:tagName or just tagName. |
Type | Description |
---|---|
array |

_mapFeedEntries(
\DOMElement $root, array $array
)
:
\DOMElement
Generate the entries of the feed when working in write mode
Name | Type | Description |
---|---|---|
$root | \DOMElement | the root node to use |
$array | array | the data to use |
Type | Description |
---|---|
\DOMElement | root node |

_mapFeedHeaders(
array $array
)
:
\DOMElement
Generate the header of the feed when working in write mode
Name | Type | Description |
---|---|---|
$array | array | the data to use |
Type | Description |
---|---|
\DOMElement | root node |

count(
)
:
integer
Get the number of entries in this feed object.
Type | Description |
---|---|
integer | Entry count. |

current(
)
:
mixed
Required by the Iterator interface.
Type | Description |
---|---|
mixed | The current row, or null if no rows. |

ensureAppended(
)
:
void
Appends this element to its parent if necessary.
Inherited from: \Zend_Feed_Element::ensureAppended()
getDOM(
)
:
\DOMDocument
Get a DOM representation of the element
Inherited from: \Zend_Feed_Element::getDOM()Returns the underlying DOM object, which can then be manipulated with full DOM methods.
Type | Description |
---|---|
\DOMDocument |

getEncoding(
)
:
string
Get encoding
Inherited from: \Zend_Feed_Element::getEncoding()Type | Description |
---|---|
string |

key(
)
:
mixed
Required by the Iterator interface.
Type | Description |
---|---|
mixed | The current row number (starts at 0), or NULL if no rows |

next(
)
:
mixed
Required by the Iterator interface.
Type | Description |
---|---|
mixed | The next row, or null if no more rows. |

offsetExists(
string $offset
)
:
boolean
Required by the ArrayAccess interface.
Inherited from: \Zend_Feed_Element::offsetExists()Name | Type | Description |
---|---|---|
$offset | string |
Type | Description |
---|---|
boolean |

offsetGet(
string $offset
)
:
string
Required by the ArrayAccess interface.
Inherited from: \Zend_Feed_Element::offsetGet()Name | Type | Description |
---|---|---|
$offset | string |
Type | Description |
---|---|
string |

offsetSet(
string $offset, string $value
)
:
string
Required by the ArrayAccess interface.
Inherited from: \Zend_Feed_Element::offsetSet()Name | Type | Description |
---|---|---|
$offset | string | |
$value | string |
Type | Description |
---|---|
string |

offsetUnset(
string $offset
)
:
boolean
Required by the ArrayAccess interface.
Inherited from: \Zend_Feed_Element::offsetUnset()Name | Type | Description |
---|---|---|
$offset | string |
Type | Description |
---|---|
boolean |

saveXml(
)
:
string
Get an XML string representation of this element
Inherited from: \Zend_Feed_Element::saveXml()Returns a string of this element's XML, including the XML prologue.
Type | Description |
---|---|
string |

saveXmlFragment(
)
:
string
Get the XML for only this element
Inherited from: \Zend_Feed_Element::saveXmlFragment()Returns a string of this element's XML without prologue.
Type | Description |
---|---|
string |

send(
)
:
void
Send feed to a http client with the correct header
Exception | Description |
---|---|
\Zend_Feed_Exception | if headers have already been sent |

setDOM(
\DOMElement $element
)
:
void
Update the object from a DOM element
Inherited from: \Zend_Feed_Element::setDOM()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.
Name | Type | Description |
---|---|---|
$element | \DOMElement |

setEncoding(
string $value
)
:
\Zend_Feed_Element
Set encoding
Inherited from: \Zend_Feed_Element::setEncoding()Name | Type | Description |
---|---|---|
$value | string | Encoding to use |
Type | Description |
---|---|
\Zend_Feed_Element |

setParent(
\Zend_Feed_Element $element
)
:
void
Set the parent element of this object to another Zend_Feed_Element.
Inherited from: \Zend_Feed_Element::setParent()Name | Type | Description |
---|---|---|
$element | \Zend_Feed_Element |