PHP 클래스 SolrSearchRequest, ojs

파일 보기 프로젝트 열기: pkp/ojs 1 사용 예제들

공개 프로퍼티들

프로퍼티 타입 설명
$_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.

공개 메소드들

메소드 설명
__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

메소드 상세

__construct() 공개 메소드

Constructor
public __construct ( )

addBoostFactor() 공개 메소드

Set the boost factor for a field/value combination.
public addBoostFactor ( $field, $value, $boostFactor )
$field string
$value string
$boostFactor float

addBoostField() 공개 메소드

with the internal ranking score.
public addBoostField ( $field )
$field string

addQueryFieldPhrase() 공개 메소드

Set the search phrase for a field.
public addQueryFieldPhrase ( $field, $searchPhrase )
$field string
$searchPhrase string

addQueryFromKeywords() 공개 메소드

Configure the search request from a keywords array as required by SubmissionSearch::retrieveResults()
public addQueryFromKeywords ( $keywords )
$keywords array See SubmissionSearch::retrieveResults()

getBoostFactors() 공개 메소드

Get boost factors.
public getBoostFactors ( ) : array
리턴 array A field -> value -> boost factor assignment

getBoostFields() 공개 메소드

Get boost fields.
public getBoostFields ( ) : array
리턴 array A list of fields containing boost factors to be multiplied with the internal ranking score.

getExcludedIds() 공개 메소드

Get the list of excluded unique IDs.
public getExcludedIds ( ) : array
리턴 array

getFacetCategories() 공개 메소드

For which categories should faceting be enabled?
public getFacetCategories ( ) : array
리턴 array

getFromDate() 공개 메소드

Get the first publication date
public getFromDate ( ) : string
리턴 string

getHighlighting() 공개 메소드

Is highlighting enabled?
public getHighlighting ( ) : boolean
리턴 boolean

getItemsPerPage() 공개 메소드

Get the items per page.
public getItemsPerPage ( ) : integer
리턴 integer

getJournal() 공개 메소드

Get the journal to be queried.
public getJournal ( ) : Journal
리턴 Journal

getOrderBy() 공개 메소드

Get the result ordering criteria
public getOrderBy ( ) : string
리턴 string

getOrderDir() 공개 메소드

Get the result ordering direction
public getOrderDir ( ) : boolean
리턴 boolean

getPage() 공개 메소드

Get the page.
public getPage ( ) : integer
리턴 integer

getQuery() 공개 메소드

Get fieldwise search phrases.
public getQuery ( ) : array
리턴 array A field -> search phrase assignment

getSpellcheck() 공개 메소드

Is spellchecking enabled?
public getSpellcheck ( ) : boolean
리턴 boolean

getToDate() 공개 메소드

Get the last publication date
public getToDate ( ) : string
리턴 string

setBoostFactors() 공개 메소드

Set boost factors.
public setBoostFactors ( $boostFactors )

setBoostFields() 공개 메소드

Set boost fields.
public setBoostFields ( $boostFields )
$boostFields array A list of fields containing boost factors to be multiplied with the internal ranking score.

setExcludedIds() 공개 메소드

Set a list of unique IDs to exclude from the search result.
public setExcludedIds ( $excludedIds )
$excludedIds array

setFacetCategories() 공개 메소드

Set the categories for which faceting should be enabled.
public setFacetCategories ( $facetCategories )
$facetCategories boolean

setFromDate() 공개 메소드

Set the first publication date
public setFromDate ( $fromDate )
$fromDate string

setHighlighting() 공개 메소드

Set whether highlighting should be enabled.
public setHighlighting ( $highlighting )
$highlighting boolean

setItemsPerPage() 공개 메소드

Set the items per page
public setItemsPerPage ( $itemsPerPage )
$itemsPerPage integer

setJournal() 공개 메소드

Set the journal to be queried
public setJournal ( &$journal )
$journal Journal

setOrderBy() 공개 메소드

Set the result ordering criteria
public setOrderBy ( $orderBy )
$orderBy string

setOrderDir() 공개 메소드

Set the result ordering direction
public setOrderDir ( $orderDir )
$orderDir boolean

setPage() 공개 메소드

Set the page
public setPage ( $page )
$page integer

setQuery() 공개 메소드

Set fieldwise search phrases.
public setQuery ( $query )
$query array A field -> search phrase assignment

setSpellcheck() 공개 메소드

Set whether spellchecking should be enabled.
public setSpellcheck ( $spellcheck )
$spellcheck boolean

setToDate() 공개 메소드

Set the last publication date
public setToDate ( $toDate )
$toDate string

프로퍼티 상세

$_boostFactors 공개적으로 프로퍼티

A field->value->boost factor assignment.
public $_boostFactors

$_boostFields 공개적으로 프로퍼티

Fields with multiplicative boost values.
public $_boostFields

$_excludedIds 공개적으로 프로퍼티

An array of unique IDs to exclude.
public $_excludedIds

$_facetCategories 공개적으로 프로퍼티

Enabled facet categories (none by default).
public $_facetCategories

$_fromDate 공개적으로 프로퍼티

Timestamp representing the first publication date to be included in the result set. Null means: No limitation.
public $_fromDate

$_highlighting 공개적으로 프로퍼티

Whether to enable highlighting.
public $_highlighting

$_itemsPerPage 공개적으로 프로퍼티

For paginated queries: The items per page.
public $_itemsPerPage

$_journal 공개적으로 프로퍼티

The journal to be queried. All journals of an OJS instance will be queried if no journal is given.
public $_journal

$_orderBy 공개적으로 프로퍼티

Result set ordering. Can be any index field or the pseudo- field "score" for ordering by relevance.
public $_orderBy

$_orderDir 공개적으로 프로퍼티

Result set ordering direction. Can be 'true' for ascending or 'false' for descending order.
public $_orderDir

$_page 공개적으로 프로퍼티

For paginated queries: The page to be returned.
public $_page

$_query 공개적으로 프로퍼티

A field->search phrase assignment defining fieldwise search phrases.
public $_query

$_spellcheck 공개적으로 프로퍼티

Whether to enable spell checking.
public $_spellcheck

$_toDate 공개적으로 프로퍼티

Timestamp representing the last publication date to be included in the result set. Null means: No limitation.
public $_toDate