Feed/Atom.php
Show:
inherited
inherited
Classes
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 [email protected] so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Feed
- Version
- $Id$
\Zend_Feed_Atom
Package: Zend_Feed
Returns
Returns
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.
- Parent(s)
- \Zend_Feed_Abstract < \Zend_Feed_Element
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
string $_defaultNamespace = 'atom'The default namespace for Atom feeds.
Default value
'atom'Details- Type
- string
string $_entryClassName = 'Zend_Feed_Entry_Atom'The classname for individual feed elements.
Default value
'Zend_Feed_Entry_Atom'Details- Type
- string
string $_entryElementName = 'entry'The element name for individual feed elements (Atom
elements).
Default value
'entry'Details- Type
- string
Methods
__get(string $var) : mixedMake 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).
Parameters| Name | Type | Description |
|---|---|---|
| $var | string | The property to access. |
| Type | Description |
|---|---|
| mixed |
__wakeup() : voidOverride Zend_Feed_Abstract to set up the $_element and $_entries aliases.
Throws
| Exception | Description |
|---|---|
| \Zend_Feed_Exception |
_mapFeedEntries(\DOMElement $root, array $array) : voidGenerate the entries of the feed when working in write mode
The following nodes are constructed for each feed entry
url to feed entry
entry title
last update
short text
long version, can contain html
Parameters| Name | Type | Description |
|---|---|---|
| $root | \DOMElement | the root node to use |
| $array | array | the data to use |
_mapFeedHeaders(array $array) : \DOMElementGenerate the header of the feed when working in write mode
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $array | array | the data to use |
| Type | Description |
|---|---|
| \DOMElement | root node |
link(string $rel = null) : mixedEasy access to tags keyed by "rel" attributes.
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.
Parameters| Name | Type | Description |
|---|---|---|
| $rel | string | The "rel" attribute to look for. |
| Type | Description |
|---|---|
| mixed |
saveXml() : stringOverride Zend_Feed_Element to allow formated feeds
Returns
| Type | Description |
|---|---|
| string |
send() : voidSend feed to a http client with the correct header
Throws
| Exception | Description |
|---|---|
| \Zend_Feed_Exception | if headers have already been sent |