chamilo-lms2/main/inc/lib/magpierss/cookbook

MAGPIERSS RECIPES:  Cooking with Corbies

         "Four and twenty blackbirds baked in a pie."

1. LIMIT THE NUMBER OF HEADLINES(AKA ITEMS) RETURNED.

PROBLEM:

You want to display the 10 (or 3) most recent headlines, but the RSS feed
contains 15.

SOLUTION:

$num_items = 10;
$rss = fetch_rss($url);

$items = array_slice($rss->items, 0, $num_items);

DISCUSSION:

Rather then trying to limit the number of items Magpie parses, a much simpler,
and more flexible approach is to take a "slice" of the array of items.  And
array_slice() is smart enough to do the right thing if the feed has less items
then $num_items.

See: http://www.php.net/array_slice


2. DISPLAY A CUSTOM ERROR MESSAGE IF SOMETHING GOES WRONG

PROBLEM:

You don't want Magpie's error messages showing up if something goes wrong.

SOLUTION:

# Magpie throws USER_WARNINGS only
# so you can cloak these, by only showing ERRORs
error_reporting(E_ERROR);

# check the return value of fetch_rss()

$rss = fetch_rss($url);

if ( $rss ) {
...display rss feed...
}
else {
	echo "An error occured!  " .
	     "Consider donating more $$$ for restoration of services." .
		 "<br>Error Message: "	. magpie_error();
}

DISCUSSION:

MagpieRSS triggers a warning in a number of circumstances.  The 2 most common
circumstances are:  if the specified RSS file isn't properly formed (usually
because it includes illegal HTML), or if Magpie can't download the remote RSS
file, and there is no cached version.  

If you don't want your users to see these warnings change your error_reporting
settings to only display ERRORs.  Another option is to turn off display_error,
so that WARNINGs, and NOTICEs still go to the error_log but not to the webpages.

You can do this with:

ini_set('display_errors', 0);

See: http://www.php.net/error_reporting,
     http://www.php.net/ini_set, 
	 http://www.php.net/manual/en/ref.errorfunc.php

3. GENERATE A NEW RSS FEED

PROBLEM:

Create an RSS feed for other people to use.

SOLUTION:

Use Useful Inc's RSSWriter (http://usefulinc.com/rss/rsswriter/)

DISCUSSION:

An example of turning a Magpie parsed RSS object back into an RSS file is forth
coming.  In the meantime RSSWriter has great documentation.

4. DISPLAY HEADLINES MORE RECENT THEN X DATE

PROBLEM:

You only want to display headlines that were published on, or after a certain
date.


SOLUTION:

require 'rss_utils.inc';

# get all headlines published today
$today = getdate();

# today, 12AM
$date = mktime(0,0,0,$today['mon'], $today['mday'], $today['year']);

$rss = fetch_rss($url);

foreach ( $rss->items as $item ) {
	$published = parse_w3cdtf($item['dc']['date']);
	if ( $published >= $date ) {
		echo "Title: " . $item['title'];
		echo "Published: " . date("h:i:s A", $published);
		echo "<p>";
	}
}

DISCUSSION:

This recipe only works for RSS 1.0 feeds that include the <dc:date> field.
(which is very good RSS style)

parse_w3cdtf is defined in rss_utils.inc, and parses RSS style dates into Unix
epoch seconds.  

See: http://www.php.net/manual/en/ref.datetime.php