PaperSearch Class Reference
[Search]

Class for retrieving paper search results. More...

List of all members.

Public Member Functions
&	_getMergedArray (&$conference, &$keywords, $publishedFrom, $publishedTo, &$resultCount)
&	_getMergedKeywordResults (&$conference, &$keyword, $type, $publishedFrom, $publishedTo, $resultsPerKeyword, $resultCacheHours)
&	_getMergedPhraseResults (&$conference, &$phrase, $type, $publishedFrom, $publishedTo, $resultsPerKeyword, $resultCacheHours)
&	_getSparseArray (&$mergedResults, $resultCount)
	_parseQuery ($signTokens, $tokens, &$pos, $total)
&	formatResults (&$results)
	parseQuery ($query)
&	retrieveResults (&$conference, &$keywords, $publishedFrom=null, $publishedTo=null, $rangeInfo=null)

---

Detailed Description

Class for retrieving paper search results.

See also:

PaperSeachDAO, PaperSearchIndex

FIXME: NEAR; precedence w/o parens?; stemming; weighted counting

Definition at line 38 of file PaperSearch.inc.php.

---

Member Function Documentation

& PaperSearch._getMergedArray	(	&$	conference,
		&$	keywords,
		$	publishedFrom,
		$	publishedTo,
		&$	resultCount
	)

See implementation of retrieveResults for a description of this function.

Definition at line 105 of file PaperSearch.inc.php.

& PaperSearch._getMergedKeywordResults	(	&$	conference,
		&$	keyword,
		$	type,
		$	publishedFrom,
		$	publishedTo,
		$	resultsPerKeyword,
		$	resultCacheHours
	)

Recursive helper for _getMergedArray.

Definition at line 129 of file PaperSearch.inc.php.

& PaperSearch._getMergedPhraseResults	(	&$	conference,
		&$	phrase,
		$	type,
		$	publishedFrom,
		$	publishedTo,
		$	resultsPerKeyword,
		$	resultCacheHours
	)

Recursive helper for _getMergedArray.

Definition at line 183 of file PaperSearch.inc.php.

& PaperSearch._getSparseArray	(	&$	mergedResults,
		$	resultCount
	)

See implementation of retrieveResults for a description of this function.

Definition at line 216 of file PaperSearch.inc.php.

PaperSearch._parseQuery	(	$	signTokens,
		$	tokens,
		&$	pos,
		$	total
	)

Query parsing helper routine. Returned structure is based on that used by the Search.QueryParser Perl module.

Definition at line 57 of file PaperSearch.inc.php.

& PaperSearch.formatResults

(

&$

results

)

See implementation of retrieveResults for a description of this function. Note that this function is also called externally to fetch results for the title index, and possibly elsewhere.

Definition at line 233 of file PaperSearch.inc.php.

Referenced by NLMExportPlugin.display(), NativeImportExportPlugin.display(), NLMExportPlugin.executeCLI(), NativeImportExportPlugin.executeCLI(), and SearchHandler.titles().

PaperSearch.parseQuery

(

$

query

)

Parses a search query string. Supports +/-, AND/OR, parens

Parameters:

$query

Returns:

array of the form ('+' => <required>, '' => <optional>, '-' => excluded)

Definition at line 46 of file PaperSearch.inc.php.

Referenced by SearchHandler.advancedResults(), and SearchHandler.results().

& PaperSearch.retrieveResults	(	&$	conference,
		&$	keywords,
		$	publishedFrom = null,
		$	publishedTo = null,
		$	rangeInfo = null
	)

Return an array of search results matching the supplied keyword IDs in decreasing order of match quality. Keywords are supplied in an array of the following format: $keywords[PAPER_SEARCH_AUTHOR] = array('John', 'Doe'); $keywords[PAPER_SEARCH_...] = array(...); $keywords[null] = array('Matches', 'All', 'Fields');

Parameters:

	$conference	object The conference to search
	$keywords	array List of keywords
	$publishedFrom	object Search-from date
	$publishedTo	object Search-to date
	$rangeInfo	Information on the range of results to return

Definition at line 308 of file PaperSearch.inc.php.

Referenced by SearchHandler.advancedResults(), and SearchHandler.results().

---

The documentation for this class was generated from the following file:

• classes/search/PaperSearch.inc.php

---