Class AlphaFeed

Base feed class for generating syndication feeds

Direct known subclasses

Atom, RSS, RSS2

Abstract
Package: alpha::util::feeds
Copyright: Copyright (c) 2012, 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.

License: The BSD License
Author: John Collins <dev@alphaframework.org>
Version: $Id: AlphaFeed.inc 1496 2012-02-12 20:32:21Z alphadev $
Since: 1.0
Located at util/feeds/AlphaFeed.inc

Methods summary
`public`	# `__construct( string $BOName, string $title, string $url, string $description, string $pubDate = null, integer $id = null, integer $limit = 10 )` The constructor The constructor Parameters `$BOName` `string` $BOName The classname of the BO to render a feed for. `$title` `string` $title The title of the feed. `$url` `string` $url The base URL for the feed. `$description` `string` $description The description of the feed. `$pubDate` `string` $pubDate The publish date, only used in Atom feeds. `$id` `integer` $id The feed id, only used in Atom feeds. `$limit` `integer` $limit The amount of items to render in the feed. Throws `IllegalArguementException` Since 1.0
`public`	# `loadBOs( integer $limit, string $sortBy )` Method to load all of the BO items to the feed from the database, from the newest to the $limit provided Method to load all of the BO items to the feed from the database, from the newest to the $limit provided Parameters `$limit` `integer` $limit The amount of items to render in the feed. `$sortBy` `string` $sortBy The name of the field to sort the feed by. Since 1.0
`public`	# `addBO( AlphaDAO $BO )` Method for adding a BO to the current feed Method for adding a BO to the current feed Parameters `$BO` `AlphaDAO` $BO
`public`	# `setFieldMappings( string $title, string $url, string $description = null, string $pubDate = null, integer $id = null )` Method for mapping BO fieldnames to feed field names Method for mapping BO fieldnames to feed field names Parameters `$title` `string` $title The title of the feed. `$url` `string` $url The base URL for the feed. `$description` `string` $description The description of the feed. `$pubDate` `string` $pubDate The publish date, only used in Atom feeds. `$id` `integer` $id The feed id, only used in Atom feeds. Since 1.0
`protected DOMElement`	# `createFeedElement( string $name, string $value = null )` Method for creating a new feed element Method for creating a new feed element Parameters `$name` `string` $name The name of the element. `$value` `string` $value The value of the element. Returns `DOMElement` Since 1.0
`protected`	# `createLink( DOMElement $parent, string $url )` Method for creating link elements (note that Atom has a different format) Method for creating link elements (note that Atom has a different format) Parameters `$parent` `DOMElement` $parent The parent element. `$url` `string` $url The URL for the link. Since 1.0
`protected`	# `createRSSNode( integer $type, DOMElement $parent, string $title, string $url, string $description, string $pubDate = null, integer $id = null )` Method for creating an RSS node with a title, url and description Method for creating an RSS node with a title, url and description Parameters `$type` `integer` $type Can be either (item\|feed) to indicate the type of node we are creating. `$parent` `DOMElement` $parent The parent element. `$title` `string` $title The title of the feed. `$url` `string` $url The base URL for the feed. `$description` `string` $description The description of the feed. `$pubDate` `string` $pubDate The publish date, only used in Atom feeds. `$id` `integer` $id The feed id, only used in Atom feeds. Throws `IllegalArguementException` Since 1.0
`protected`	# `addItem( string $title, string $url, string $description = null, string $pubDate = null, integer $id = null )` Method for adding an item to a feed Method for adding an item to a feed Parameters `$title` `string` $title The title of the feed. `$url` `string` $url The base URL for the feed. `$description` `string` $description The description of the feed. `$pubDate` `string` $pubDate The publish date, only used in Atom feeds. `$id` `integer` $id The feed id, only used in Atom feeds. Since 1.0
`public string`	# `render( )` Returns the formatted XML for the feed as a string Returns the formatted XML for the feed as a string Returns `string` Since 1.0

Properties summary
`protected DOMDocument`	`$rssDoc`		# The DOMDocument object used to create the feed The DOMDocument object used to create the feed Since 1.0
`protected DOMElement`	`$docElement`		# The DOMElement object used to hold the item or entry elements The DOMElement object used to hold the item or entry elements Since 1.0
`protected DOMElement`	`$root`		# Holds the DOMElement to which metadata is added for the feed Holds the DOMElement to which metadata is added for the feed Since 1.0
`protected string`	`$rootTag`		# The actual root tag used in each feed type The actual root tag used in each feed type Since 1.0
`protected array`	`$items`		# An array of feed items An array of feed items Since 1.0
`protected boolean`	`$hasChannel`	`true`	# If the feed format has a channel or not If the feed format has a channel or not Since 1.0
`protected array`	`$tagMap`	`array('item'=>'item','feeddesc'=>'description','itemdesc'=>'description')`	# Maps the tags to the feed-specific tags Maps the tags to the feed-specific tags Since 1.0
`private AlphaDAO`	`$BO`		# The BO which we will serve up in this feed The BO which we will serve up in this feed Since 1.0
`protected array`	`$fieldNameMappings`		# An array containing BO field names -> RSS field name mappings An array containing BO field names -> RSS field name mappings Since 1.0
`protected string`	`$nameSpace`		# The XML namespace to use in the generated feed The XML namespace to use in the generated feed
`private static Logger`	`$logger`	`null`	# Trace logger Trace logger Since 1.0

Packages

Classes

Class AlphaFeed

Direct known subclasses

Parameters

Throws

Since

Parameters

Since

Parameters

Parameters

Since

Parameters

Returns

Since

Parameters

Since

Parameters

Throws

Since

Parameters

Since

Returns

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since