Class flSearch

flSearch Class

Class to search an index and return the results.

Direct known subclasses

flSearchIndexer

Package: fusionLib
Copyright: Copyright (c) 2008 - 2016 fusionLib. All rights reserved.
Located at system/libs/Search/flSearch.php

Methods summary

`public`	# `__construct( flDb $db, string $tableBase )` Construct the object. Construct the object. Parameters `$db` The database object to use. `$tableBase` The base name for database tables.
`public array`	# `removeStopWords( array $words )` Remove stop words from the passed in array of words. Remove stop words from the passed in array of words. Parameters `$words` Array of lowercase words to remove the stop words from. Returns array The cleaned array of words.
`public flSearchResults`	# `find( string $query, array\|string $path = '', boolean $shortPath = true, boolean $returnShortPaths = true, array $accessPerms = array(), array $inFields = array(), integer $start = 0, integer $count = 10, boolean $matchAll = false )` Search the index. Search the index. Parameters `$query` The query string, max 100 characters. `$path` Array of category names that is the path to limit the search to, '' to search all. `$shortPath` True if using short path format root:node. `$returnShortPaths` true if returning only root and node id per result rather than full path to result node. `$accessPerms` Array of acces permissions that the searcher has. `$inFields` The list of fields to look within or empty for all fields. `$start` The offset into the results. `$count` The number of results to return. `$matchAll` true if all terms must be present in a document or false for best match. Returns `flSearchResults` Object holding the results.

Properties summary

`protected string`	`$db` The database object to use. The database object to use.	#
`protected string`	`$tableBase` The base name for database tables. The base name for database tables.	#
`protected integer`	`$minWordLen` Minimum length of an indexed word. Minimum length of an indexed word.	#
`protected integer`	`$maxWordLen` Maximum length of an indexed word. Maximum length of an indexed word.	#
`protected array`	`$stopWords` Array of stop words Array of stop words	#
`protected flTextStemmer`	`$stemmer` The language to load the stemmer in. The language to load the stemmer in.	#
`protected flDbNestedSet`	`$docs` The document storage. The document storage.	#