Search Class

MeNeedz's robust Search Class supports the following features:

Performing search based on config
Scrolling through search results
Caching of search results
Automatically updating cached search results after search has reached a certain age

Setting Search Preferences

There are 2 different preferences available to tailor how your search should work. You can either set them manually as described here, or automatically via preferences stored in your config file, described below:

Preferences are set by passing an array of preference values to the search init function. Here is an example of how you might set some preferences:

$config['max_age'] = 300;

$this->search->init($config);

Note: All preferences have default values that will be used if you do not set them.

Setting Search Preferences in a Config File

If you prefer not to set preferences using the above method, you can instead put them into a config file. Simply create a new file called the search.php, add the $config array in that file. Then save the file at config/search.php and it will be used automatically. You will NOT need to use the $this->search->init() function if you save your preferences in a config file.

Search Preferences

The following is a list of all the preferences that can be set when performing a search.

Preference	Default Value	Options	Description
max_age	300	Numeric value	The maximum age of a search in seconds.
db_config	See below	Array of settings for database usage	An array with all settings that are needed to use the database to cache the search results.
search_config	Empty array	Array of configs for different searches (See below)	An array with all settings that are needed to perform a search.

db_config

A more detailed explanation on the database preferences needed

	$config['db_config'] = array(
				'table' => 'search', //name of the search table
				'id_column' => 'search_id', //name of the column that holds the unique id of each search, e.g. a autoincrement field
				'hash_column' => 'search_hash', //column that holds a 32 character md5 hash
				'name_column' => 'search_name', //column that holds the name of the search performed, see below for further info
				'perform_column' => 'search_date_perform', //datetime the search was performed last
				'count_column' => 'search_result_count', //column that holds the total number of results the search returns
				'result_column' => 'search_result' //column that holds a serialized array of ids the search returns
				'where_column' => 'search_where' //column that holds a serialized array of where clauses used to perform the search
				'order_column' => 'search_order_by' //column that holds a serialized array of order by clauses used to perform the search
			);

search_config

A more detailed explanation on the search config needed

	$config['search_config'] = array(
		'test_search' => array( //name of the search, used to identify what search you are trying to perfom. Saved in name_column in search table
				'search_id_field' => 'user_id', //search does not return full rows with data but only a list of id that identify the rows
				'search_from' => 'user', //table to perform the search on
				'search_join' => array( //you can add additional tables by using the join function
								'user_group' => 'user.user_group = user_group.group_id' // key is the table you want to join, value is the constraint to use for the join
								),
				'search_default_where' => 'is_active = 1', //default where clause that should be used when performing the search, no matter if the user has submitted any fields or not
				'search_post_where' => array( //define additional where clauses depending on the fields the user submitted
									array(
										'post_field' => 'username' // name of the field submitted
										'db_column' => 'user_name' // name of the column used to compare with the value of the post field
										'operator' => '=' // operator used for comparision, possible values are all common operators in mysql including LIKE and MATCH (for fulltext search)
										'mode' => 'IN BOOLEAN MODE' // can be used to determine which mode to use with operator MATCH, possible values are 'IN BOOLEAN MODE' and 'WITH QUERY EXPANSION'
									),
									array(
										'post_field' => 'min_age' // name of the field submitted
										'db_column' => 'user_age' // name of the column used to compare with the value of the post field
										'operator' => '>' // operator used for comparision
									)
								),
				'search_post_order' => array( //you can add additional tables by using the join function
									'db_column_post_field' => 'column_field', // name of the post field that holds the name of the column used for ordering
									'order_post_field' => 'order_field' // name of the post field that holds the order (asc, desc or random)
									)
			),
	);

Setting up the database

A script used to create the search table could look like this:<br/>
--
-- Table `search`
--

CREATE TABLE IF NOT EXISTS `search` (
  `search_id` bigint(20) NOT NULL auto_increment,
  `search_hash` varchar(32) NOT NULL,
  `search_name` varchar(20) NOT NULL,
  `search_date_perform` datetime NOT NULL,
  `search_result_count` bigint(20) NOT NULL,
  `search_result` text NOT NULL,
  `search_where` text NOT NULL,
  `search_order_by` text NOT NULL,
  PRIMARY KEY  (`search_id`)
) ENGINE=MyISAM DEFAULT CHARSET=utf8 AUTO_INCREMENT=1 ;

Search Function Reference

$this->search->perform()

Perform a search:


$search = $this->search->perform('test_search', 0, 25);

1. parameter: name of the search as set in your config
2. parameter: offset
3. parameter: row count
Returns an array with the search id, the total number of results and the ids according to your offset, row count and the where parameters used to perform the search on succes and FALSE on failure.

$this->search->scroll()

Scroll search results:

$this->search->scroll(8, 0, 25); 1. parameter: id of the searc
2. parameter: offset
3. parameter: row count
Returns an array with the search id, the total number of results and the ids according to your offset, row count and the where parameters used to perform the search on succes and FALSE on failure.

MeNeedz Search User Guide Version 1.0