File Source for rss.class.php

<?php
/**
* RSS generating class
*
* generates RSS 2.0 feed according to given data
*
* @author Matej Finwe Humpal <finwe@finwe.info>
* @license http://creativecommons.org/licenses/by-sa/2.5/ Creative Commons Attribution-ShareAlike 2.5
* @link http://weblog.finwe.info/item/php-trida-generujici-rss Tutorial Article at finwe.info (cs-CZ)
* @link http://blogs.law.harvard.edu/tech/rss RSS 2.0 Specification
* @package Rss
*/
/**
* Class Rss
*
* If making derivative works, you MUST attribute the author in one or more of following ways:<br>
* Leave rss generator tags and comments in the output<br>
* Place the link http://weblog.finwe.info/item/php-trida-generujici-rss to your product documentation<br>
* Place the link http://weblog.finwe.info/item/php-trida-generujici-rss to your product website
*
* @author Matej Finwe Humpal <finwe@finwe.info>
* @version Rss.class.php, v 1.3 2007/02/17 14:48:00
* @license http://creativecommons.org/licenses/by-sa/2.5/ Creative Commons Attribution-ShareAlike 2.5
* @package Rss
* @link http://weblog.finwe.info/item/php-trida-generujici-rss Tutorial Article at finwe.info (cs_CZ)
* @example rss.php Basic example
*/
class Rss
{
/**
* Data retrieval handler setting.
*
* Allows user to define his own data-retrieval function, even outside of the class.
*
* string 'getData' will call function gatData
* array('pgSql','getData') will staticaly call method getData of pgSql object (pgSql::getData()).
*
* there are two pre-prepared methods - getMysqlData() and getMysqliData().
* They both use db parameters specific for Rss class
*
* @var mixed Either string for external static function or array with two parametres (Class,Method) for calling the method staticaly
*/
private $dbCallback = array('Rss', 'getMysqlData');
/**
* DB host. defaults localhost
* @var string
*/
private $dbHost = 'localhost';
/**
* DB user.
* @var string
*/
private $dbUser = '';
/**
* DB password.
* @var string
*/
private $dbPass = '';
/**
* Name of the database to use.
* @var string
*/
private $dbName = '';
/**
* Database Port.
* @var string
*/
private $dbPort = '';
/**
* Title of the feed. Should be the same as the page title.
* @var string
*/
private $title = '';
/**
* Base url of the page.
* @var string
*/
private $link = '';
/**
* Feed description.
* @var string
*/
private $descripton = '';
/**
* Language of the feed.
* @var string
*/
private $language = '';
/**
* Oprional feed namespaces.
* @var array
*/
private $namespaces = array();
/**
* Custom channel subelements (pubDate, ttl, skipHours etc.)
* @var array
*/
private $channelSubelements = array();
/**
* URL of feed image.
* @var string
*/
private $image = '';
/**
* Array of database fields to use.
*
* Key is a name of RSS tag, value is name of database field, from which the data are to be taken.
* Value can be an array of db field names for usage with link, comments and guid tags. @see $postLink
*
* @see prepareData()
* @var array
*/
private $dbFields = array();
/**
* SQL query to run on given database.
* @var string
*/
private $dbSql = '';
/**
* String of item-link.
*
* Is prepared for sprintf or vsprintf. Instead of %s variables, data from database will be used.
* If multiple variables used, $dbFields must be set accordingly (array in array value)
*
* '/item/%s' string with one variable
* '/item/%s-%s' string with multiple variables
*
* @example rss.php Basic example
* @var string
* @see dbFields
*/
private $postLink = '';
/**
* String of item-comment-link.
*
* Is prepared for sprintf or vsprintf. Instead of %s variables, data from database will be used.
* If multiple variables used, $dbFields must be set accordingly (array in array value)
*
* '/item/%s' string with one variable
* '/item/%s-%s' string with multiple variables
*
* @example rss.php Basic example
* @var string
* @see dbFields
*/
private $commentsLink = '';
/**
* Feed encoding.
*
* @var string
*/
private $encoding = 'utf-8';
/**
* Method overloading - allows user to set Rss variables.
*/
public function __call($name,$args)
{
$forbidden = array('namespaces');
if (substr($name, 0, 3) == 'set' && $var = substr($name, 3)) {
$var = strtolower(substr($var,0,1)).substr($var,1);
if (isset($this->$var)) {
$this->$var = $args[0];
} else {
throw new Exception(sprintf('Non-existing method %s::%s() called in %s, line %s', __CLASS__, $name, __FILE__, __LINE__));
}
}
}
/**
* Sets page header
*
* @param string $context Page context-type.
*/
protected function setHeader($context = 'text/plain')
{
header('Content-type: ' . $context . '; charset=' . $this->encoding);
}
/**
* Adds user-defined namespace
*
* @param string $namespace Namespace itself
* @param string $link link to namespace definition
* @param string $link link to namespace definition
* @uses Rss::$namespaces
*/
public function addNamespace($namespace,$link)
{
$this->namespaces[] = $namespace.'="'.$link.'"';
}
/**
* Writes namespaces
*
* @return string Namespaces
* @uses Rss::$namespaces
*/
protected function writeNamespaces()
{
$namespaces = implode(' ',$this->namespaces);
return $namespaces;
}
/**
* Adds user-defined channel subelement
*
* @param string $element name of the tag
* @param mixed $data tag data
* @see writeChannelSubelements()
* @uses Rss::$channelSubelements
*/
public function addChannelSubelement($element,$data)
{
$this->channelSubelements[$element] = $data;
}
/**
* writes Channel Subelements XML
*
* @return string XML of channel subelements
* @uses Rss::$channelSubelements
*/
private function writeChannelSubelements() {
$out = '';
foreach ($this->channelSubelements as $key => $val) {
switch ($key) {
case 'copyright':
// fall through
case 'managingEditor':
// fall through
case 'webMaster':
// fall through
case 'category':
// fall through
case 'rating':
// fall through
case 'ttl':
$out .= '<' . $key . '>' . $val . '</' . $key . '>'."\n";
break;
case 'cloud':
$out .= '<' . $key . ' domain="' . $val["domain"] . '" port="' . $val["port"] . '" path="' . $val["path"] . '" registerProcedure="' . $val["registerProcedure"] . '" protocol="' . $val["protocol"] . '" />'."\n";
break;
case 'skipHours':
// fall through
case 'skipDays':
$out .= '<' . $key . '>'."\n";
foreach ($val as $skip) {
$out .= "\t".'<hour>' . $skip . '</hour>'."\n";
}
$out .= '</' . $key . '>'."\n";
break;
default:
break;
}
}
return $out;
}
/**
* Writes RSS prologue with Channel obligatory tags
*/
protected function rssHead()
{
$out = '';
$out .= '<?xml version="1.0" encoding="' . $this->encoding . '" ?>'."\n";
$out .= ''."\n";
$out .= '<rss version="2.0" ' . $this->writeNamespaces() . '>'."\n";
$out .= '<channel>'."\n";
$out .= '<title>' . $this->title . '</title>'."\n";
$out .= '<link>' . $this->link . '</link>'."\n";
$out .= '<description>' . $this->descripton . '</description>'."\n";
$out .= '<generator>Rss PHP class (http://weblog.finwe.info/item/php-trida-generujici-rss)</generator>'."\n";
$out .= (!empty($this->image)) ? '<image>' . $this->image . '</image>'."\n" : '';
$out .= '<pubDate>' . date('r') . '</pubDate>';
$out .= '<language>' . $this->language . '</language>'."\n";
$out .= $this->writeChannelSubelements();
print($out);
}
/**
* By RSS Spec, description text should be 450 chars max. Lets ensure it is.
*
* @author Monte Ohrt <monte at ohrt dot com>
* @return string Truncated string
*/
protected function splitLongText($string, $length = 450, $etc = '...', $break_words = false, $middle = false)
{
if ($length == 0)
return '';
if (strlen($string) > $length) {
$length -= strlen($etc);
if (!$break_words && !$middle) {
$string = preg_replace('/\s+?(\S+)?$/', '', substr($string, 0, $length+1));
}
if(!$middle) {
return substr($string, 0, $length).$etc;
} else {
return substr($string, 0, $length/2) . $etc . substr($string, -$length/2);
}
} else {
return $string;
}
}
/**
* Database data withdrawal, mysql driver
*
* @return array $return Data fetched from MySQL < 4.1 database
*/
protected function getMysqlData()
{
$return = array();
$db = mysql_connect($this->dbHost,$this->dbUser,$this->dbPass);
mysql_select_db($this->dbName,$db);
$query = mysql_query($this->dbSql) or die(mysql_error());
while($array = mysql_fetch_array($query,MYSQLI_ASSOC)){
$return[] = $array;
}
mysql_close($db);
return $return;
}
/**
* Database data withdrawal, mysqli driver
*
* @return array $returnData fetched from MySQL >= 4.1 database
*/
protected function getMysqliData()
{
$return = array();
$db = new mysqli($this->dbHost,$this->dbUser,$this->dbPass,$this->dbName);
$db->query("SET CHARACTER SET UTF8");
$query = $db->query($this->dbSql) or die($db->error);
while($array = $query->fetch_array(MYSQLI_ASSOC)){
$return[] = $array;
}
$db->close();
return $return;
}
/**
* Prepares array of data for further usage
*
* @return array $return Data prepared for insertion to XML
*/
protected function prepareData()
{
$return = array();
$i = 0;
if (!is_array($this->dbFields)) {
throw new Exception('dbFields parameter is suppossed to be an array');
}
$data = call_user_func($this->dbCallback);
foreach($data as $array){
foreach ($this->dbFields as $key => $val) {
switch ($key) {
case 'link':
if (!is_array($val)) {
$return[$i][$key] = sprintf($this->postLink,$array[$val]);
} else {
$return[$i][$key] = vsprintf($this->postLink,array_reverse(array_intersect_key($array, array_flip($val))));
}
break;
case 'description':
$return[$i][$key] = '<![CDATA[' . $this->splitLongText($array[$val]) . ']]>';
break;
case 'comments':
if (!is_array($val)) {
$return[$i][$key] = sprintf($this->commentsLink,$array[$val]);
} else {
$return[$i][$key] = vsprintf($this->commentsLink,array_reverse(array_intersect_key($array, array_flip($val))));
}
break;
case 'category':
// fall through
case 'enclosure':
$return[$i][$key] = $array[$val];
break;
case 'pubDate':
$return[$i][$key] = date('r',$array[$val]);
break;
case 'guid':
// fall through
case 'title':
// fall through
case 'author':
// fall through
case 'source':
// fall through
default:
if (!is_array($val)){
$return[$i][$key] = $array[$val];
} else {
if (!is_array($val[0])) {
$return[$i][$key] = sprintf($val[1],$array[$val[0]]);
} else {
$return[$i][$key] = vsprintf($val[1],$array[$val[0]]);
}
}
break;
}
}
$i++;
}
return $return;
}
/**
* Writes ITEM tags of RSS from values prepared by prepareData()
*
* @param array $data Data prepared from {@link prepareData()}
*
*/
protected function rssBody($data){
$out = '';
if (!is_array($data)) {
throw new Exception('Data has to be an array');
}
foreach ($data as $item) {
$out .= '<item>'."\n";
foreach ($item as $key => $val) {
$out .= (!empty($val)) ? "\t".'<' . $key . '>' . $val . '</' . $key . '>'."\n" : '';
}
$out .= '</item>'."\n";
}
print($out);
}
/**
* Writes RSS epilogue
*/
protected function rssFoot()
{
$out = '';
$out .= '</channel>'."\n";
$out .= '</rss>';
print($out);
}
/**
* Complete method for final usage.
*/
public function display()
{
$this->setHeader('text/xml');
$this->rssHead();
$this->rssBody($this->prepareData('getMysqliData'));
$this->rssFoot();
}
}
?>

Source for file rss.class.php