| alpha--util--feeds

# Class: RSS2 Source Location: /util/feeds/RSS2.inc ## Class RSS2 Class Overview
RSS 2.0 class for syndication Located in /util/feeds/RSS2.inc [line 50]
    AlphaFeed
       |
       --RSS2
Author(s): John Collins <dev@alphaframework.org> Information Tags:
Version: | $Id: RSS2.inc 1454 2011-12-04 15:14:05Z johnc $
Copyright: | Copyright (c) 2011, John Collins (founder of Alpha Framework). All rights reserved.
     Redistribution and use in source and binary forms, with or
     without modification, are permitted provided that the
     following conditions are met:

     * Redistributions of source code must retain the above
       copyright notice, this list of conditions and the
       following disclaimer.
     * Redistributions in binary form must reproduce the above
       copyright notice, this list of conditions and the
       following disclaimer in the documentation and/or other
       materials provided with the distribution.
     * Neither the name of the Alpha Framework nor the names
       of its contributors may be used to endorse or promote
       products derived from this software without specific
       prior written permission.

     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
     CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
     INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
     MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
     CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
     NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
     OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
     SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Since: | 1.0
License: | The BSD License
| Properties $rootTag | Methods __construct
[ Top ] Inherited Properties, Constants, and Methods
Inherited Properties | Inherited Methods | Inherited Constants
--- | --- | ---
Inherited From AlphaFeed AlphaFeed::$docElement AlphaFeed::$fieldNameMappings AlphaFeed::$hasChannel AlphaFeed::$items AlphaFeed::$nameSpace AlphaFeed::$root AlphaFeed::$rssDoc AlphaFeed::$tagMap | Inherited From AlphaFeed AlphaFeed::__construct() The constructor AlphaFeed::addBO() Method for adding a BO to the current feed AlphaFeed::addItem() Method for adding an item to a feed AlphaFeed::createFeedElement() Method for creating a new feed element AlphaFeed::createLink() Method for creating link elements (note that Atom has a different format) AlphaFeed::createRSSNode() Method for creating an RSS node with a title, url and description AlphaFeed::loadBOs() Method to load all of the BO items to the feed from the database, from the newest to the $limit provided AlphaFeed::render() Returns the formatted XML for the feed as a string AlphaFeed::setFieldMappings() Method for mapping BO fieldnames to feed field names |
[ Top ] Property Summary
string | $rootTag | The actual root tag used in each feed type
[ Top ] Method Summary
RSS2 | __construct() | The constructor
[ Top ] Properties string $rootTag = '<rss version="2.0" />' [line 58] The actual root tag used in each feed type API Tags:
Access: | protected
Information Tags:
Since: | 1.0
Redefinition of: AlphaFeed::$rootTag The actual root tag used in each feed type [ Top ] Methods Constructor __construct [line 73]
`RSS2 __construct( string $BOName, string $title, string $url, string $description, [string $pubDate = null], [integer $id = null], [integer $limit = 10] )`
The constructor Parameters:
string | $BOName: | The classname of the BO to render a feed for.
string | $title: | The title of the feed.
string | $url: | The base URL for the feed.
string | $description: | The description of the feed.
string | $pubDate: | The publish date, only used in Atom feeds.
integer | $id: | The feed id, only used in Atom feeds.
integer | $limit: | The amount of items to render in the feed.
API Tags:
Access: | public
Information Tags:
Throws: | IllegalArguementException
Since: | 1.0
Redefinition of: AlphaFeed::__construct() The constructor [ Top ] Documentation generated on Tue, 13 Dec 2011 20:27:27 +0000 by phpDocumentor 1.4.3