Using Geeklog's Search Engine - Revision history

Sbarakat: Placed new API at the top

2009-10-20T21:40:20Z

Placed new API at the top

LWC: /* New method */

2009-05-26T12:26:37Z

‎New method

LWC: Formatted

2009-05-26T12:16:30Z

Formatted

LWC: /* plugin_searchtypes_{plugin_name}() */ Fixed

2009-05-26T11:12:57Z

‎plugin_searchtypes_{plugin_name}(): Fixed

Dirk: Fixed formatting

2009-05-09T07:46:10Z

Fixed formatting

Dirk: added Category:Plugin Developers Handbook

2009-05-05T08:50:56Z

added Category:Plugin Developers Handbook

Sbarakat at 16:53, 17 August 2008

2008-08-17T16:53:53Z

Dirk: Changed category

2008-05-10T20:17:45Z

Changed category

Tomw at 13:59, 1 July 2004

2004-07-01T13:59:44Z

Tomw at 22:09, 29 June 2004

2004-06-29T22:09:09Z

@@ Line 1: / Line 1: @@
-==Old method==
+== New Search API (GL v1.6.x or greater) ==
-This method is meant for Geeklog v1.5 and below.
+As of Geeklog v1.6 the core search functionality has been changed which has required updated API methods. The new API makes use of the new and improved '''SearchCriteria()''' class. See [[Using Geeklog's Improved Search Engine]].
 ===The functions===
@@ Line 124: / Line 127: @@
+}
 </pre>
 [[Category:Plugin Developers Handbook]] [[Category:Plugin Development]]

@@ Line 128: / Line 128: @@
 This method only works in Geeklog v1.6 and above.
-There is an updated API which makes use of the new and improved [[Using Geeklog's Improved Search Engine|SearchCriteria()]] class.
+There is an updated API which makes use of the new and improved '''SearchCriteria()''' class. See [[Using Geeklog's Improved Search Engine]].
 [[Category:Plugin Developers Handbook]] [[Category:Plugin Development]]

@@ Line 1: / Line 1: @@
-'''Note:''' The information on this page refers to the old search API which makes use of the Plugin() class. There has since been improvements made to the search pages that requires an updated API which makes use of the new and improved [[Using Geeklog's Improved Search Engine|SearchCriteria()]] class.
+==Old method==
+This method is meant for Geeklog v1.5 and below.
 Tying your plugin into Geeklogs search API is rather easy.  Easy, that is, if you know how search your plugins data already.  The Geeklog search API provides a way for you to return your search results back to Geeklog to be included in its search results page.
@@ Line 12: / Line 12: @@
 Let's look at each of them in turn:
+==== plugin_searchtypes_{plugin_name}() ====
 This function takes no parameters and returns an associative array of the search type.  The normal code for this
@@ Line 33: / Line 32: @@
 You can have multiple search types and descriptions.
-== plugin_dopluginsearch_{plugin_name}() ==
+==== plugin_dopluginsearch_{plugin_name}() ====
 This function is where the search is actually done.  It is passed a number of parameters that can be used in your search.  They are:
@@ Line 126: / Line 125: @@
 </pre>
 [[Category:Plugin Developers Handbook]] [[Category:Plugin Development]]

@@ Line 21: / Line 21: @@
 function plugin_searchtypes_{plugin_name}() {
      global $LANG_PL00;
-     $tmp['searchtype']= $LANG_PL00['searchtype'];
+     $tmp['{plugin_name}']= $LANG_PL00['searchtype'];
      return $tmp;
+}
 </pre>
 Naturally all occurrences of plugin would be replaced with the name of your plugin and the LANGUAGE varible $LANG_PL00 is just an example. Your Plugin needs to use a unique variable name so replace PL00.
@@ Line 31: / Line 32: @@
 You can have multiple search types and descriptions.
 == plugin_dopluginsearch_{plugin_name}() ==

@@ Line 18: / Line 18: @@
 function will make it all clear.  Normally the function looks like this:
 function plugin_searchtypes_{plugin_name}() {
      global $LANG_PL00;
@@ Line 23: / Line 24: @@
      return $tmp;
+}
 Naturally all occurrences of plugin would be replaced with the name of your plugin and the LANGUAGE varible $LANG_PL00 is just an example. Your Plugin needs to use a unique variable name so replace PL00.

@@ Line 1: / Line 1: @@
-The information on this page refers to the old search API which makes use of the Plugin() class. There has since been improvements made to the search pages that requires an updated API which makes use of the new and improved [[Using Geeklog's Improved Search Engine|SearchCriteria()]] class.
+'''Note:''' The information on this page refers to the old search API which makes use of the Plugin() class. There has since been improvements made to the search pages that requires an updated API which makes use of the new and improved [[Using Geeklog's Improved Search Engine|SearchCriteria()]] class.
 Tying your plugin into Geeklogs search API is rather easy.  Easy, that is, if you know how search your plugins data already.  The Geeklog search API provides a way for you to return your search results back to Geeklog to be included in its search results page.
 For the data in your plugin to be searched by Geeklogs search functions, there are two functions that you need to implement in your plugins function.inc:
-*plugin_searchtypes_{plugin_name}() returns to Geeklog the type(s) of search.
+* plugin_searchtypes_{plugin_name}() returns to Geeklog the type(s) of search.
-*plugin_dopluginsearch_{plugin_name}() returns the actual results to Geeklog.
+* plugin_dopluginsearch_{plugin_name}() returns the actual results to Geeklog.
 Let's look at each of them in turn:
@@ Line 17: / Line 14: @@
 == plugin_searchtypes_{plugin_name}() ==
 This function takes no parameters and returns an associative array of the search type.  The normal code for this
@@ Line 28: / Line 24: @@
+}
-Naturally all occurrences of plugin would be replaced with the name of your
+Naturally all occurrences of plugin would be replaced with the name of your plugin and the LANGUAGE varible $LANG_PL00 is just an example. Your Plugin needs to use a unique variable name so replace PL00.
-The return array is of the format array['searchtype'] = 'Search Description', where searchtype
+The return array is of the format array['searchtype'] = 'Search Description', where searchtype is returned to your plugin search routine and Description is displayed in the Search Page Drop Down box.
 You can have multiple search types and descriptions.
@@ Line 41: / Line 33: @@
 == plugin_dopluginsearch_{plugin_name}() ==
-This function is where the search is actually done.  It is passed a number of parameters that can be used
+* $query -- the actual items being searched for.
-in your search.  They are:
+* $datestart -- starting date to begin search.
 * $dateend -- ending date to end search.
-*$query -- the actual items being searched for.
+* $topic -- topic item is assigned to.
-*$datestart -- starting date to begin search.
+* $type -- type of item (see searchtypes above).
-*$dateend -- ending date to end search.
+* $author -- author of item.
 Depending on your plugin, some of these criteria may be meaningless and thus ignored.  Here is a brief overview of what your function should do.
-#Initialize plugin object
+# Initialize plugin object
-#Check to see if type is appropriate for this plugin -- if not, bail out.
+# Check to see if type is appropriate for this plugin -- if not, bail out.
-#Get a list of all your items to search.
+# Get a list of all your items to search.
-#Create Search object and Build search results header.
+# Create Search object and Build search results header.
-#Search each of your items in turn.
+# Search each of your items in turn.
-#If a match then add item to the results.
+# If a match then add item to the results.
-#When done set number of results and return search object
+# When done set number of results and return search object
-Looking at the example code  should make all of this clear.  The search results are returned in a object of type Plugin.  You initialize
+Looking at the example code  should make all of this clear.  The search results are returned in a object of type Plugin.  You initialize the object by setting the Label and then setting the names of the columns you want returned.  This is done in typical object fashion with this construct: $plugin->addSearch Heading.
-The headings will vary according to
+The headings will vary according to what your plugin does, but should include a link to the item found.  After searching each of your items in turn; you add your search results to an array having the same number of items as the labels you set earlier.
-Note:  your search should be case insensitive to be compatible with Geeklogs search.  This array will correspond to the column headings entered above.  In the example below, the array consists of
+Note:  your search should be case insensitive to be compatible with Geeklogs search.  This array will correspond to the column headings entered above.  In the example below, the array consists of the Title of the page, the url to the page (a link) and the number of hits.  This array is then added to the Plugin object as a row.
 The following construct is used:  $plugin->addSearchResult.
-When you are done searching you set the number of rows found and the number
+When you are done searching you set the number of rows found and the number searched to the plugin object and return it. The example below is from the External Pages Plugin.
 searched to the plugin object and return it.
-The example below is the External Pages Plugin.
+<pre>
      if (empty($type)) {
          $type = 'all';
@@ Line 136: / Line 122: @@
      return $plugin_results;
+}
-[[Category:Plugin Development]]
+[[Category:Plugin Developers Handbook]] [[Category:Plugin Development]]

← Older revision		Revision as of 16:53, 17 August 2008
Line 1:		Line 1:
		+	The information on this page refers to the old search API which makes use of the Plugin() class. There has since been improvements made to the search pages that requires an updated API which makes use of the new and improved [[Using Geeklog's Improved Search Engine\|SearchCriteria()]] class.
		+
		+
		+
		+
	Tying your plugin into Geeklogs search API is rather easy. Easy, that is, if you know how search		Tying your plugin into Geeklogs search API is rather easy. Easy, that is, if you know how search
	your plugins data already. The Geeklog search API provides a way for you to return your search		your plugins data already. The Geeklog search API provides a way for you to return your search

← Older revision		Revision as of 20:17, 10 May 2008
Line 132:		Line 132:
	}		}

−	[[Category:~~Plugin_Developers_Handbook~~]]	+	[[Category:Plugin Development]]

← Older revision		Revision as of 13:59, 1 July 2004
Line 131:		Line 131:
	return $plugin_results;		return $plugin_results;
	}		}
		+
		+	[[Category:Plugin_Developers_Handbook]]