API Documentation

Feed/Rss.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Feed
version
$Id: Rss.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Feed_Rss

Description

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.

Zend_Feed_Rss
jump to top

Extends from
Zend_Feed_Abstract
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Feed
Properties
$_entryClassName
$_entryElementName
$_defaultNamespace
Methods
__wakeup
__get
_mapFeedHeaders
_buildiTunes
_mapFeedEntries
saveXml
send

Description

RSS channel class

The Zend_Feed_Rss class is a concrete subclass of Zend_Feed_Abstract meant for representing RSS channels. It does not add any methods to its parent, just provides a classname to check against with the instanceof operator, and expects to be handling RSS-formatted data instead of Atom.

Properties

$_defaultNamespace
jump to class

string $_defaultNamespace = 'rss'

The default namespace for RSS channels.

Details

$_defaultNamespace
string
visibility
protected
default
rss
final
false
static
false

$_entryClassName
jump to class

string $_entryClassName = 'Zend_Feed_Entry_Rss'

The classname for individual channel elements.

Details

$_entryClassName
string
visibility
protected
default
Zend_Feed_Entry_Rss
final
false
static
false

$_entryElementName
jump to class

string $_entryElementName = 'item'

The element name for individual channel elements (RSS <item>s).

Details

$_entryElementName
string
visibility
protected
default
item
final
false
static
false

Methods

__get
jump to class

__get( string $var ) : mixed

Make accessing some individual elements of the channel easier.

Special accessors 'item' and 'items' are provided so that if you wish to iterate over an RSS channel's items, you can do so using foreach ($channel->items as $item) or foreach ($channel->item as $item).

Arguments
$var
string
The property to access.
Output
mixed
Details
visibility
public
final
false
static
false

__wakeup
jump to class

__wakeup( ) : void

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

Details
visibility
public
final
false
static
false
throws

_buildiTunes
jump to class

_buildiTunes( DOMElement $root, array $array ) : void

Adds the iTunes extensions to a root node

Arguments
$root
DOMElement
$array
array
Details
visibility
private
final
false
static
false

_mapFeedEntries
jump to class

_mapFeedEntries( DOMElement $root, array $array ) : void

Generate the entries of the feed when working in write mode

The following nodes are constructed for each feed entry entry title url to feed entry url to feed entry short text long version, can contain html

Arguments
$root
DOMElement
the root node to use
$array
array
the data to use
Details
visibility
protected
final
false
static
false

_mapFeedHeaders
jump to class

_mapFeedHeaders( array $array ) : DOMElement

Generate the header of the feed when working in write mode

Arguments
$array
array
the data to use
Output
DOMElement
root node
Details
visibility
protected
final
false
static
false

saveXml
jump to class

saveXml( ) : string

Override Zend_Feed_Element to include <rss> root node

Output
string
Details
visibility
public
final
false
static
false

send
jump to class

send( ) : void

Send feed to a http client with the correct header

Details
visibility
public
final
false
static
false
throws
if headers have already been sent
Documentation was generated by DocBlox.