The SolrDisMaxQuery class

Contents

(No version information available, might only be in Git)

Introduction

PHP: SolrDisMaxQuery - Manual Home of Manuel PHP Contents Haut

Class synopsis

SolrDisMaxQuery extends SolrQuery implements Serializable {

/* Inherited properties */

const integer SolrQuery::ORDER_ASC = 0 ;

const integer SolrQuery::ORDER_DESC = 1 ;

const integer SolrQuery::FACET_SORT_INDEX = 0 ;

const integer SolrQuery::FACET_SORT_COUNT = 1 ;

const integer SolrQuery::TERMS_SORT_INDEX = 0 ;

const integer SolrQuery::TERMS_SORT_COUNT = 1 ;

/* Methods */

public addBigramPhraseField ( string $field , string $boost [, string $slop ] ) : SolrDisMaxQuery

public addBoostQuery ( string $field , string $value [, string $boost ] ) : SolrDisMaxQuery

public addPhraseField ( string $field , string $boost [, string $slop ] ) : SolrDisMaxQuery

public addQueryField ( string $field [, string $boost ] ) : SolrDisMaxQuery

public addTrigramPhraseField ( string $field , string $boost [, string $slop ] ) : SolrDisMaxQuery

public addUserField ( string $field ) : SolrDisMaxQuery

public __construct ([ string $q ] )

public removeBigramPhraseField ( string $field ) : SolrDisMaxQuery

public removeBoostQuery ( string $field ) : SolrDisMaxQuery

public removePhraseField ( string $field ) : SolrDisMaxQuery

public removeQueryField ( string $field ) : SolrDisMaxQuery

public removeTrigramPhraseField ( string $field ) : SolrDisMaxQuery

public removeUserField ( string $field ) : SolrDisMaxQuery

public setBigramPhraseFields ( string $fields ) : SolrDisMaxQuery

public setBigramPhraseSlop ( string $slop ) : SolrDisMaxQuery

public setBoostFunction ( string $function ) : SolrDisMaxQuery

public setBoostQuery ( string $q ) : SolrDisMaxQuery

public setMinimumMatch ( string $value ) : SolrDisMaxQuery

public setPhraseFields ( string $fields ) : SolrDisMaxQuery

public setPhraseSlop ( string $slop ) : SolrDisMaxQuery

public setQueryAlt ( string $q ) : SolrDisMaxQuery

public setQueryPhraseSlop ( string $slop ) : SolrDisMaxQuery

public setTieBreaker ( string $tieBreaker ) : SolrDisMaxQuery

public setTrigramPhraseFields ( string $fields ) : SolrDisMaxQuery

public setTrigramPhraseSlop ( string $slop ) : SolrDisMaxQuery

public setUserFields ( string $fields ) : SolrDisMaxQuery

public useDisMaxQueryParser ( void ) : SolrDisMaxQuery

public useEDisMaxQueryParser ( void ) : SolrDisMaxQuery

/* Inherited methods */

public SolrQuery::addExpandFilterQuery ( string $fq ) : SolrQuery

public SolrQuery::addExpandSortField ( string $field [, string $order ] ) : SolrQuery

public SolrQuery::addFacetDateField ( string $dateField ) : SolrQuery

public SolrQuery::addFacetDateOther ( string $value [, string $field_override ] ) : SolrQuery

public SolrQuery::addFacetField ( string $field ) : SolrQuery

public SolrQuery::addFacetQuery ( string $facetQuery ) : SolrQuery

public SolrQuery::addField ( string $field ) : SolrQuery

public SolrQuery::addFilterQuery ( string $fq ) : SolrQuery

public SolrQuery::addGroupField ( string $value ) : SolrQuery

public SolrQuery::addGroupFunction ( string $value ) : SolrQuery

public SolrQuery::addGroupQuery ( string $value ) : SolrQuery

public SolrQuery::addGroupSortField ( string $field [, int $order ] ) : SolrQuery

public SolrQuery::addHighlightField ( string $field ) : SolrQuery

public SolrQuery::addMltField ( string $field ) : SolrQuery

public SolrQuery::addMltQueryField ( string $field , float $boost ) : SolrQuery

public SolrQuery::addSortField ( string $field [, int $order = SolrQuery::ORDER_DESC ] ) : SolrQuery

public SolrQuery::addStatsFacet ( string $field ) : SolrQuery

public SolrQuery::addStatsField ( string $field ) : SolrQuery

public SolrQuery::collapse ( SolrCollapseFunction $collapseFunction ) : SolrQuery

public SolrQuery::__construct ([ string $q ] )

public SolrQuery::__destruct ( void ) : void

public SolrQuery::getExpand ( void ) : bool

public SolrQuery::getExpandFilterQueries ( void ) : array

public SolrQuery::getExpandQuery ( void ) : array

public SolrQuery::getExpandRows ( void ) : int

public SolrQuery::getExpandSortFields ( void ) : array

public SolrQuery::getFacet ( void ) : bool

public SolrQuery::getFacetDateEnd ([ string $field_override ] ) : string

public SolrQuery::getFacetDateFields ( void ) : array

public SolrQuery::getFacetDateGap ([ string $field_override ] ) : string

public SolrQuery::getFacetDateHardEnd ([ string $field_override ] ) : string

public SolrQuery::getFacetDateOther ([ string $field_override ] ) : array

public SolrQuery::getFacetDateStart ([ string $field_override ] ) : string

public SolrQuery::getFacetFields ( void ) : array

public SolrQuery::getFacetLimit ([ string $field_override ] ) : int

public SolrQuery::getFacetMethod ([ string $field_override ] ) : string

public SolrQuery::getFacetMinCount ([ string $field_override ] ) : int

public SolrQuery::getFacetMissing ([ string $field_override ] ) : bool

public SolrQuery::getFacetOffset ([ string $field_override ] ) : int

public SolrQuery::getFacetPrefix ([ string $field_override ] ) : string

public SolrQuery::getFacetQueries ( void ) : array

public SolrQuery::getFacetSort ([ string $field_override ] ) : int

public SolrQuery::getFields ( void ) : array

public SolrQuery::getFilterQueries ( void ) : array

public SolrQuery::getGroup ( void ) : bool

public SolrQuery::getGroupCachePercent ( void ) : int

public SolrQuery::getGroupFacet ( void ) : bool

public SolrQuery::getGroupFields ( void ) : array

public SolrQuery::getGroupFormat ( void ) : string

public SolrQuery::getGroupFunctions ( void ) : array

public SolrQuery::getGroupLimit ( void ) : int

public SolrQuery::getGroupMain ( void ) : bool

public SolrQuery::getGroupNGroups ( void ) : bool

public SolrQuery::getGroupOffset ( void ) : int

public SolrQuery::getGroupQueries ( void ) : array

public SolrQuery::getGroupSortFields ( void ) : array

public SolrQuery::getGroupTruncate ( void ) : bool

public SolrQuery::getHighlight ( void ) : bool

public SolrQuery::getHighlightAlternateField ([ string $field_override ] ) : string

public SolrQuery::getHighlightFields ( void ) : array

public SolrQuery::getHighlightFormatter ([ string $field_override ] ) : string

public SolrQuery::getHighlightFragmenter ([ string $field_override ] ) : string

public SolrQuery::getHighlightFragsize ([ string $field_override ] ) : int

public SolrQuery::getHighlightHighlightMultiTerm ( void ) : bool

public SolrQuery::getHighlightMaxAlternateFieldLength ([ string $field_override ] ) : int

public SolrQuery::getHighlightMaxAnalyzedChars ( void ) : int

public SolrQuery::getHighlightMergeContiguous ([ string $field_override ] ) : bool

public SolrQuery::getHighlightRegexMaxAnalyzedChars ( void ) : int

public SolrQuery::getHighlightRegexPattern ( void ) : string

public SolrQuery::getHighlightRegexSlop ( void ) : float

public SolrQuery::getHighlightRequireFieldMatch ( void ) : bool

public SolrQuery::getHighlightSimplePost ([ string $field_override ] ) : string

public SolrQuery::getHighlightSimplePre ([ string $field_override ] ) : string

public SolrQuery::getHighlightSnippets ([ string $field_override ] ) : int

public SolrQuery::getHighlightUsePhraseHighlighter ( void ) : bool

public SolrQuery::getMlt ( void ) : bool

public SolrQuery::getMltBoost ( void ) : bool

public SolrQuery::getMltCount ( void ) : int

public SolrQuery::getMltFields ( void ) : array

public SolrQuery::getMltMaxNumQueryTerms ( void ) : int

public SolrQuery::getMltMaxNumTokens ( void ) : int

public SolrQuery::getMltMaxWordLength ( void ) : int

public SolrQuery::getMltMinDocFrequency ( void ) : int

public SolrQuery::getMltMinTermFrequency ( void ) : int

public SolrQuery::getMltMinWordLength ( void ) : int

public SolrQuery::getMltQueryFields ( void ) : array

public SolrQuery::getQuery ( void ) : string

public SolrQuery::getRows ( void ) : int

public SolrQuery::getSortFields ( void ) : array

public SolrQuery::getStart ( void ) : int

public SolrQuery::getStats ( void ) : bool

public SolrQuery::getStatsFacets ( void ) : array

public SolrQuery::getStatsFields ( void ) : array

public SolrQuery::getTerms ( void ) : bool

public SolrQuery::getTermsField ( void ) : string

public SolrQuery::getTermsIncludeLowerBound ( void ) : bool

public SolrQuery::getTermsIncludeUpperBound ( void ) : bool

public SolrQuery::getTermsLimit ( void ) : int

public SolrQuery::getTermsLowerBound ( void ) : string

public SolrQuery::getTermsMaxCount ( void ) : int

public SolrQuery::getTermsMinCount ( void ) : int

public SolrQuery::getTermsPrefix ( void ) : string

public SolrQuery::getTermsReturnRaw ( void ) : bool

public SolrQuery::getTermsSort ( void ) : int

public SolrQuery::getTermsUpperBound ( void ) : string

public SolrQuery::getTimeAllowed ( void ) : int

public SolrQuery::removeExpandFilterQuery ( string $fq ) : SolrQuery

public SolrQuery::removeExpandSortField ( string $field ) : SolrQuery

public SolrQuery::removeFacetDateField ( string $field ) : SolrQuery

public SolrQuery::removeFacetDateOther ( string $value [, string $field_override ] ) : SolrQuery

public SolrQuery::removeFacetField ( string $field ) : SolrQuery

public SolrQuery::removeFacetQuery ( string $value ) : SolrQuery

public SolrQuery::removeField ( string $field ) : SolrQuery

public SolrQuery::removeFilterQuery ( string $fq ) : SolrQuery

public SolrQuery::removeHighlightField ( string $field ) : SolrQuery

public SolrQuery::removeMltField ( string $field ) : SolrQuery

public SolrQuery::removeMltQueryField ( string $queryField ) : SolrQuery

public SolrQuery::removeSortField ( string $field ) : SolrQuery

public SolrQuery::removeStatsFacet ( string $value ) : SolrQuery

public SolrQuery::removeStatsField ( string $field ) : SolrQuery

public SolrQuery::setEchoHandler ( bool $flag ) : SolrQuery

public SolrQuery::setEchoParams ( string $type ) : SolrQuery

public SolrQuery::setExpand ( bool $value ) : SolrQuery

public SolrQuery::setExpandQuery ( string $q ) : SolrQuery

public SolrQuery::setExpandRows ( int $value ) : SolrQuery

public SolrQuery::setExplainOther ( string $query ) : SolrQuery

public SolrQuery::setFacet ( bool $flag ) : SolrQuery

public SolrQuery::setFacetDateEnd ( string $value [, string $field_override ] ) : SolrQuery

public SolrQuery::setFacetDateGap ( string $value [, string $field_override ] ) : SolrQuery

public SolrQuery::setFacetDateHardEnd ( bool $value [, string $field_override ] ) : SolrQuery

public SolrQuery::setFacetDateStart ( string $value [, string $field_override ] ) : SolrQuery

public SolrQuery::setFacetEnumCacheMinDefaultFrequency ( int $frequency [, string $field_override ] ) : SolrQuery

public SolrQuery::setFacetLimit ( int $limit [, string $field_override ] ) : SolrQuery

public SolrQuery::setFacetMethod ( string $method [, string $field_override ] ) : SolrQuery

public SolrQuery::setFacetMinCount ( int $mincount [, string $field_override ] ) : SolrQuery

public SolrQuery::setFacetMissing ( bool $flag [, string $field_override ] ) : SolrQuery

public SolrQuery::setFacetOffset ( int $offset [, string $field_override ] ) : SolrQuery

public SolrQuery::setFacetPrefix ( string $prefix [, string $field_override ] ) : SolrQuery

public SolrQuery::setFacetSort ( int $facetSort [, string $field_override ] ) : SolrQuery

public SolrQuery::setGroup ( bool $value ) : SolrQuery

public SolrQuery::setGroupCachePercent ( int $percent ) : SolrQuery

public SolrQuery::setGroupFacet ( bool $value ) : SolrQuery

public SolrQuery::setGroupFormat ( string $value ) : SolrQuery

public SolrQuery::setGroupLimit ( int $value ) : SolrQuery

public SolrQuery::setGroupMain ( string $value ) : SolrQuery

public SolrQuery::setGroupNGroups ( bool $value ) : SolrQuery

public SolrQuery::setGroupOffset ( int $value ) : SolrQuery

public SolrQuery::setGroupTruncate ( bool $value ) : SolrQuery

public SolrQuery::setHighlight ( bool $flag ) : SolrQuery

public SolrQuery::setHighlightAlternateField ( string $field [, string $field_override ] ) : SolrQuery

public SolrQuery::setHighlightFormatter ( string $formatter [, string $field_override ] ) : SolrQuery

public SolrQuery::setHighlightFragmenter ( string $fragmenter [, string $field_override ] ) : SolrQuery

public SolrQuery::setHighlightFragsize ( int $size [, string $field_override ] ) : SolrQuery

public SolrQuery::setHighlightHighlightMultiTerm ( bool $flag ) : SolrQuery

public SolrQuery::setHighlightMaxAlternateFieldLength ( int $fieldLength [, string $field_override ] ) : SolrQuery

public SolrQuery::setHighlightMaxAnalyzedChars ( int $value ) : SolrQuery

public SolrQuery::setHighlightMergeContiguous ( bool $flag [, string $field_override ] ) : SolrQuery

public SolrQuery::setHighlightRegexMaxAnalyzedChars ( int $maxAnalyzedChars ) : SolrQuery

public SolrQuery::setHighlightRegexPattern ( string $value ) : SolrQuery

public SolrQuery::setHighlightRegexSlop ( float $factor ) : SolrQuery

public SolrQuery::setHighlightRequireFieldMatch ( bool $flag ) : SolrQuery

public SolrQuery::setHighlightSimplePost ( string $simplePost [, string $field_override ] ) : SolrQuery

public SolrQuery::setHighlightSimplePre ( string $simplePre [, string $field_override ] ) : SolrQuery

public SolrQuery::setHighlightSnippets ( int $value [, string $field_override ] ) : SolrQuery

public SolrQuery::setHighlightUsePhraseHighlighter ( bool $flag ) : SolrQuery

public SolrQuery::setMlt ( bool $flag ) : SolrQuery

public SolrQuery::setMltBoost ( bool $flag ) : SolrQuery

public SolrQuery::setMltCount ( int $count ) : SolrQuery

public SolrQuery::setMltMaxNumQueryTerms ( int $value ) : SolrQuery

public SolrQuery::setMltMaxNumTokens ( int $value ) : SolrQuery

public SolrQuery::setMltMaxWordLength ( int $maxWordLength ) : SolrQuery

public SolrQuery::setMltMinDocFrequency ( int $minDocFrequency ) : SolrQuery

public SolrQuery::setMltMinTermFrequency ( int $minTermFrequency ) : SolrQuery

public SolrQuery::setMltMinWordLength ( int $minWordLength ) : SolrQuery

public SolrQuery::setOmitHeader ( bool $flag ) : SolrQuery

public SolrQuery::setQuery ( string $query ) : SolrQuery

public SolrQuery::setRows ( int $rows ) : SolrQuery

public SolrQuery::setShowDebugInfo ( bool $flag ) : SolrQuery

public SolrQuery::setStart ( int $start ) : SolrQuery

public SolrQuery::setStats ( bool $flag ) : SolrQuery

public SolrQuery::setTerms ( bool $flag ) : SolrQuery

public SolrQuery::setTermsField ( string $fieldname ) : SolrQuery

public SolrQuery::setTermsIncludeLowerBound ( bool $flag ) : SolrQuery

public SolrQuery::setTermsIncludeUpperBound ( bool $flag ) : SolrQuery

public SolrQuery::setTermsLimit ( int $limit ) : SolrQuery

public SolrQuery::setTermsLowerBound ( string $lowerBound ) : SolrQuery

public SolrQuery::setTermsMaxCount ( int $frequency ) : SolrQuery

public SolrQuery::setTermsMinCount ( int $frequency ) : SolrQuery

public SolrQuery::setTermsPrefix ( string $prefix ) : SolrQuery

public SolrQuery::setTermsReturnRaw ( bool $flag ) : SolrQuery

public SolrQuery::setTermsSort ( int $sortType ) : SolrQuery

public SolrQuery::setTermsUpperBound ( string $upperBound ) : SolrQuery

public SolrQuery::setTimeAllowed ( int $timeAllowed ) : SolrQuery

}

PHP: SolrDisMaxQuery - Manual Home of Manuel PHP Contents Haut

Predefined Constants

SolrDisMaxQuery::ORDER_ASC: Used to specify that the sorting should be in acending order (Duplicated for easier migration)
SolrDisMaxQuery::ORDER_DESC: Used to specify that the sorting should be in descending order (Duplicated for easier migration)
SolrDisMaxQuery::FACET_SORT_INDEX: Used to specify that the facet should sort by index (Duplicated for easier migration)
SolrDisMaxQuery::FACET_SORT_COUNT: Used to specify that the facet should sort by count (Duplicated for easier migration)
SolrDisMaxQuery::TERMS_SORT_INDEX: Used in the TermsComponent (Duplicated for easier migration)
SolrDisMaxQuery::TERMS_SORT_COUNT: Used in the TermsComponent (Duplicated for easier migration)

PHP: SolrDisMaxQuery - Manual Home of Manuel PHP Contents Haut

SolrDisMaxQuery::addBigramPhraseField — Adds a Phrase Bigram Field (pf2 parameter)
SolrDisMaxQuery::addBoostQuery — Adds a boost query field with value and optional boost (bq parameter)
SolrDisMaxQuery::addPhraseField — Adds a Phrase Field (pf parameter)
SolrDisMaxQuery::addQueryField — Add a query field with optional boost (qf parameter)
SolrDisMaxQuery::addTrigramPhraseField — Adds a Trigram Phrase Field (pf3 parameter)
SolrDisMaxQuery::addUserField — Adds a field to User Fields Parameter (uf)
SolrDisMaxQuery::__construct — Class Constructor
SolrDisMaxQuery::removeBigramPhraseField — Removes phrase bigram field (pf2 parameter)
SolrDisMaxQuery::removeBoostQuery — Removes a boost query partial by field name (bq)
SolrDisMaxQuery::removePhraseField — Removes a Phrase Field (pf parameter)
SolrDisMaxQuery::removeQueryField — Removes a Query Field (qf parameter)
SolrDisMaxQuery::removeTrigramPhraseField — Removes a Trigram Phrase Field (pf3 parameter)
SolrDisMaxQuery::removeUserField — Removes a field from The User Fields Parameter (uf)
SolrDisMaxQuery::setBigramPhraseFields — Sets Bigram Phrase Fields and their boosts (and slops) using pf2 parameter
SolrDisMaxQuery::setBigramPhraseSlop — Sets Bigram Phrase Slop (ps2 parameter)
SolrDisMaxQuery::setBoostFunction — Sets a Boost Function (bf parameter)
SolrDisMaxQuery::setBoostQuery — Directly Sets Boost Query Parameter (bq)
SolrDisMaxQuery::setMinimumMatch — Set Minimum "Should" Match (mm)
SolrDisMaxQuery::setPhraseFields — Sets Phrase Fields and their boosts (and slops) using pf2 parameter
SolrDisMaxQuery::setPhraseSlop — Sets the default slop on phrase queries (ps parameter)
SolrDisMaxQuery::setQueryAlt — Set Query Alternate (q.alt parameter)
SolrDisMaxQuery::setQueryPhraseSlop — Specifies the amount of slop permitted on phrase queries explicitly included in the user's query string (qf parameter)
SolrDisMaxQuery::setTieBreaker — Sets Tie Breaker parameter (tie parameter)
SolrDisMaxQuery::setTrigramPhraseFields — Directly Sets Trigram Phrase Fields (pf3 parameter)
SolrDisMaxQuery::setTrigramPhraseSlop — Sets Trigram Phrase Slop (ps3 parameter)
SolrDisMaxQuery::setUserFields — Sets User Fields parameter (uf)
SolrDisMaxQuery::useDisMaxQueryParser — Switch QueryParser to be DisMax Query Parser
SolrDisMaxQuery::useEDisMaxQueryParser — Switch QueryParser to be EDisMax

Find a PHP function

English translation

You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.

If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.

Thank you in advance.

Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-class.solrdismaxquery.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

Manuel PHP : http://php.net

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.

Contents Haut

The SolrDisMaxQuery class

Introduction

Class synopsis

Predefined Constants

Table of Contents

References