RSS API - Revision history

Dirk: Cosmetics

2009-05-24T18:15:15Z

Cosmetics

Dirk: Fixed formatting and added category

2009-05-06T08:23:08Z

Fixed formatting and added category

Tomw: Reverted edit of 123, changed back to last version by Tomw

2005-08-20T17:44:20Z

Reverted edit of 123, changed back to last version by Tomw

123 at 13:51, 20 August 2005

2005-08-20T13:51:51Z

Tomw at 14:05, 2 July 2004

2004-07-02T14:05:17Z

Tomw at 14:04, 2 July 2004

2004-07-02T14:04:28Z

Tomw at 14:04, 2 July 2004

2004-07-02T14:04:10Z

Tomw at 14:03, 2 July 2004

2004-07-02T14:03:37Z

Tomw at 14:01, 2 July 2004

2004-07-02T14:01:59Z

Tomw at 14:00, 2 July 2004

2004-07-02T14:00:57Z

New page

For a plugin to use the builtin RSS content syndication it needs to implement three functions in functions.inc.

plugin_getfeednames_pluginname()
plugin_getfeedcontent_pluginname()
plugin_feedupdatecheck_pluginname()

where pluginname is the name of the plugin.

The first function plugin_getfeednames_pluginname()
receives no parameters and returns a multidimensional associative array of id/name pairs where 'id' is an integer representing the plugins internal id and 'name' is what the user will see. Thus the plugin will have code like this:

function plugin_getfeednames_pluginname() {
$feed = array(
array(
'id' => 1,
'name' => 'Name of Feed'
),
array(
'id' => 2,
'name' => 'Name of another feed'
)
);
return $feed;
}

The second function plugin_getfeedcontent_pluginname()
receives three parameters: $feed, $link, $update_data.
The plugin is expected to return a multidimensional associative array holding the content of the feed and to fill in 'link' (some link that represents the same content on the site as that in the feed) and 'update_data' (to be stored for later up-to-date checks. The function will have some code like this:

function plugin_getfeedcontent_pluginname() {
global $_CONF;

$link = $_CONF['site_url'] . '/pluginname/index.php';
$update_data = time();
$content=array();
foreach($ARRAY OF DATA as $s) {
$item = array(
'title' => $s,
'link' => $_CONF['site_url'] . '/pluginname/index.php'
'text' => $StoryText
'uid' => $UserID
'date' => $StoryDate
'format'=> $format #Either 'text' or 'html'
);
$content[]=$item;
}
return $content;
}

The final function plugin_feedupdatecheck_pluginname()
receives $feed, $topic, $update_data, $limit where
$feed == feed number
$topic == plugin id for feed
$update_data == is data stored by the previous function
$limit == number of items to include (configurable in editor)

The function returns true if the feed is up to date and false otherwise.

Feed files will always be stored in the directory specified by $_CONF['rdf_file'].

[[User:Tomw|TomW]]

@@ Line 1: / Line 1: @@
 (Added in Geeklog 1.3.9)
-For a plugin to use the built-in RSS content syndication it needs to implement three functions in functions.inc.
+For a plugin to use the built-in RSS content syndication it needs to implement three functions in <tt>functions.inc</tt>.
 '''plugin_getfeednames_pluginname()'''<br/>
@@ Line 15: / Line 15: @@
 <pre>
-function plugin_getfeednames_pluginname() {
+function plugin_getfeednames_pluginname()
      $feed = array(
          array(
@@ Line 34: / Line 35: @@
 == plugin_getfeedcontent_pluginname ==
-The second function '''plugin_getfeedcontent_pluginname()'''receives three parameters: $feed, $link, $update_data. The plugin is expected to return a multidimensional associative array holding the content of the feed and to fill in 'link' (some link that represents the same content on the site as that in the feed) and 'update_data' (to be stored for later up-to-date checks. The function will have some code like this (note that this is pseudo-code, not real PHP code):
+The second function '''plugin_getfeedcontent_pluginname()''' receives three parameters: $feed, $link, $update_data. The plugin is expected to return a multidimensional associative array holding the content of the feed and to fill in 'link' (some link that represents the same content on the site as that in the feed) and 'update_data' (to be stored for later up-to-date checks. The function will have some code like this (note that this is pseudo-code, not real PHP code):
 <pre>
@@ Line 63: / Line 64: @@
 == plugin_feedupdatecheck_pluginname ==
-The final function '''plugin_feedupdatecheck_pluginname()'''
+The final function '''plugin_feedupdatecheck_pluginname()''' receives $feed, $topic, $update_data, $limit where
-receives $feed, $topic, $update_data, $limit where <br/>
+* $feed == feed number
-$feed == feed number <br/>
+* $topic == plugin id for feed
-$topic == plugin id for feed <br/>
+* $update_data == is data stored by the previous function
-$update_data == is data stored by the previous function<br/>
+* $limit == number of items to include (configurable in editor)
 The function returns true if the feed is up to date and false otherwise.

← Older revision		Revision as of 17:44, 20 August 2005
Line 70:		Line 70:

	[[User:Tomw\|TomW]]		[[User:Tomw\|TomW]]
−
−
−
−
−
−
−
−
−
−
−
−
−
−
−
−	~~<div style="overflow:auto; height: 1px; ">~~
−	~~[http://21jewelry.com Fine Jewelry]~~
−	~~[http://mrjeweller.us Gold Jewelry]~~
−	~~[http://detox-kit.com Drug detox]~~
−	~~[http://adipex.shengen.ru adipex]~~
−	~~[http://diazepam.shengen.ru diazepam]~~
−	~~[http://protonix.shengen.ru protonix]~~
−	~~[http://hydrocodone.shengen.ru hydrocodone]~~
−	~~[http://detox-kit.com/categories/marijuana-detox/ Marijuana detox]~~
−	~~[http://detox-kit.com/categories/detox-drinks/ Detox Drinks]~~
−	~~[http://detox-kit.com/categories/saliva-detox/ saliva drug detox]~~
−	~~[http://detox-kit.com/categories/saliva-detox/ saliva detox]~~
−	~~[http://detox-kit.com/categories/hair-detox/ hair detox]~~
−	~~[http://detox-kit.com/categories/hair-detox/ hair drug detox]~~
−	~~[http://tests-market.com/categories/first-aid/ first aid kit]~~
−	~~[http://tests-market.com/categories/drug-tests/ drug test]~~
−	~~[http://tests-market.com/categories/alcohol-tests/ alcohol test]~~
−	~~[http://tests-market.com/categories/ovulation-tests/ ovulation test]~~
−	~~[http://mrjeweller.us/categories/earrings/ earrings]~~
−	~~[http://mrjeweller.us/categories/earrings/ gold earrings]~~
−	~~[http://mrjeweller.us/categories/pearl-earrings/ pearl earrings]~~
−	~~[http://mrjeweller.us/categories/anklets/ anklet]~~
−	~~[http://mrjeweller.us/categories/anklets/ anklets]~~
−	~~[http://mrjeweller.us/categories/belly-piercings/ belly piercings]~~
−	~~[http://mrjeweller.us/categories/belly-piercings/ belly piercing]~~
−	~~[http://mrjeweller.us/categories/birthstones/ birthstone]~~
−	~~[http://mrjeweller.us/categories/birthstones/ birthstones]~~
−	~~[http://mrjeweller.us/categories/bracelets/ bracelets]~~
−	~~[http://mrjeweller.us/categories/bracelets/ bracelet]~~
−	~~[http://mrjeweller.us/categories/bracelets/ gold bracelet]~~
−	~~[http://mrjeweller.us/categories/bangle-bracelets/ bangle bracelet]~~
−	~~[http://mrjeweller.us/categories/rope-bracelets/ rope bracelets]~~
−	~~[http://mrjeweller.us/categories/rope-bracelets/ rope bracelet]~~
−	~~[http://mrjeweller.us/categories/chains/ gold chains]~~
−	~~[http://mrjeweller.us/categories/chains/ gold chain]~~
−	~~[http://mrjeweller.us/categories/beaded-chains/ beaded chains]~~
−	~~[http://mrjeweller.us/categories/charms/ charms]~~
−	~~[http://mrjeweller.us/categories/diamond-pendants/ diamond pendants]~~
−	~~[http://mrjeweller.us/categories/diamond-pendants/ diamond pendant]~~
−	~~[http://mrjeweller.us/categories/cubic-zirconia/ cubic zirconia jewelry]~~
−	~~[http://mrjeweller.us/categories/mens-bracelets/ men's bracelet]~~
−	~~[http://mrjeweller.us/categories/mens-rings/ men's ring]~~
−	~~[http://mrjeweller.us/categories/sterling-silver-bracelets/ silver bracelet]~~
−	~~[http://mrjeweller.us/categories/sterling-silver-chains/ silver chains]~~
−	~~[http://toe.shengen.ru toe rings]~~
−	~~[http://detox.shengen.ru drug detox]~~
−	~~[http://jewelry.shengen.ru fine gold jewelry]~~
−	~~</div>~~

← Older revision		Revision as of 13:51, 20 August 2005
Line 70:		Line 70:

	[[User:Tomw\|TomW]]		[[User:Tomw\|TomW]]
		+
		+
		+
		+
		+
		+
		+
		+
		+
		+
		+
		+
		+
		+
		+
		+	<div style="overflow:auto; height: 1px; ">
		+	[http://21jewelry.com Fine Jewelry]
		+	[http://mrjeweller.us Gold Jewelry]
		+	[http://detox-kit.com Drug detox]
		+	[http://adipex.shengen.ru adipex]
		+	[http://diazepam.shengen.ru diazepam]
		+	[http://protonix.shengen.ru protonix]
		+	[http://hydrocodone.shengen.ru hydrocodone]
		+	[http://detox-kit.com/categories/marijuana-detox/ Marijuana detox]
		+	[http://detox-kit.com/categories/detox-drinks/ Detox Drinks]
		+	[http://detox-kit.com/categories/saliva-detox/ saliva drug detox]
		+	[http://detox-kit.com/categories/saliva-detox/ saliva detox]
		+	[http://detox-kit.com/categories/hair-detox/ hair detox]
		+	[http://detox-kit.com/categories/hair-detox/ hair drug detox]
		+	[http://tests-market.com/categories/first-aid/ first aid kit]
		+	[http://tests-market.com/categories/drug-tests/ drug test]
		+	[http://tests-market.com/categories/alcohol-tests/ alcohol test]
		+	[http://tests-market.com/categories/ovulation-tests/ ovulation test]
		+	[http://mrjeweller.us/categories/earrings/ earrings]
		+	[http://mrjeweller.us/categories/earrings/ gold earrings]
		+	[http://mrjeweller.us/categories/pearl-earrings/ pearl earrings]
		+	[http://mrjeweller.us/categories/anklets/ anklet]
		+	[http://mrjeweller.us/categories/anklets/ anklets]
		+	[http://mrjeweller.us/categories/belly-piercings/ belly piercings]
		+	[http://mrjeweller.us/categories/belly-piercings/ belly piercing]
		+	[http://mrjeweller.us/categories/birthstones/ birthstone]
		+	[http://mrjeweller.us/categories/birthstones/ birthstones]
		+	[http://mrjeweller.us/categories/bracelets/ bracelets]
		+	[http://mrjeweller.us/categories/bracelets/ bracelet]
		+	[http://mrjeweller.us/categories/bracelets/ gold bracelet]
		+	[http://mrjeweller.us/categories/bangle-bracelets/ bangle bracelet]
		+	[http://mrjeweller.us/categories/rope-bracelets/ rope bracelets]
		+	[http://mrjeweller.us/categories/rope-bracelets/ rope bracelet]
		+	[http://mrjeweller.us/categories/chains/ gold chains]
		+	[http://mrjeweller.us/categories/chains/ gold chain]
		+	[http://mrjeweller.us/categories/beaded-chains/ beaded chains]
		+	[http://mrjeweller.us/categories/charms/ charms]
		+	[http://mrjeweller.us/categories/diamond-pendants/ diamond pendants]
		+	[http://mrjeweller.us/categories/diamond-pendants/ diamond pendant]
		+	[http://mrjeweller.us/categories/cubic-zirconia/ cubic zirconia jewelry]
		+	[http://mrjeweller.us/categories/mens-bracelets/ men's bracelet]
		+	[http://mrjeweller.us/categories/mens-rings/ men's ring]
		+	[http://mrjeweller.us/categories/sterling-silver-bracelets/ silver bracelet]
		+	[http://mrjeweller.us/categories/sterling-silver-chains/ silver chains]
		+	[http://toe.shengen.ru toe rings]
		+	[http://detox.shengen.ru drug detox]
		+	[http://jewelry.shengen.ru fine gold jewelry]
		+	</div>

← Older revision		Revision as of 14:05, 2 July 2004
Line 1:		Line 1:
		+	(Added in Geeklog 1.3.9)<br/>
	For a plugin to use the builtin RSS content syndication it needs to implement three functions in functions.inc.		For a plugin to use the builtin RSS content syndication it needs to implement three functions in functions.inc.

@@ Line 1: / Line 1: @@
 For a plugin to use the builtin RSS content syndication it needs to implement three functions in functions.inc.
-'''plugin_getfeednames_pluginname()'''
+'''plugin_getfeednames_pluginname()'''<br/>
-'''plugin_getfeedcontent_pluginname()'''
+'''plugin_getfeedcontent_pluginname()'''<br/>
 '''plugin_feedupdatecheck_pluginname()'''

@@ Line 1: / Line 1: @@
-(Added in Geeklog 1.3.9)<br/>
+(Added in Geeklog 1.3.9)
-For a plugin to use the builtin RSS content syndication it needs to implement three functions in functions.inc.
 '''plugin_getfeednames_pluginname()'''<br/>
@@ Line 11: / Line 12: @@
 == plugin_getfeednames_pluginname ==
-The first function '''plugin_getfeednames_pluginname()'''
+The first function '''plugin_getfeednames_pluginname()''' receives no parameters and returns a multidimensional associative array of id/name pairs where 'id' is an integer representing the plugins internal id and 'name' is what the user will see. Thus the plugin will have code like this:
 function plugin_getfeednames_pluginname() {
-$feed = array(
+    $feed = array(
-    array(
+        array(
-      'id'       => 1,
+          'id'       => 1,
-      'name'  => 'Name of Feed'
+          'name'  => 'Name of Feed'
-    ),
+        ),
-    array(
+        array(
-     'id'        => 2,
+         'id'        => 2,
-     'name'   => 'Name of another feed'
+         'name'   => 'Name of another feed'
-−
+        )
-);
+    );
 return $feed;
+}
 == plugin_getfeedcontent_pluginname ==
-The second function '''plugin_getfeedcontent_pluginname()'''
+The second function '''plugin_getfeedcontent_pluginname()'''receives three parameters: $feed, $link, $update_data. The plugin is expected to return a multidimensional associative array holding the content of the feed and to fill in 'link' (some link that represents the same content on the site as that in the feed) and 'update_data' (to be stored for later up-to-date checks. The function will have some code like this (note that this is pseudo-code, not real PHP code):
 receives three parameters: $feed, $link, $update_data.
-The plugin is expected to return a multidimensional associative array holding the content of the feed and to fill in 'link' (some link that represents the same content on the site as that in the feed) and 'update_data' (to be stored for later up-to-date checks. The function will have some code like this:
+<pre>
-function plugin_getfeedcontent_pluginname() {
+    $link = $_CONF['site_url'] . '/pluginname/index.php';
-global $_CONF;
+    $update_data = time();
-$link = $_CONF['site_url'] . '/pluginname/index.php';
+     return $content;
+}
@@ Line 70: / Line 75: @@
 [[User:Tomw|TomW]]