Public Member Functions | |
| formatResults ($results, $user=null) | |
| getDefaultOrderDir ($orderBy) | |
| getIndexFieldMap () | |
| getKeywordsFromSearchFilters ($searchFilters) | |
| getResultSetOrderingOptions ($request) | |
| getSearchFilters ($request) | |
| 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 monograph search results.
- See also
- MonographSearchDAO
Definition at line 20 of file MonographSearch.inc.php.
Member Function Documentation
◆ formatResults()
| MonographSearch::formatResults | ( | $results, | |
$user = null |
|||
| ) |
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.
- Parameters
-
$results array $user User optional (if availability information is desired)
- Returns
- array
Reimplemented from SubmissionSearch.
Definition at line 227 of file MonographSearch.inc.php.
References PKPServices\get(), Application\getContextDAO(), and DAORegistry\getDAO().
◆ getDefaultOrderDir()
| MonographSearch::getDefaultOrderDir | ( | $orderBy | ) |
See SubmissionSearch::getDefaultOrderDir()
Reimplemented from SubmissionSearch.
Definition at line 323 of file MonographSearch.inc.php.
◆ getIndexFieldMap()
| MonographSearch::getIndexFieldMap | ( | ) |
Definition at line 272 of file MonographSearch.inc.php.
Referenced by getKeywordsFromSearchFilters().
◆ getKeywordsFromSearchFilters()
| MonographSearch::getKeywordsFromSearchFilters | ( | $searchFilters | ) |
Load the keywords array from a given search filter.
- Parameters
-
$searchFilters array Search filters as returned from MonographSearch::getSearchFilters()
- Returns
- array Keyword array as required by SubmissionSearch::retrieveResults()
Definition at line 209 of file MonographSearch.inc.php.
References getIndexFieldMap().
◆ getResultSetOrderingOptions()
| MonographSearch::getResultSetOrderingOptions | ( | $request | ) |
See SubmissionSearch::getResultSetOrderingOptions()
Reimplemented from SubmissionSearch.
Definition at line 289 of file MonographSearch.inc.php.
References $application, HookRegistry\call(), and PKPApplication\get().
◆ getSearchDao()
|
protected |
Return the search DAO
- Returns
- DAO
Reimplemented from SubmissionSearch.
Definition at line 335 of file MonographSearch.inc.php.
References DAORegistry\getDAO().
◆ getSearchFilters()
| MonographSearch::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 MonographSearch.inc.php.
References Application\getContextDAO().
◆ getSparseArray()
| MonographSearch::getSparseArray | ( | $unorderedResults, | |
| $orderBy, | |||
| $orderDir, | |||
| $exclude | |||
| ) |
See SubmissionSearch::getSparseArray()
Reimplemented from SubmissionSearch.
Definition at line 24 of file MonographSearch.inc.php.
References $application, PKPApplication\get(), Application\getContextDAO(), and DAORegistry\getDAO().
The documentation for this class was generated from the following file:
