MonographSearch Class Reference

Class for retrieving monograph search results. More...

List of all members.

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

---

Detailed Description

Class for retrieving monograph search results.

See also:

MonographSearchDAO

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

Definition at line 34 of file MonographSearch.inc.php.

---

Member Function Documentation

& MonographSearch._getMergedArray	(	&$	press,
		&$	keywords,
		$	publishedFrom,
		$	publishedTo,
		&$	resultCount
	)

See implementation of retrieveResults for a description of this function.

Definition at line 101 of file MonographSearch.inc.php.

References _getMergedKeywordResults().

Referenced by retrieveResults().

& MonographSearch._getMergedArray	(	&$	press,
		&$	keywords,
		$	publishedFrom,
		$	publishedTo,
		&$	resultCount
	)

See implementation of retrieveResults for a description of this function.

Definition at line 101 of file MonographSearch.inc.php.

References _getMergedKeywordResults().

& MonographSearch._getMergedKeywordResults	(	&$	press,
		&$	keyword,
		$	type,
		$	publishedFrom,
		$	publishedTo,
		$	resultsPerKeyword,
		$	resultCacheHours
	)

Recursive helper for _getMergedArray.

Definition at line 125 of file MonographSearch.inc.php.

References _getMergedPhraseResults().

Referenced by _getMergedArray(), and _getMergedPhraseResults().

& MonographSearch._getMergedKeywordResults	(	&$	press,
		&$	keyword,
		$	type,
		$	publishedFrom,
		$	publishedTo,
		$	resultsPerKeyword,
		$	resultCacheHours
	)

Recursive helper for _getMergedArray.

Definition at line 125 of file MonographSearch.inc.php.

References _getMergedPhraseResults().

& MonographSearch._getMergedPhraseResults	(	&$	press,
		&$	phrase,
		$	type,
		$	publishedFrom,
		$	publishedTo,
		$	resultsPerKeyword,
		$	resultCacheHours
	)

Recursive helper for _getMergedArray.

Definition at line 179 of file MonographSearch.inc.php.

References _getMergedKeywordResults().

Referenced by _getMergedKeywordResults().

& MonographSearch._getMergedPhraseResults	(	&$	press,
		&$	phrase,
		$	type,
		$	publishedFrom,
		$	publishedTo,
		$	resultsPerKeyword,
		$	resultCacheHours
	)

Recursive helper for _getMergedArray.

Definition at line 179 of file MonographSearch.inc.php.

References _getMergedKeywordResults().

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

See implementation of retrieveResults for a description of this function.

Definition at line 212 of file MonographSearch.inc.php.

Referenced by retrieveResults().

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

See implementation of retrieveResults for a description of this function.

Definition at line 212 of file MonographSearch.inc.php.

MonographSearch._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 53 of file MonographSearch.inc.php.

References _parseQuery(), and MonographSearchIndex.filterKeywords().

MonographSearch._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 53 of file MonographSearch.inc.php.

References MonographSearchIndex.filterKeywords().

Referenced by _parseQuery(), and parseQuery().

& MonographSearch.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 229 of file MonographSearch.inc.php.

Referenced by retrieveResults().

& MonographSearch.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 229 of file MonographSearch.inc.php.

MonographSearch.parseQuery

(

$

query

)

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

Parameters:

$query

Returns:

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

Definition at line 42 of file MonographSearch.inc.php.

References _parseQuery().

MonographSearch.parseQuery

(

$

query

)

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

Parameters:

$query

Returns:

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

Definition at line 42 of file MonographSearch.inc.php.

References _parseQuery().

Referenced by CatalogHandler.results().

& MonographSearch.retrieveResults	(	&$	press,
		&$	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[MONOGRAPH_SEARCH_AUTHOR] = array('John', 'Doe'); $keywords[MONOGRAPH_SEARCH_...] = array(...); $keywords[null] = array('Matches', 'All', 'Fields');

Parameters:

	$press	object The press 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 288 of file MonographSearch.inc.php.

References _getMergedArray(), _getSparseArray(), and formatResults().

Referenced by CatalogHandler.results().

& MonographSearch.retrieveResults	(	&$	press,
		&$	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[MONOGRAPH_SEARCH_AUTHOR] = array('John', 'Doe'); $keywords[MONOGRAPH_SEARCH_...] = array(...); $keywords[null] = array('Matches', 'All', 'Fields');

Parameters:

	$press	object The press 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 288 of file MonographSearch.inc.php.

References _getMergedArray(), _getSparseArray(), and formatResults().

---

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

• classes/search/MonographSearch.inc.php
• omp.JipGdx/omp-1.0b/classes/search/MonographSearch.inc.php