Creating a Smart Search plug-in - Revision history

Cmb: Some changes for Word2Watch compliance and other markup changes.

2023-02-19T15:41:49Z

Some changes for Word2Watch compliance and other markup changes.

M-b-o: Marked this version for translation

2021-02-17T23:11:28Z

Marked this version for translation

← Older revision		Revision as of 23:11, 17 February 2021
Line 1:		Line 1:
	<noinclude><languages /></noinclude> <translate>		<noinclude><languages /></noinclude> <translate>
			<!--T:1-->
	Smart Search plug-ins are gathered together for convenience into a plug-in group called "finder". Take a look in the <tt>plugins/finder</tt> directory and you will see the plug-ins that support the core Joomla content types. It is best to create your own plug-in by taking a copy of one of these plug-ins and adapting it to meet your specific needs.		Smart Search plug-ins are gathered together for convenience into a plug-in group called "finder". Take a look in the <tt>plugins/finder</tt> directory and you will see the plug-ins that support the core Joomla content types. It is best to create your own plug-in by taking a copy of one of these plug-ins and adapting it to meet your specific needs.

			<!--T:2-->
	All Smart Search plug-ins extend the FinderIndexerAdapter class which contains a good many methods to deal with maintaining the index. For the vast majority of custom content requirements you will only need to override a few of these methods.		All Smart Search plug-ins extend the FinderIndexerAdapter class which contains a good many methods to deal with maintaining the index. For the vast majority of custom content requirements you will only need to override a few of these methods.

			<!--T:3-->
	There is some additional information on writing a Smart Search plug-in [https://magazine.joomla.org/issues/issue-feb-2012/item/671-Developing-a-Smart-Search-Plugin here].		There is some additional information on writing a Smart Search plug-in [https://magazine.joomla.org/issues/issue-feb-2012/item/671-Developing-a-Smart-Search-Plugin here].

	==The principal properties==		==The principal properties== <!--T:4-->
	Before looking at the methods, there are a few properties that need to be set up correctly:		Before looking at the methods, there are a few properties that need to be set up correctly:
	* $context		* $context
Line 19:		Line 22:
	*: The database field in your table that the published state of an item is stored in; default's to "state".		*: The database field in your table that the published state of an item is stored in; default's to "state".

	==The principal methods==		==The principal methods== <!--T:5-->
	The first methods you will want to override when developing a new Smart Search plug-in are the setup, index and getListQuery methods. In the vast majority of cases those three methods will be enough to get your content indexed, although the plug-in will not be complete as there are other methods that must be implemented to deal with issues such as updating the index when the content changes. But those three methods are the working core of the plug-in.		The first methods you will want to override when developing a new Smart Search plug-in are the setup, index and getListQuery methods. In the vast majority of cases those three methods will be enough to get your content indexed, although the plug-in will not be complete as there are other methods that must be implemented to deal with issues such as updating the index when the content changes. But those three methods are the working core of the plug-in.
	* setup		* setup
Line 28:		Line 31:
	*: This method must return a JDatabaseQuery object that will form the basis of a query that will return a list of objects of the given content type. There are constraints on this query to ensure that it is compatible with other methods used by the indexer. This method is described in more detail later.		*: This method must return a JDatabaseQuery object that will form the basis of a query that will return a list of objects of the given content type. There are constraints on this query to ensure that it is compatible with other methods used by the indexer. This method is described in more detail later.

	==Some other methods==		==Some other methods== <!--T:6-->
	For a complete Smart Search plug-in there are a number of other methods you may need to override.		For a complete Smart Search plug-in there are a number of other methods you may need to override.

			<!--T:7-->
	* translateState		* translateState
	*: Given a content item this method translates the native state of the content item into a state that the indexer can use. It must return an integer 0 if the content item is not to appear in search results, or an integer 1 if the content item can appear in search results.		*: Given a content item this method translates the native state of the content item into a state that the indexer can use. It must return an integer 0 if the content item is not to appear in search results, or an integer 1 if the content item can appear in search results.
Line 38:		Line 42:
	*: This method is used to build a generic query for checking the access and state of items and their parent categories. This method uses the $table and $state_field properties to select the correct data.		*: This method is used to build a generic query for checking the access and state of items and their parent categories. This method uses the $table and $state_field properties to select the correct data.

	==Event methods==		==Event methods== <!--T:8-->
	The following methods are called via the Smart Search content plug-in in response to specific trigger events in Joomla.		The following methods are called via the Smart Search content plug-in in response to specific trigger events in Joomla.
	* onFinderBeforeSave		* onFinderBeforeSave
Line 51:		Line 55:
	*: Called in response to an onCategoryChangeState event.		*: Called in response to an onCategoryChangeState event.

	==Methods in more details==		==Methods in more details== <!--T:9-->

	===getListQuery===		===getListQuery=== <!--T:10-->
	This method must return a JDatabaseQuery object that will form the basis of a query that will return a list of objects of the given content type. There are constraints on this query to ensure that it is compatible with other methods used by the indexer. If the following conditions are not true then you will need to override other methods in the FinderIndexerAdapter class.		This method must return a JDatabaseQuery object that will form the basis of a query that will return a list of objects of the given content type. There are constraints on this query to ensure that it is compatible with other methods used by the indexer. If the following conditions are not true then you will need to override other methods in the FinderIndexerAdapter class.
	* The primary database table that is being indexed must have an alias of "a".<ref>If this condition is not true you will also have to override the getItem, getUpdateQueryByTime and getUpdateQueryByIds methods</ref>		* The primary database table that is being indexed must have an alias of "a".<ref>If this condition is not true you will also have to override the getItem, getUpdateQueryByTime and getUpdateQueryByIds methods</ref>

	===index===		===index=== <!--T:11-->
	This method is called whenever a content item needs to be indexed (or re-indexed). It is passed an object of type FinderIndexerResult and its purpose is to make adjustments to that object and to add metadata before handing control to FinderIndexer::index method to do the indexing proper.		This method is called whenever a content item needs to be indexed (or re-indexed). It is passed an object of type FinderIndexerResult and its purpose is to make adjustments to that object and to add metadata before handing control to FinderIndexer::index method to do the indexing proper.

	===setup===		===setup=== <!--T:12-->
	This method is called prior to the index method and is used to set up the index process. In this method is where you would typically include any externally required classes to allow for proper indexing.		This method is called prior to the index method and is used to set up the index process. In this method is where you would typically include any externally required classes to allow for proper indexing.

	==FinderIndexerResult properties==		==FinderIndexerResult properties== <!--T:13-->
	* url		* url
	* route		* route
Line 76:		Line 80:
	* extension (only used in core for com_categories plugin)		* extension (only used in core for com_categories plugin)

	==Testing==		==Testing== <!--T:14-->
	Testing a finder plugin can be a bit difficult due to the fact that it is typically run using an ajax process, so you don't tend to actually see any results from the process.		Testing a finder plugin can be a bit difficult due to the fact that it is typically run using an ajax process, so you don't tend to actually see any results from the process.

			<!--T:15-->
	As such, one way to test is to use the command line indexer.<ref>[http://docs.joomla.org/Setting_up_automatic_Smart_Search_indexing Setting up automatic Smart Search Indexing]</ref>		As such, one way to test is to use the command line indexer.<ref>[http://docs.joomla.org/Setting_up_automatic_Smart_Search_indexing Setting up automatic Smart Search Indexing]</ref>

			<!--T:16-->
	Open a command prompt/ssh session on the server and go to the root directory of the website.		Open a command prompt/ssh session on the server and go to the root directory of the website.
	From there, you can run the indexer and errors and log messages will go to the screen.		From there, you can run the indexer and errors and log messages will go to the screen.
	<tt>php cli/finder_indexer.php</tt>		<tt>php cli/finder_indexer.php</tt>

	==Notes==		==Notes== <!--T:17-->
	<references/>		<references/>
	</translate>		</translate>
	[[Category:Smart Search]]		[[Category:Smart Search]]
	[[Category:Plugin Development]]		[[Category:Plugin Development]]

M-b-o at 23:11, 17 February 2021

2021-02-17T23:11:19Z

← Older revision		Revision as of 23:11, 17 February 2021
Line 1:		Line 1:
			<noinclude><languages /></noinclude> <translate>
	Smart Search plug-ins are gathered together for convenience into a plug-in group called "finder". Take a look in the <tt>plugins/finder</tt> directory and you will see the plug-ins that support the core Joomla content types. It is best to create your own plug-in by taking a copy of one of these plug-ins and adapting it to meet your specific needs.		Smart Search plug-ins are gathered together for convenience into a plug-in group called "finder". Take a look in the <tt>plugins/finder</tt> directory and you will see the plug-ins that support the core Joomla content types. It is best to create your own plug-in by taking a copy of one of these plug-ins and adapting it to meet your specific needs.

Line 86:		Line 87:
	==Notes==		==Notes==
	<references/>		<references/>
			</translate>
	[[Category:Smart Search]]		[[Category:Smart Search]]
	[[Category:Plugin Development]]		[[Category:Plugin Development]]

Sandra97 at 09:20, 28 May 2019

2019-05-28T09:20:41Z

← Older revision		Revision as of 09:20, 28 May 2019
Line 1:		Line 1:
	Smart Search plug-ins are gathered together for convenience into a plug-in group called "finder". Take a look in the <tt>plugins/finder</tt> directory and you will see the plug-ins that support the core Joomla content types. It is best to create your own plug-in by taking a copy of one of these plug-ins and adapting it to meet your specific needs.		Smart Search plug-ins are gathered together for convenience into a plug-in group called "finder". Take a look in the <tt>plugins/finder</tt> directory and you will see the plug-ins that support the core Joomla content types. It is best to create your own plug-in by taking a copy of one of these plug-ins and adapting it to meet your specific needs.

	All Smart Search plug-ins extend the FinderIndexerAdapter class which contains a good many methods to deal with maintaining the index. For the vast majority of custom content requirements you will only need to override a few of these methods.		All Smart Search plug-ins extend the FinderIndexerAdapter class which contains a good many methods to deal with maintaining the index. For the vast majority of custom content requirements you will only need to override a few of these methods.

	There is some additional information on writing a Smart Search plug-in [~~http~~://magazine.joomla.org/issues/issue-feb-2012/item/671-Developing-a-Smart-Search-Plugin here].		There is some additional information on writing a Smart Search plug-in [https://magazine.joomla.org/issues/issue-feb-2012/item/671-Developing-a-Smart-Search-Plugin here].

	==The principal properties==		==The principal properties==
Line 76:		Line 76:

	==Testing==		==Testing==

	Testing a finder plugin can be a bit difficult due to the fact that it is typically run using an ajax process, so you don't tend to actually see any results from the process.		Testing a finder plugin can be a bit difficult due to the fact that it is typically run using an ajax process, so you don't tend to actually see any results from the process.

Line 83:		Line 82:
	Open a command prompt/ssh session on the server and go to the root directory of the website.		Open a command prompt/ssh session on the server and go to the root directory of the website.
	From there, you can run the indexer and errors and log messages will go to the screen.		From there, you can run the indexer and errors and log messages will go to the screen.
	<~~source~~>		<tt>php cli/finder_indexer.php</tt>
	php cli/finder_indexer.php

	</~~source~~>

	==Notes==		==Notes==

Wilsonge: Remove under construction. Last edit over 5 months ago

2013-08-07T11:10:32Z

Remove under construction. Last edit over 5 months ago

← Older revision		Revision as of 11:10, 7 August 2013
Line 1:		Line 1:
	~~{{underconstruction}}~~
	Smart Search plug-ins are gathered together for convenience into a plug-in group called "finder". Take a look in the <tt>plugins/finder</tt> directory and you will see the plug-ins that support the core Joomla content types. It is best to create your own plug-in by taking a copy of one of these plug-ins and adapting it to meet your specific needs.		Smart Search plug-ins are gathered together for convenience into a plug-in group called "finder". Take a look in the <tt>plugins/finder</tt> directory and you will see the plug-ins that support the core Joomla content types. It is best to create your own plug-in by taking a copy of one of these plug-ins and adapting it to meet your specific needs.

HermanPeeren: /* Testing */ Underscore still not visible in php cli/finder_indexer.php, in FireFox at least. Now adding an extra line

2013-02-27T08:37:49Z

Testing: Underscore still not visible in php cli/finder_indexer.php, in FireFox at least. Now adding an extra line

← Older revision		Revision as of 08:37, 27 February 2013
Line 86:		Line 86:
	<source>		<source>
	php cli/finder_indexer.php		php cli/finder_indexer.php

	</source>		</source>

HermanPeeren: Under "Testing", the underscore is not displayed. I tried with removing type="bash"

2013-02-26T12:55:06Z

Under "Testing", the underscore is not displayed. I tried with removing type="bash"

← Older revision		Revision as of 12:55, 26 February 2013
Line 84:		Line 84:
	Open a command prompt/ssh session on the server and go to the root directory of the website.		Open a command prompt/ssh session on the server and go to the root directory of the website.
	From there, you can run the indexer and errors and log messages will go to the screen.		From there, you can run the indexer and errors and log messages will go to the screen.
	<source ~~type="bash"~~>		<source>
	php cli/finder_indexer.php		php cli/finder_indexer.php
	</source>		</source>

Tom Hutchison: adding category to page

2012-08-08T03:21:54Z

adding category to page

← Older revision		Revision as of 03:21, 8 August 2012
Line 92:		Line 92:

	[[Category:Smart Search]]		[[Category:Smart Search]]
			[[Category:Plugin Development]]

Garyamort: /* Testing */

2012-04-12T19:57:28Z

Testing

← Older revision		Revision as of 19:57, 12 April 2012
Line 80:		Line 80:
	Testing a finder plugin can be a bit difficult due to the fact that it is typically run using an ajax process, so you don't tend to actually see any results from the process.		Testing a finder plugin can be a bit difficult due to the fact that it is typically run using an ajax process, so you don't tend to actually see any results from the process.

	As such, one way to test is to use the command line indexer.<ref>[http://docs.joomla.org/Setting_up_automatic_Smart_Search_indexing Setting up automatic Smart Search Indexing]/ref>		As such, one way to test is to use the command line indexer.<ref>[http://docs.joomla.org/Setting_up_automatic_Smart_Search_indexing Setting up automatic Smart Search Indexing]</ref>

	Open a command prompt/ssh session on the server and go to the root directory of the website.		Open a command prompt/ssh session on the server and go to the root directory of the website.

Garyamort: /* Testing */

2012-04-12T19:56:49Z

Testing

← Older revision		Revision as of 19:56, 12 April 2012
Line 80:		Line 80:
	Testing a finder plugin can be a bit difficult due to the fact that it is typically run using an ajax process, so you don't tend to actually see any results from the process.		Testing a finder plugin can be a bit difficult due to the fact that it is typically run using an ajax process, so you don't tend to actually see any results from the process.

	As such, one way to test is to use the command line indexer.<ref>~~insert link to indexer<~~/ref>		As such, one way to test is to use the command line indexer.<ref>[http://docs.joomla.org/Setting_up_automatic_Smart_Search_indexing Setting up automatic Smart Search Indexing]/ref>

	Open a command prompt/ssh session on the server and go to the root directory of the website.		Open a command prompt/ssh session on the server and go to the root directory of the website.