| Property | Type | Description | |
|---|---|---|---|
| $_boostFactors | A field->value->boost factor assignment. | ||
| $_boostFields | Fields with multiplicative boost values. | ||
| $_excludedIds | An array of unique IDs to exclude. | ||
| $_facetCategories | Enabled facet categories (none by default). | ||
| $_fromDate | Timestamp representing the first publication date to be included in the result set. Null means: No limitation. | ||
| $_highlighting | Whether to enable highlighting. | ||
| $_itemsPerPage | For paginated queries: The items per page. | ||
| $_journal | The journal to be queried. All journals of an OJS instance will be queried if no journal is given. | ||
| $_orderBy | Result set ordering. Can be any index field or the pseudo- field "score" for ordering by relevance. | ||
| $_orderDir | Result set ordering direction. Can be 'true' for ascending or 'false' for descending order. | ||
| $_page | For paginated queries: The page to be returned. | ||
| $_query | A field->search phrase assignment defining fieldwise search phrases. | ||
| $_spellcheck | Whether to enable spell checking. | ||
| $_toDate | Timestamp representing the last publication date to be included in the result set. Null means: No limitation. |
| Method | Description | |
|---|---|---|
| __construct ( ) | Constructor | |
| addBoostFactor ( $field, $value, $boostFactor ) | Set the boost factor for a field/value combination. | |
| addBoostField ( $field ) | A field containing boost factors to be multiplied. | |
| addQueryFieldPhrase ( $field, $searchPhrase ) | Set the search phrase for a field. | |
| addQueryFromKeywords ( $keywords ) | Configure the search request from a keywords array as required by SubmissionSearch::retrieveResults() | |
| getBoostFactors ( ) : array | Get boost factors. | |
| getBoostFields ( ) : array | Get boost fields. | |
| getExcludedIds ( ) : array | Get the list of excluded unique IDs. | |
| getFacetCategories ( ) : array | For which categories should faceting be enabled? | |
| getFromDate ( ) : string | Get the first publication date | |
| getHighlighting ( ) : boolean | Is highlighting enabled? | |
| getItemsPerPage ( ) : integer | Get the items per page. | |
| getJournal ( ) : Journal | Get the journal to be queried. | |
| getOrderBy ( ) : string | Get the result ordering criteria | |
| getOrderDir ( ) : boolean | Get the result ordering direction | |
| getPage ( ) : integer | Get the page. | |
| getQuery ( ) : array | Get fieldwise search phrases. | |
| getSpellcheck ( ) : boolean | Is spellchecking enabled? | |
| getToDate ( ) : string | Get the last publication date | |
| setBoostFactors ( $boostFactors ) | Set boost factors. | |
| setBoostFields ( $boostFields ) | Set boost fields. | |
| setExcludedIds ( $excludedIds ) | Set a list of unique IDs to exclude from the search result. | |
| setFacetCategories ( $facetCategories ) | Set the categories for which faceting should be enabled. | |
| setFromDate ( $fromDate ) | Set the first publication date | |
| setHighlighting ( $highlighting ) | Set whether highlighting should be enabled. | |
| setItemsPerPage ( $itemsPerPage ) | Set the items per page | |
| setJournal ( &$journal ) | Set the journal to be queried | |
| setOrderBy ( $orderBy ) | Set the result ordering criteria | |
| setOrderDir ( $orderDir ) | Set the result ordering direction | |
| setPage ( $page ) | Set the page | |
| setQuery ( $query ) | Set fieldwise search phrases. | |
| setSpellcheck ( $spellcheck ) | Set whether spellchecking should be enabled. | |
| setToDate ( $toDate ) | Set the last publication date |
| public addBoostFactor ( $field, $value, $boostFactor ) | ||
| $field | string | |
| $value | string | |
| $boostFactor | float | |
| public addBoostField ( $field ) | ||
| $field | string | |
| public addQueryFieldPhrase ( $field, $searchPhrase ) | ||
| $field | string | |
| $searchPhrase | string | |
| public addQueryFromKeywords ( $keywords ) | ||
| $keywords | array See SubmissionSearch::retrieveResults() | |
| public getBoostFactors ( ) : array | ||
| return | array | A field -> value -> boost factor assignment |
| public getBoostFields ( ) : array | ||
| return | array | A list of fields containing boost factors to be multiplied with the internal ranking score. |
| public getExcludedIds ( ) : array | ||
| return | array | |
| public getFacetCategories ( ) : array | ||
| return | array | |
| public getFromDate ( ) : string | ||
| return | string | |
| public getHighlighting ( ) : boolean | ||
| return | boolean | |
| public getItemsPerPage ( ) : integer | ||
| return | integer | |
| public getJournal ( ) : Journal | ||
| return | Journal | |
| public getOrderBy ( ) : string | ||
| return | string | |
| public getOrderDir ( ) : boolean | ||
| return | boolean | |
| public getSpellcheck ( ) : boolean | ||
| return | boolean | |
| public setBoostFields ( $boostFields ) | ||
| $boostFields | array A list of fields containing boost factors to be multiplied with the internal ranking score. | |
| public setExcludedIds ( $excludedIds ) | ||
| $excludedIds | array | |
| public setFacetCategories ( $facetCategories ) | ||
| $facetCategories | boolean | |
| public setFromDate ( $fromDate ) | ||
| $fromDate | string | |
| public setHighlighting ( $highlighting ) | ||
| $highlighting | boolean | |
| public setItemsPerPage ( $itemsPerPage ) | ||
| $itemsPerPage | integer | |
| public setJournal ( &$journal ) | ||
| $journal | Journal | |
| public setOrderBy ( $orderBy ) | ||
| $orderBy | string | |
| public setOrderDir ( $orderDir ) | ||
| $orderDir | boolean | |
| public setQuery ( $query ) | ||
| $query | array A field -> search phrase assignment | |
| public setSpellcheck ( $spellcheck ) | ||
| $spellcheck | boolean | |
| public $_facetCategories |
| public $_fromDate |
| public $_journal |
| public $_orderBy |
| public $_orderDir |
| public $_query |