ArticleSearch Class Reference

Inheritance diagram for ArticleSearch:

Public Member Functions
	formatResults ($results, $user=null)
	getDefaultOrderDir ($orderBy)
	getIndexFieldMap ()
	getKeywordsFromSearchFilters ($searchFilters)
	getResultSetOrderingOptions ($request)
	getSearchFilters ($request)
	getSimilarityTerms ($submissionId)
	getSparseArray ($unorderedResults, $orderBy, $orderDir, $exclude)
Public Member Functions inherited from SubmissionSearch
	__construct ()
	_getMergedArray ($context, &$keywords, $publishedFrom, $publishedTo)
	_getMergedKeywordResults ($context, &$keyword, $type, $publishedFrom, $publishedTo, $resultsPerKeyword, $resultCacheHours)
	_getMergedPhraseResults ($context, &$phrase, $type, $publishedFrom, $publishedTo, $resultsPerKeyword, $resultCacheHours)
	_parseQuery ($query)
	_parseQueryInternal ($signTokens, $tokens, &$pos, $total)
	getResultSetOrdering ($request)
	getResultSetOrderingDirectionOptions ()
	retrieveResults ($request, $context, $keywords, &$error, $publishedFrom=null, $publishedTo=null, $rangeInfo=null, $exclude=array())

Protected Member Functions
	getSearchDao ()

Detailed Description

Class for retrieving article search results.

See also

ArticleSearchDAO

Definition at line 20 of file ArticleSearch.inc.php.

Member Function Documentation

formatResults()

ArticleSearch::formatResults	(		$results,
			$user = null
	)

See SubmissionSearch::formatResults()

Parameters

$results	array
$user	User optional (if availability information is desired)

Returns

array An array with the articles, published submissions, journal, section.

Reimplemented from SubmissionSearch.

Definition at line 231 of file ArticleSearch.inc.php.

References PKPServices\get(), Application\getContextDAO(), and DAORegistry\getDAO().

getDefaultOrderDir()

ArticleSearch::getDefaultOrderDir

(

$orderBy

)

See SubmissionSearch::getDefaultOrderDir()

Reimplemented from SubmissionSearch.

Definition at line 354 of file ArticleSearch.inc.php.

getIndexFieldMap()

ArticleSearch::getIndexFieldMap

(

)

Definition at line 304 of file ArticleSearch.inc.php.

Referenced by getKeywordsFromSearchFilters().

getKeywordsFromSearchFilters()

ArticleSearch::getKeywordsFromSearchFilters

(

$searchFilters

)

Load the keywords array from a given search filter.

Parameters

$searchFilters

array Search filters as returned from ArticleSearch::getSearchFilters()

Returns

array Keyword array as required by SubmissionSearch::retrieveResults()

Definition at line 208 of file ArticleSearch.inc.php.

References getIndexFieldMap().

getResultSetOrderingOptions()

ArticleSearch::getResultSetOrderingOptions

(

$request

)

See SubmissionSearch::getResultSetOrderingOptions()

Reimplemented from SubmissionSearch.

Definition at line 320 of file ArticleSearch.inc.php.

References HookRegistry\call(), and PKPApplication\get().

getSearchDao()

ArticleSearch::getSearchDao ( )

protected

See SubmissionSearch::getSearchDao()

Reimplemented from SubmissionSearch.

Definition at line 365 of file ArticleSearch.inc.php.

References DAORegistry\getDAO().

getSearchFilters()

ArticleSearch::getSearchFilters

(

$request

)

Retrieve the search filters from the request.

Parameters

$request

Request

Returns

array All search filters (empty and active)

Definition at line 146 of file ArticleSearch.inc.php.

References Application\getContextDAO().

getSimilarityTerms()

ArticleSearch::getSimilarityTerms

(

$submissionId

)

Identify similarity terms for a given submission.

Parameters

$submissionId

integer

Returns

null|array An array of string keywords or null if some kind of error occurred.

Definition at line 281 of file ArticleSearch.inc.php.

References HookRegistry\call(), PKPServices\get(), DAORegistry\getDAO(), AppLocale\getLocale(), and AppLocale\getPrimaryLocale().

getSparseArray()

ArticleSearch::getSparseArray	(		$unorderedResults,
			$orderBy,
			$orderDir,
			$exclude
	)

See SubmissionSearch::getSparseArray()

Reimplemented from SubmissionSearch.

Definition at line 24 of file ArticleSearch.inc.php.

References PKPApplication\get(), Application\getContextDAO(), and DAORegistry\getDAO().

---

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

• ArticleSearch.inc.php