Adding a global search box - Revision history

BERT: /* Nodes Preparation */

2007-07-18T20:50:49Z

Nodes Preparation

← Older revision		Revision as of 20:50, 18 July 2007
Line 31:		Line 31:
	}		}
	</syntaxhighlight>		</syntaxhighlight>
	~~If you use the function descriptor in your node it will suppress the descriptor_def function from being invoked. You can check to see if your return value is empty, then manually invoke it like so:~~
	~~if ( !$returnValue ) return parent::descriptor($record);~~

	== Module Preparation ==		== Module Preparation ==

BERT: /* Existing issues with Global Search */

2007-07-18T20:37:22Z

Existing issues with Global Search

← Older revision		Revision as of 20:37, 18 July 2007
Line 126:		Line 126:
	For TEXT type attributes in MySQL. The metadata type returned appears to be "blob" not "text", change the fetchMeta function in atktextattribute to use gentype instead of type.		For TEXT type attributes in MySQL. The metadata type returned appears to be "blob" not "text", change the fetchMeta function in atktextattribute to use gentype instead of type.
	ie: $this->m_dbfieldtype = $metadata[$this->fieldName()]["gentype"];		ie: $this->m_dbfieldtype = $metadata[$this->fieldName()]["gentype"];

	~~If you use the function descriptor in your node it will suppress the descriptor_def function to be invoked. You can check to see if your return value is empty, then manually invoke it like so:~~
	~~if ( !$returnValue ) return $this->descriptor_def();~~

	== Credits ==		== Credits ==

	I would like to thank [[Boy]] in particular for highlighting some of the procedures here to make this doc possible.		I would like to thank [[Boy]] in particular for highlighting some of the procedures here to make this doc possible.

BERT: /* Nodes Preparation */

2007-07-18T20:37:08Z

Nodes Preparation

← Older revision		Revision as of 20:37, 18 July 2007
Line 32:		Line 32:
	</syntaxhighlight>		</syntaxhighlight>
	If you use the function descriptor in your node it will suppress the descriptor_def function from being invoked. You can check to see if your return value is empty, then manually invoke it like so:		If you use the function descriptor in your node it will suppress the descriptor_def function from being invoked. You can check to see if your return value is empty, then manually invoke it like so:
	if ( !$returnValue ) return $~~this->descriptor_def(~~);		if ( !$returnValue ) return parent::descriptor($record);

	== Module Preparation ==		== Module Preparation ==

BERT: /* Nodes Preparation */

2007-07-18T20:05:19Z

Nodes Preparation

← Older revision		Revision as of 20:05, 18 July 2007
Line 31:		Line 31:
	}		}
	</syntaxhighlight>		</syntaxhighlight>
	If you use the function descriptor in your node it will suppress the descriptor_def function ~~to be~~ invoked. You can check to see if your return value is empty, then manually invoke it like so:		If you use the function descriptor in your node it will suppress the descriptor_def function from being invoked. You can check to see if your return value is empty, then manually invoke it like so:
	if ( !$returnValue ) return $this->descriptor_def();		if ( !$returnValue ) return $this->descriptor_def();

BERT: /* Nodes Preparation */

2007-07-18T20:04:39Z

Nodes Preparation

← Older revision		Revision as of 20:04, 18 July 2007
Line 31:		Line 31:
	}		}
	</syntaxhighlight>		</syntaxhighlight>
			If you use the function descriptor in your node it will suppress the descriptor_def function to be invoked. You can check to see if your return value is empty, then manually invoke it like so:
			if ( !$returnValue ) return $this->descriptor_def();

	== Module Preparation ==		== Module Preparation ==

BERT: /* Existing issues with Global Search */

2007-07-18T19:38:55Z

Existing issues with Global Search

← Older revision		Revision as of 19:38, 18 July 2007
Line 122:		Line 122:
	To fix this this problem we may need to find a way, that will prevent those types of attributes from being passed to the MySQL engine at search time.		To fix this this problem we may need to find a way, that will prevent those types of attributes from being passed to the MySQL engine at search time.

			For TEXT type attributes in MySQL. The metadata type returned appears to be "blob" not "text", change the fetchMeta function in atktextattribute to use gentype instead of type.
			ie: $this->m_dbfieldtype = $metadata[$this->fieldName()]["gentype"];

			If you use the function descriptor in your node it will suppress the descriptor_def function to be invoked. You can check to see if your return value is empty, then manually invoke it like so:
			if ( !$returnValue ) return $this->descriptor_def();

	== Credits ==		== Credits ==

	I would like to thank [[Boy]] in particular for highlighting some of the procedures here to make this doc possible.		I would like to thank [[Boy]] in particular for highlighting some of the procedures here to make this doc possible.

bahtiar: How to add Global Search to ATK applications moved to Adding a global search box

2007-02-28T08:15:55Z

How to add Global Search to ATK applications moved to Adding a global search box

← Older revision	Revision as of 08:15, 28 February 2007
(No difference)

bahtiar at 13:20, 14 January 2007

2007-01-14T13:20:06Z

← Older revision		Revision as of 13:20, 14 January 2007
Line 25:		Line 25:
	To get the global search to work with your nodes you need to implement the following method within your node:		To get the global search to work with your nodes you need to implement the following method within your node:

			<syntaxhighlight lang="php">
	function descriptor_def()		function descriptor_def()
	{		{
	return "[your_descriptor_field_name_here]";		return "[your_descriptor_field_name_here]";
	}		}
			</syntaxhighlight>

	== Module Preparation ==		== Module Preparation ==
Line 37:		Line 39:
	* Go to the “modules” folder of your Achievo installation and copy the “search” module to the “modules” folder of your ATK installation.		* Go to the “modules” folder of your Achievo installation and copy the “search” module to the “modules” folder of your ATK installation.
	* Add the following line to your confic.modules.inc file:		* Add the following line to your confic.modules.inc file:
	module('search');		<syntaxhighlight lang="php">module('search');</syntaxhighlight>


Line 47:		Line 49:
	* Add the followin lines of code to the “top.php” file, before $top = $ui->renderBox....:		* Add the followin lines of code to the “top.php” file, before $top = $ui->renderBox....:

			<syntaxhighlight lang="php">
	$searchnode = &atkGetNode("search.search");		$searchnode = &atkGetNode("search.search");
	$searchpiece = $searchnode->simpleSearchForm("", "main", SESSION_NEW);		$searchpiece = $searchnode->simpleSearchForm("", "main", SESSION_NEW);
			</syntaxhighlight>

	* Include the following line on the renderBox code:		* Include the following line on the renderBox code:

			<syntaxhighlight lang="php">
	"searchpiece"=>$searchpiece,		"searchpiece"=>$searchpiece,
			</syntaxhighlight>

	== Search Implementation On nodes ==		== Search Implementation On nodes ==
Line 61:		Line 67:
	* open the file “module.inc” from the module that you would like to use global search		* open the file “module.inc” from the module that you would like to use global search
	* add the following method to this file:		* add the following method to this file:

	~~/* start top search implementation */~~
	~~function search($expression)~~
	{
	~~$res = array();~~
	~~// replace “module_name” with the actula name of the module~~
	~~// replace “node_name” with the actual name of the node~~
	~~// replace node_name_results with the title that will organize the results for the node~~
	~~$node_name_node = &atkGetNode("module_name.node_name");~~
	~~$res["node_name_results"] = $this->recLinks($node_name_node->searchDb($expression), “module_name.node_name”);~~

	// example 2		<syntaxhighlight lang="php">
	// $transaction_node = &atkGetNode($this->module.".budget_account_transaction");		/* start top search implementation */
	//$res["transactions"] = $this->recLinks($transaction_node->searchDb($expression), $this->module.".budget_account_transaction");		function search($expression)
			{
			$res = array();
			// replace “module_name” with the actula name of the module
			// replace “node_name” with the actual name of the node
			// replace node_name_results with the title that will organize the results for the node
			$node_name_node = &atkGetNode("module_name.node_name");
			$res["node_name_results"] = $this->recLinks($node_name_node->searchDb($expression), “module_name.node_name”);

			// example 2
			// $transaction_node = &atkGetNode($this->module.".budget_account_transaction");
			//$res["transactions"] = $this->recLinks($transaction_node->searchDb($expression), $this->module.".budget_account_transaction");

	return $res;		return $res;
	}// end function		}// end function
			</syntaxhighlight>

	* Add the following method to this file as well:		* Add the following method to this file as well:
	function recLinks($recordset, $nodetype)
	{		<syntaxhighlight lang="php">
	//$node = &atkGetNode($nodetype);		function recLinks($recordset, $nodetype)
			{
			//$node = &atkGetNode($nodetype);

	$res = array();		$res = array();

	$node = &atkGetNode($nodetype);		$node = &atkGetNode($nodetype);
	if ($node->allowed("view"))		if ($node->allowed("view"))
	{		{
	for($i=0, $_i=count($recordset); $i<$_i; $i++)		for($i=0, $_i=count($recordset); $i<$_i; $i++)
	{		{
	$item["title"] = $node->descriptor($recordset[$i]);		$item["title"] = $node->descriptor($recordset[$i]);
	$item["url"] = dispatch_url($nodetype, "view", array("atkselector"=>$node->primaryKey($recordset[$i])));		$item["url"] = dispatch_url($nodetype, "view", array("atkselector"=>$node->primaryKey($recordset[$i])));
	$res[] = $item;		$res[] = $item;
	}		}
	}		}

	return $res;		return $res;
	} // end function		} // end function
	/* end top search implementation */		/* end top search implementation */
			</syntaxhighlight>

	That was easy, right? If you've followed these steps to the letter, you should be able to search all the nodes that you included the “search” method of the “module.inc” file.		That was easy, right? If you've followed these steps to the letter, you should be able to search all the nodes that you included the “search” method of the “module.inc” file.
Line 114:		Line 125:
	== Credits ==		== Credits ==

	I would like to thank Boy in particular for highlighting some of the procedures here to make this doc possible.		I would like to thank [[Boy]] in particular for highlighting some of the procedures here to make this doc possible.

bahtiar: /* Requirements */ Fixed link

2006-07-26T07:36:16Z

Requirements: Fixed link

← Older revision		Revision as of 07:36, 26 July 2006
Line 18:		Line 18:

	I think that covers it all. You can download the latest ATK and Achievo from:		I think that covers it all. You can download the latest ATK and Achievo from:
	http://achievo.org/~~files~~/nightly		http://www.achievo.org/download/nightly


	== Nodes Preparation ==		== Nodes Preparation ==

bahtiar: Some more formatting

2006-07-26T07:35:43Z

Some more formatting

← Older revision		Revision as of 07:35, 26 July 2006
Line 1:		Line 1:
	{{Howto:Advanced:[[Jorge Garifuna]] <info@GariDigital.com>}}		{{Howto\|Advanced\|[[Jorge Garifuna]] <info@GariDigital.com>}}

	== Summary ==		== Summary ==
Line 26:		Line 26:
	To get the global search to work with your nodes you need to implement the following method within your node:		To get the global search to work with your nodes you need to implement the following method within your node:

	function descriptor_def(){		function descriptor_def()
	~~$descriptor_field = “~~[your_descriptor_field_name_here]”;		{
	~~return $descriptor_field~~;		return "[your_descriptor_field_name_here]";
	}		}

	~~$descriptor_field is the actual name of the field, which value you would like to display on the search results.~~


	== Module Preparation ==		== Module Preparation ==
Line 39:		Line 36:
	The Achievo installation comes with a search module that works out of the box on ATK. To use this module, simply		The Achievo installation comes with a search module that works out of the box on ATK. To use this module, simply

	1. Go to the “modules” folder of your Achievo installation and copy the “search” module to the “modules” folder of your ATK installation.		* Go to the “modules” folder of your Achievo installation and copy the “search” module to the “modules” folder of your ATK installation.
	2. Add the following line to your confic.modules.inc file:		* Add the following line to your confic.modules.inc file:
	1. module('search');		module('search');


Line 49:		Line 46:
	To have the search displayed on the top right of your ATK application, you need to have the “achievo_modern” theme properly installed and follow these instructions:		To have the search displayed on the top right of your ATK application, you need to have the “achievo_modern” theme properly installed and follow these instructions:

	1. Add the followin lines of code to the “top.php” file, before $top = $ui->renderBox....:		* Add the followin lines of code to the “top.php” file, before $top = $ui->renderBox....:
	$searchnode = &atkGetNode("search.search");
	$searchpiece = $searchnode->simpleSearchForm("", "main", SESSION_NEW);		$searchnode = &atkGetNode("search.search");
	2. Include the following line on the renderBox code:		$searchpiece = $searchnode->simpleSearchForm("", "main", SESSION_NEW);
	"searchpiece"=>$searchpiece,
			* Include the following line on the renderBox code:

			"searchpiece"=>$searchpiece,

	== Search Implementation On nodes ==		== Search Implementation On nodes ==
Line 60:		Line 60:
	This is where the real fun begins. Now that we have done all the necessary preparation, it is time to implement the actual search, so that our nodes can use it. Follow these steps to have your nodes make use of the global search:		This is where the real fun begins. Now that we have done all the necessary preparation, it is time to implement the actual search, so that our nodes can use it. Follow these steps to have your nodes make use of the global search:

	1. open the file “module.inc” from the module that you would like to use global search		* open the file “module.inc” from the module that you would like to use global search
	2. add the following method to this file:		* add the following method to this file:

	/* start top search implementation */		/* start top search implementation */
Line 80:		Line 80:
	}// end function		}// end function

	3. Add the following method to this file as well:		* Add the following method to this file as well:
	function recLinks($recordset, $nodetype)		function recLinks($recordset, $nodetype)
	{		{
Line 111:		Line 111:

	To fix this this problem we may need to find a way, that will prevent those types of attributes from being passed to the MySQL engine at search time.		To fix this this problem we may need to find a way, that will prevent those types of attributes from being passed to the MySQL engine at search time.



	~~== Last Words ==~~


	~~We all know that ATK rocks! So spread the word. We would love to assist you at the forum. While you there, if you come across a guy named Ivo, be nice to him. After a while you'd know why :)~~

	~~By the way, if you are a lazy programmer like me, feel free to check out the ATK Code generator, which allows you to build a complete web application in 3 clicks:~~

	~~[http://garisoft.com/atk/samples/code_generator/]~~

	~~You can also test drive an ATK Personal Finance application I'm working on at:~~
	~~[http://garisoft.com/atk/admin/]~~

	~~'''username:''' demo1~~
	~~'''password:''' demo1~~

	~~Now go and have fun :)~~


	== Credits ==		== Credits ==


	I would like to thank Boy in particular for highlighting some of the procedures here to make this doc possible.		I would like to thank Boy in particular for highlighting some of the procedures here to make this doc possible.