RSS API - Revision history

Mudrd8mz: Text replacement - "" to ""

2021-07-14T20:21:03Z

Text replacement - "</code>" to "</syntaxhighlight>"

← Older revision		Revision as of 20:21, 14 July 2021
Line 46:		Line 46:

	$rssdata = $header.$content.$footer; // This is the complete RSS FEED		$rssdata = $header.$content.$footer; // This is the complete RSS FEED
	</~~code~~>		</syntaxhighlight>

	===Caching an RSS feed===		===Caching an RSS feed===
Line 55:		Line 55:
	$filename = $CFG->cachedir .'/rss/entry/user/0/rss.xml';		$filename = $CFG->cachedir .'/rss/entry/user/0/rss.xml';
	rss_save_file('entry', $filename, $rssdata, true);		rss_save_file('entry', $filename, $rssdata, true);
	</~~code~~>		</syntaxhighlight>

	===Linking to a RSS feed===		===Linking to a RSS feed===
Line 68:		Line 68:
	$tooltiptext = get_string('rsssubscriberssposts','forum');		$tooltiptext = get_string('rsssubscriberssposts','forum');
	echo rss_get_link($context->id, $userid, 'mod_forum', $forum->id, $tooltiptext);		echo rss_get_link($context->id, $userid, 'mod_forum', $forum->id, $tooltiptext);
	</~~code~~>		</syntaxhighlight>

	==See also==		==See also==

Mudrd8mz: Text replacement - "`" to ""`


2021-07-14T13:02:48Z
Text replacement - "<code>" to "<syntaxhighlight lang="php">"

				
				
				
				
				
				← Older revision
				Revision as of 13:02, 14 July 2021
				
Line 26:
Line 26:
This example shows how you can create the content of an RSS Feed. This example shows how you can create the content of an RSS Feed.



<code> <syntaxhighlight lang="php">
  require_once("lib/rsslib.php");   require_once("lib/rsslib.php");
  //create some entries (these would normally be pulled from the database table of the module you are creating an rss feed for).   //create some entries (these would normally be pulled from the database table of the module you are creating an rss feed for).
Line 52:
Line 52:
Following on from the previous example:   Following on from the previous example:  



<code> <syntaxhighlight lang="php">
   $filename = $CFG->cachedir .'/rss/entry/user/0/rss.xml';    $filename = $CFG->cachedir .'/rss/entry/user/0/rss.xml';
   rss_save_file('entry', $filename, $rssdata, true);    rss_save_file('entry', $filename, $rssdata, true);
Line 61:
Line 61:
This example shows how you can output a link to an RSS feed. (Example taken from blocks/news_items/block_news_items.php) This example shows how you can output a link to an RSS feed. (Example taken from blocks/news_items/block_news_items.php)



<code> <syntaxhighlight lang="php">
  $cm = $modinfo->instances['forum'][$forum->id];   $cm = $modinfo->instances['forum'][$forum->id];
  $context = get_context_instance(CONTEXT_MODULE, $cm->id);   $context = get_context_instance(CONTEXT_MODULE, $cm->id);



Phalacee at 07:22, 27 January 2012
2012-01-27T07:22:09Z


				
				
				
				
				
				← Older revision
				Revision as of 07:22, 27 January 2012
				
Line 1:
Line 1:
==Overview== {{Moodle 2.3}}==Overview==



The RSS API is a core system in Moodle to allow you to create secure RSS feeds of data in your module.   The RSS API is a core system in Moodle to allow you to create secure RSS feeds of data in your module.  



Phalacee: /* Caching an RSS feed */
2012-01-27T05:14:26Z
Caching an RSS feed

				
				
				
				
				
				← Older revision
				Revision as of 05:14, 27 January 2012
				
Line 53:
Line 53:



<code> <code>
   $filename = "$CFG->cachedir/rss/entry/user/0/rss.xml";    $filename = $CFG->cachedir .'/rss/entry/user/0/rss.xml';
   rss_save_file('entry', $filename, $rssdata, true);    rss_save_file('entry', $filename, $rssdata, true);
</code> </code>



Phalacee: /* Caching an RSS feed */
2012-01-27T05:13:58Z
Caching an RSS feed

				
				
				
				
				
				← Older revision
				Revision as of 05:13, 27 January 2012
				
Line 53:
Line 53:



<code> <code>
   $filename = "$CFG->cachedir/rss/blog/user/0/$tagid.xml";    $filename = "$CFG->cachedir/rss/entry/user/0/rss.xml";
   rss_save_file('entry', $filename, $rssdata, true);    rss_save_file('entry', $filename, $rssdata, true);
</code> </code>



Phalacee: /* Caching an RSS feed */
2012-01-27T05:13:39Z
Caching an RSS feed

				
				
				
				
				
				← Older revision
				Revision as of 05:13, 27 January 2012
				
Line 54:
Line 54:
<code> <code>
   $filename = "$CFG->cachedir/rss/blog/user/0/$tagid.xml";    $filename = "$CFG->cachedir/rss/blog/user/0/$tagid.xml";
   rss_save_file('blog', $filename, $contents, true);    rss_save_file('entry', $filename, $rssdata, true);
</code> </code>






Phalacee: /* Creating an RSS feed */
2012-01-27T04:23:40Z
Creating an RSS feed

				
				
				
				
				
				← Older revision
				Revision as of 04:23, 27 January 2012
				
Line 39:
Line 39:
  }   }
  $content = rss_add_items($items);   // Convert the array of items into the XML Content   $content = rss_add_items($items);   // Convert the array of items into the XML Content
   
  $title = 'RSS Feed';   $title = 'RSS Feed';
  $description = 'General RSS Feed full of ENTRIES';   $description = 'General RSS Feed full of ENTRIES';



Phalacee: /* Creating an RSS feed */
2012-01-27T04:23:22Z
Creating an RSS feed

				
				
				
				
				
				← Older revision
				Revision as of 04:23, 27 January 2012
				
Line 24:
Line 24:
===Creating an RSS feed=== ===Creating an RSS feed===



This example shows how you can create the content of an RSS Feed. (Example taken from blog/rsslib.php) This example shows how you can create the content of an RSS Feed.



<code> <code>
  $tagid = 0;   require_once("lib/rsslib.php");
  // Get all the entries from the database   //create some entries (these would normally be pulled from the database table of the module you are creating an rss feed for).
 require_once($CFG->dirroot .'/blog/locallib.php');   for ($i=1; $i <= 10; $i++) {
  $blogheaders = blog_get_headers($courseid, $groupid, $userid, $tagid); 
 
 $bloglisting = new blog_listing($blogheaders['filters']); 
 $blogentries = $bloglisting->get_entries(); 
 
 foreach ($blogentries as $blog_entry) { 
      $item = NULL;       $item = NULL;
      $item->author = fullname($DB->get_record('user', array('id'=>$blog_entry->userid)));       $item->author = 'Joe Blogs';
      $item->title = $blog_entry->subject;       $item->title = 'RSS Entry Number '.$i;
      $item->pubdate = $blog_entry->lastmodified;       $item->pubdate = time();
      $item->link = $CFG->wwwroot.'/blog/index.php?entryid='.$blog_entry->id;       $item->link = $CFG->wwwroot.'/entry/index.php?entryid='.$i;
      $item->description = format_text($blog_entry->summary, $blog_entry->format);       $item->description = 'Summary of the RSS Entry';
     if ( !empty($CFG->usetags) && ($blogtags = tag_get_tags_array('post', $blog_entry->id)) ) { 
         if ($blogtags) { 
             $item->tags = $blogtags; 
         } 
         $item->tagscheme = $CFG->wwwroot . '/tag'; 
     } 
      $items[] = $item;       $items[] = $item;
  }   }
  $content = rss_add_items($items);   /// Change structure to XML   $content = rss_add_items($items);   // Convert the array of items into the XML Content
  $info .= ': '.$DB->get_field('tags', 'text', array('id'=>$tagid));  
   $title = 'RSS Feed';
  $header = rss_standard_header(get_string($type.'blog','blog', $info), $CFG->wwwroot.'/blog/index.php', get_string('intro','blog'));  $description = 'General RSS Feed full of ENTRIES';
  $header = rss_standard_header($title, $CFG->wwwroot.'/entry/index.php', $description);
  $footer = rss_standard_footer();   $footer = rss_standard_footer();
       



Phalacee: /* Creating an RSS feed */
2012-01-25T02:21:50Z
Creating an RSS feed

				
				
				
				
				
				← Older revision
				Revision as of 02:21, 25 January 2012
				
Line 37:
Line 37:
  foreach ($blogentries as $blog_entry) {   foreach ($blogentries as $blog_entry) {
      $item = NULL;       $item = NULL;
      $item->author = fullname($DB->get_record('user', array('id'=>$blog_entry->userid))); // TODO: this is slow       $item->author = fullname($DB->get_record('user', array('id'=>$blog_entry->userid)));
      $item->title = $blog_entry->subject;       $item->title = $blog_entry->subject;
      $item->pubdate = $blog_entry->lastmodified;       $item->pubdate = $blog_entry->lastmodified;



Phalacee: /* Examples */
2012-01-17T06:55:52Z
Examples

				
				
				
				
				
				← Older revision
				Revision as of 06:55, 17 January 2012
				
Line 66:
Line 66:
   $filename = "$CFG->cachedir/rss/blog/user/0/$tagid.xml";    $filename = "$CFG->cachedir/rss/blog/user/0/$tagid.xml";
   rss_save_file('blog', $filename, $contents, true);    rss_save_file('blog', $filename, $contents, true);
</code> 

===Retrieving a cached RSS feed=== 

<code> 
 ... 
</code> </code>

← Older revision		Revision as of 13:02, 14 July 2021
Line 26:		Line 26:
	This example shows how you can create the content of an RSS Feed.		This example shows how you can create the content of an RSS Feed.

	<~~code~~>		<syntaxhighlight lang="php">
	require_once("lib/rsslib.php");		require_once("lib/rsslib.php");
	//create some entries (these would normally be pulled from the database table of the module you are creating an rss feed for).		//create some entries (these would normally be pulled from the database table of the module you are creating an rss feed for).
Line 52:		Line 52:
	Following on from the previous example:		Following on from the previous example:

	<~~code~~>		<syntaxhighlight lang="php">
	$filename = $CFG->cachedir .'/rss/entry/user/0/rss.xml';		$filename = $CFG->cachedir .'/rss/entry/user/0/rss.xml';
	rss_save_file('entry', $filename, $rssdata, true);		rss_save_file('entry', $filename, $rssdata, true);
Line 61:		Line 61:
	This example shows how you can output a link to an RSS feed. (Example taken from blocks/news_items/block_news_items.php)		This example shows how you can output a link to an RSS feed. (Example taken from blocks/news_items/block_news_items.php)

	<~~code~~>		<syntaxhighlight lang="php">
	$cm = $modinfo->instances['forum'][$forum->id];		$cm = $modinfo->instances['forum'][$forum->id];
	$context = get_context_instance(CONTEXT_MODULE, $cm->id);		$context = get_context_instance(CONTEXT_MODULE, $cm->id);

← Older revision		Revision as of 07:22, 27 January 2012
Line 1:		Line 1:
	==Overview==		{{Moodle 2.3}}==Overview==

	The RSS API is a core system in Moodle to allow you to create secure RSS feeds of data in your module.		The RSS API is a core system in Moodle to allow you to create secure RSS feeds of data in your module.

← Older revision		Revision as of 05:14, 27 January 2012
Line 53:		Line 53:

	<code>		<code>
	$filename = "$CFG->cachedir/rss/entry/user/0/rss.xml";		$filename = $CFG->cachedir .'/rss/entry/user/0/rss.xml';
	rss_save_file('entry', $filename, $rssdata, true);		rss_save_file('entry', $filename, $rssdata, true);
	</code>		</code>

← Older revision		Revision as of 05:13, 27 January 2012
Line 53:		Line 53:

	<code>		<code>
	$filename = "$CFG->cachedir/rss/~~blog~~/user/0/~~$tagid~~.xml";		$filename = "$CFG->cachedir/rss/entry/user/0/rss.xml";
	rss_save_file('entry', $filename, $rssdata, true);		rss_save_file('entry', $filename, $rssdata, true);
	</code>		</code>

← Older revision		Revision as of 05:13, 27 January 2012
Line 54:		Line 54:
	<code>		<code>
	$filename = "$CFG->cachedir/rss/blog/user/0/$tagid.xml";		$filename = "$CFG->cachedir/rss/blog/user/0/$tagid.xml";
	rss_save_file('~~blog~~', $filename, $~~contents~~, true);		rss_save_file('entry', $filename, $rssdata, true);
	</code>		</code>

← Older revision		Revision as of 04:23, 27 January 2012
Line 39:		Line 39:
	}		}
	$content = rss_add_items($items); // Convert the array of items into the XML Content		$content = rss_add_items($items); // Convert the array of items into the XML Content

	$title = 'RSS Feed';		$title = 'RSS Feed';
	$description = 'General RSS Feed full of ENTRIES';		$description = 'General RSS Feed full of ENTRIES';

← Older revision		Revision as of 04:23, 27 January 2012
Line 24:		Line 24:
	===Creating an RSS feed===		===Creating an RSS feed===

	This example shows how you can create the content of an RSS Feed. ~~(Example taken from blog/rsslib.php)~~		This example shows how you can create the content of an RSS Feed.

	<code>		<code>
	~~$tagid = 0~~;		require_once("lib/rsslib.php");
	// ~~Get all the~~ entries from the database		//create some entries (these would normally be pulled from the database table of the module you are creating an rss feed for).
	~~require_once($CFG->dirroot .'/blog/locallib~~.~~php');~~		for ($i=1; $i <= 10; $i++) {
	~~$blogheaders = blog_get_headers~~($~~courseid, $groupid, $userid, $tagid);~~

	~~$bloglisting~~ = ~~new blog_listing($blogheaders['filters'])~~;
	$~~blogentries~~ = ~~$bloglisting->get_entries()~~;

	~~foreach ($blogentries as~~ $~~blog_entry~~) {
	$item = NULL;		$item = NULL;
	$item->author = ~~fullname($DB->get_record(~~'~~user~~'~~, array('id'=>$blog_entry->userid)))~~;		$item->author = 'Joe Blogs';
	$item->title = $~~blog_entry->subject~~;		$item->title = 'RSS Entry Number '.$i;
	$item->pubdate = ~~$blog_entry->lastmodified~~;		$item->pubdate = time();
	$item->link = $CFG->wwwroot.'/~~blog~~/index.php?entryid='.$~~blog_entry->id~~;		$item->link = $CFG->wwwroot.'/entry/index.php?entryid='.$i;
	$item->description = ~~format_text($blog_entry->summary, $blog_entry->format);~~		$item->description = 'Summary of the RSS Entry';
	~~if ( !empty($CFG->usetags) && ($blogtags = tag_get_tags_array(~~'~~post~~'~~, $blog_entry->id)) ) {~~
	~~if ($blogtags) {~~
	~~$item->tags = $blogtags~~;
	}
	~~$item->tagscheme = $CFG->wwwroot . '/tag';~~
	}
	$items[] = $item;		$items[] = $item;
	}		}
	$content = rss_add_items($items); //~~/ Change structure to~~ XML		$content = rss_add_items($items); // Convert the array of items into the XML Content
	$~~info .~~= ': '.$~~DB->get_field('tags', 'text~~'~~, array(~~'~~id'=>$tagid))~~;
			$title = 'RSS Feed';
	$header = rss_standard_header(~~get_string($type.'blog','blog',~~ $~~info)~~, $CFG->wwwroot.'/~~blog~~/index.php', ~~get_string('intro','blog')~~);		$description = 'General RSS Feed full of ENTRIES';
			$header = rss_standard_header($title, $CFG->wwwroot.'/entry/index.php', $description);
	$footer = rss_standard_footer();		$footer = rss_standard_footer();

← Older revision		Revision as of 02:21, 25 January 2012
Line 37:		Line 37:
	foreach ($blogentries as $blog_entry) {		foreach ($blogentries as $blog_entry) {
	$item = NULL;		$item = NULL;
	$item->author = fullname($DB->get_record('user', array('id'=>$blog_entry->userid))); ~~// TODO: this is slow~~		$item->author = fullname($DB->get_record('user', array('id'=>$blog_entry->userid)));
	$item->title = $blog_entry->subject;		$item->title = $blog_entry->subject;
	$item->pubdate = $blog_entry->lastmodified;		$item->pubdate = $blog_entry->lastmodified;

← Older revision		Revision as of 06:55, 17 January 2012
Line 66:		Line 66:
	$filename = "$CFG->cachedir/rss/blog/user/0/$tagid.xml";		$filename = "$CFG->cachedir/rss/blog/user/0/$tagid.xml";
	rss_save_file('blog', $filename, $contents, true);		rss_save_file('blog', $filename, $contents, true);
	~~</code>~~

	~~===Retrieving a cached RSS feed===~~

	~~<code>~~
	~~...~~
	</code>		</code>