File Source for AlphaFeed.inc

<?php
require_once $config->get('sysRoot').'alpha/util/MarkdownFacade.inc';
/**
* Base feed class for generating syndication feeds
*
* @package alpha::util::feeds
* @since 1.0
* @author John Collins <dev@alphaframework.org>
* @version $Id: AlphaFeed.inc 1341 2011-03-17 15:02:02Z johnc $
* @license http://www.opensource.org/licenses/bsd-license.php The BSD License
* @copyright Copyright (c) 2011, John Collins (founder of Alpha Framework).
* All rights reserved.
*
* <pre>
* 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.
* </pre>
*
*/
abstract class AlphaFeed {
/**
* The DOMDocument object used to create the feed
*
* @var DOMDocument
* @since 1.0
*/
protected $rssDoc;
/**
* The DOMElement object used to hold the item or entry elements
*
* @var DOMElement
* @since 1.0
*/
protected $docElement;
/**
* Holds the DOMElement to which metadata is added for the feed
*
* @var DOMElement
* @since 1.0
*/
protected $root;
/**
* The actual root tag used in each feed type
*
* @var string
* @since 1.0
*/
protected $rootTag;
/**
* An array of feed items
*
* @var array
* @since 1.0
*/
protected $items;
/**
* If the feed format has a channel or not
*
* @var boolean
* @since 1.0
*/
protected $hasChannel = true;
/**
* Maps the tags to the feed-specific tags
*
* @var array
* @since 1.0
*/
protected $tagMap = array('item'=>'item','feeddesc'=>'description','itemdesc'=>'description');
/**
* The BO which we will serve up in this feed
*
* @var AlphaDAO
* @since 1.0
*/
private $BO;
/**
* An array containing BO field names -> RSS field name mappings
*
* @var array
* @since 1.0
*/
protected $fieldNameMappings;
/**
* The XML namespace to use in the generated feed
*
* @var string
*/
protected $nameSpace;
/**
* Trace logger
*
* @var Logger
* @since 1.0
*/
private static $logger = null;
/**
* The constructor
*
* @param string $BOName The classname of the BO to render a feed for.
* @param string $title The title of the feed.
* @param string $url The base URL for the feed.
* @param string $description The description of the feed.
* @param string $pubDate The publish date, only used in Atom feeds.
* @param integer $id The feed id, only used in Atom feeds.
* @param integer $limit The amount of items to render in the feed.
* @throws IllegalArguementException
* @since 1.0
*/
public function __construct($BOName, $title, $url, $description, $pubDate = null, $id = null, $limit = 10) {
self::$logger = new Logger('AlphaFeed');
self::$logger->debug('>>__construct(BOName=['.$BOName.'], title=['.$title.'], url=['.$url.'], description=['.$description.'], pubDate=['.$pubDate.'], id=['.$id.'], limit=['.$limit.'])');
$this->rssDoc = new DOMDocument();
$this->rssDoc->loadXML($this->rootTag);
$this->docElement = $this->rssDoc->documentElement;
try {
AlphaDAO::loadClassDef($BOName);
$this->BO = new $BOName;
}catch (IllegalArguementException $e) {
self::$logger->error('Unable to load the class definition for the class ['.$BOName.'] while trying to generate a feed!');
throw $e;
}
if ($this->hasChannel) {
$root = $this->createFeedElement('channel');
$this->root = $this->docElement->appendChild($root);
}else{
$this->root = $this->docElement;
}
$this->createRSSNode('feed', $this->root, $title, $url, $description, $pubDate, $id);
self::$logger->debug('<<__construct');
}
/**
* Method to load all of the BO items to the feed from the database, from the newest to the
* $limit provided
*
* @param integer $limit The amount of items to render in the feed.
* @param string $sortBy The name of the field to sort the feed by.
* @since 1.0
*/
public function loadBOs($limit, $sortBy) {
$BOs = $this->BO->loadAll(0, $limit, $sortBy, 'DESC');
AlphaDAO::disconnect();
foreach($BOs as $BO) {
$this->addBO($BO);
}
}
/**
* Method for adding a BO to the current feed
*
* @param AlphaDAO $BO
*/
public function addBO($BO) {
$title = $BO->get($this->fieldNameMappings['title']);
$url = $BO->get($this->fieldNameMappings['url']);
if(isset($this->fieldNameMappings['description'])) {
$description = $BO->get($this->fieldNameMappings['description']);
}else{
$description = '';
}
if(isset($this->fieldNameMappings['pubDate'])) {
$dateTS = strtotime($BO->get($this->fieldNameMappings['pubDate']));
$pubDate = date(DATE_ATOM, $dateTS);
}else{
$pubDate = '';
}
if(isset($this->fieldNameMappings['id']))
$id = $BO->get($this->fieldNameMappings['id']);
else
$id = '';
$this->addItem($title, $url, $description, $pubDate, $id);
}
/**
* Method for mapping BO fieldnames to feed field names
*
* @param string $title The title of the feed.
* @param string $url The base URL for the feed.
* @param string $description The description of the feed.
* @param string $pubDate The publish date, only used in Atom feeds.
* @param integer $id The feed id, only used in Atom feeds.
* @since 1.0
*/
public function setFieldMappings($title, $url, $description=null, $pubDate=null, $id=null) {
$this->fieldNameMappings = array(
'title' => $title,
'url' => $url
);
if(isset($description))
$this->fieldNameMappings['description'] = $description;
if(isset($pubDate))
$this->fieldNameMappings['pubDate'] = $pubDate;
if(isset($id))
$this->fieldNameMappings['id'] = $id;
}
/**
* Method for creating a new feed element
*
* @param string $name The name of the element.
* @param string $value The value of the element.
* @return DOMElement
* @since 1.0
*/
protected function createFeedElement($name, $value=null) {
$value = htmlspecialchars($value);
if($this->nameSpace == null) {
return $this->rssDoc->createElement($name, $value);
}else{
return $this->rssDoc->createElementNS($this->nameSpace, $name, $value);
}
}
/**
* Method for creating link elements (note that Atom has a different format)
*
* @param DOMElement $parent The parent element.
* @param string $url The URL for the link.
* @since 1.0
*/
protected function createLink($parent, $url) {
$link = $this->createFeedElement('link', $url);
$parent->appendChild($link);
}
/**
* Method for creating an RSS node with a title, url and description
*
* @param integer $type Can be either (item|feed) to indicate the type of node we are creating.
* @param DOMElement $parent The parent element.
* @param string $title The title of the feed.
* @param string $url The base URL for the feed.
* @param string $description The description of the feed.
* @param string $pubDate The publish date, only used in Atom feeds.
* @param integer $id The feed id, only used in Atom feeds.
* @since 1.0
* @throws IllegalArguementException
*/
protected function createRSSNode($type, $parent, $title, $url, $description, $pubDate=null, $id = null) {
$this->createLink($parent, $url);
$title = $this->createFeedElement('title', $title);
$parent->appendChild($title);
if ($type == 'item') {
$titletag = $this->tagMap['itemdesc'];
}else if ($type == 'feed') {
$titletag = $this->tagMap['feeddesc'];
}else{
throw new IllegalArguementException('The type paramater ['.$type.'] provided is invalid!');
}
$description = $this->createFeedElement($titletag, $description);
$parent->appendChild($description);
// id elements and updated elements are just for Atom!
if ($id != null) {
$idnode = $this->createFeedElement('id', $id);
$parent->appendChild($idnode);
}
if ($pubDate != null) {
$datenode = $this->createFeedElement('updated', $pubDate);
$parent->appendChild($datenode);
}
}
/**
* Method for adding an item to a feed
*
* @param string $title The title of the feed.
* @param string $url The base URL for the feed.
* @param string $description The description of the feed.
* @param string $pubDate The publish date, only used in Atom feeds.
* @param integer $id The feed id, only used in Atom feeds.
* @since 1.0
*/
protected function addItem($title, $url, $description=null, $pubDate=null, $id=null) {
$item = $this->createFeedElement($this->tagMap['item']);
if ($this->docElement->appendChild($item)) {
$this->createRSSNode('item', $item, $title, $url, $description, $pubDate, $id);
}
}
/**
* Returns the formatted XML for the feed as a string
*
* @return string
* @since 1.0
*/
public function render() {
if ($this->rssDoc) {
$this->rssDoc->formatOutput = true;
return $this->rssDoc->saveXML();
}else{
return '';
}
}
}
?>

	alpha--util--feeds

[ class tree: alpha--util--feeds ] [ index: alpha--util--feeds ] [ all elements ]

Source for file AlphaFeed.inc