API Documentation

Zend/Feed/Rss.php

Show: inherited
Table of Contents

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.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Feed  
Version
$Id: Rss.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Feed_Rss

Package: Zend\Feed

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.

Parent(s)
\Zend_Feed_Abstract < \Zend_Feed_Element
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedstring  $_defaultNamespace= ''rss''

The default namespace for RSS channels.

Default value'rss'Details
Type
string
Propertyprotectedstring  $_entryClassName= ''Zend_Feed_Entry_Rss''

The classname for individual channel elements.

Default value'Zend_Feed_Entry_Rss'Details
Type
string
Propertyprotectedstring  $_entryElementName= ''item''

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

Default value'item'Details
Type
string

Methods

methodpublic__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).

Parameters
Name Type Description
$var string

The property to access.

Returns
Type Description
mixed
methodpublic__wakeup( ) : void

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

Throws
Exception Description
\Zend_Feed_Exception
methodprivate_buildiTunes( \DOMElement $root, array $array ) : void

Adds the iTunes extensions to a root node

Parameters
Name Type Description
$root \DOMElement
$array array
methodprotected_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

Parameters
Name Type Description
$root \DOMElement

the root node to use

$array array

the data to use

methodprotected_mapFeedHeaders( array $array ) : \DOMElement

Generate the header of the feed when working in write mode

Parameters
Name Type Description
$array array

the data to use

Returns
Type Description
\DOMElement root node
methodpublicsaveXml( ) : string

Override Zend_Feed_Element to include root node

Returns
Type Description
string
methodpublicsend( ) : void

Send feed to a http client with the correct header

Throws
Exception Description
\Zend_Feed_Exception if headers have already been sent
Documentation was generated by DocBlox 0.15.1.