SolrModifiableParams::__destruct
SolrQuery::addFacetDateField
Solr
PHP Manual

# The SolrQuery class

(PECL solr >= 0.9.2)

## Introduction

Represents a collection of name-value pairs sent to the Solr server during a request.

## Class synopsis

SolrQuery extends SolrModifiableParams implements Serializable {
/* Constants */
const integer ORDER_ASC = 0 ;
const integer ORDER_DESC = 1 ;
const integer FACET_SORT_INDEX = 0 ;
const integer FACET_SORT_COUNT = 1 ;
const integer TERMS_SORT_INDEX = 0 ;
const integer TERMS_SORT_COUNT = 1 ;
/* Properties */
/* Methods */
public SolrQuery addFacetDateField ( string `$dateField` )
public SolrQuery addFacetDateOther ( string `$value` [, string `$field_override` ] )
public SolrQuery addFacetField ( string `$field` )
public SolrQuery addFacetQuery ( string `$facetQuery` )
public SolrQuery addField ( string `$field` )
public SolrQuery addFilterQuery ( string `$fq` )
public SolrQuery addHighlightField ( string `$field` )
public SolrQuery addMltField ( string `$field` )
public SolrQuery addMltQueryField ( string `$field` , float `$boost` )
public SolrQuery addSortField ( string `$field` [, int `$order` = SolrQuery::ORDER_DESC ] )
public SolrQuery addStatsFacet ( string `$field` )
public SolrQuery addStatsField ( string `$field` )
public __construct ([ string `$q` ] )
public void __destruct ( void )
public bool getFacet ( void )
public string getFacetDateEnd ([ string `$field_override` ] )
public array getFacetDateFields ( void )
public string getFacetDateGap ([ string `$field_override` ] )
public string getFacetDateHardEnd ([ string `$field_override` ] )
public array getFacetDateOther ([ string `$field_override` ] )
public string getFacetDateStart ([ string `$field_override` ] )
public array getFacetFields ( void )
public int getFacetLimit ([ string `$field_override` ] )
public string getFacetMethod ([ string `$field_override` ] )
public int getFacetMinCount ([ string `$field_override` ] )
public bool getFacetMissing ([ string `$field_override` ] )
public int getFacetOffset ([ string `$field_override` ] )
public string getFacetPrefix ([ string `$field_override` ] )
public array getFacetQueries ( void )
public int getFacetSort ([ string `$field_override` ] )
public array getFields ( void )
public array getFilterQueries ( void )
public bool getHighlight ( void )
public string getHighlightAlternateField ([ string `$field_override` ] )
public array getHighlightFields ( void )
public string getHighlightFormatter ([ string `$field_override` ] )
public string getHighlightFragmenter ([ string `$field_override` ] )
public int getHighlightFragsize ([ string `$field_override` ] )
public bool getHighlightHighlightMultiTerm ( void )
public int getHighlightMaxAlternateFieldLength ([ string `$field_override` ] )
public int getHighlightMaxAnalyzedChars ( void )
public bool getHighlightMergeContiguous ([ string `$field_override` ] )
public int getHighlightRegexMaxAnalyzedChars ( void )
public string getHighlightRegexPattern ( void )
public float getHighlightRegexSlop ( void )
public bool getHighlightRequireFieldMatch ( void )
public string getHighlightSimplePost ([ string `$field_override` ] )
public string getHighlightSimplePre ([ string `$field_override` ] )
public int getHighlightSnippets ([ string `$field_override` ] )
public bool getHighlightUsePhraseHighlighter ( void )
public bool getMlt ( void )
public bool getMltBoost ( void )
public int getMltCount ( void )
public array getMltFields ( void )
public int getMltMaxNumQueryTerms ( void )
public int getMltMaxNumTokens ( void )
public int getMltMaxWordLength ( void )
public int getMltMinDocFrequency ( void )
public int getMltMinTermFrequency ( void )
public int getMltMinWordLength ( void )
public array getMltQueryFields ( void )
public string getQuery ( void )
public int getRows ( void )
public array getSortFields ( void )
public int getStart ( void )
public bool getStats ( void )
public array getStatsFacets ( void )
public array getStatsFields ( void )
public bool getTerms ( void )
public string getTermsField ( void )
public bool getTermsIncludeLowerBound ( void )
public bool getTermsIncludeUpperBound ( void )
public int getTermsLimit ( void )
public string getTermsLowerBound ( void )
public int getTermsMaxCount ( void )
public int getTermsMinCount ( void )
public string getTermsPrefix ( void )
public bool getTermsReturnRaw ( void )
public int getTermsSort ( void )
public string getTermsUpperBound ( void )
public int getTimeAllowed ( void )
public SolrQuery removeFacetDateField ( string `$field` )
public SolrQuery removeFacetDateOther ( string `$value` [, string `$field_override` ] )
public SolrQuery removeFacetField ( string `$field` )
public SolrQuery removeFacetQuery ( string `$value` )
public SolrQuery removeField ( string `$field` )
public SolrQuery removeFilterQuery ( string `$fq` )
public SolrQuery removeHighlightField ( string `$field` )
public SolrQuery removeMltField ( string `$field` )
public SolrQuery removeMltQueryField ( string `$queryField` )
public SolrQuery removeSortField ( string `$field` )
public SolrQuery removeStatsFacet ( string `$value` )
public SolrQuery removeStatsField ( string `$field` )
public SolrQuery setEchoHandler ( bool `$flag` )
public SolrQuery setEchoParams ( string `$type` )
public SolrQuery setExplainOther ( string `$query` )
public SolrQuery setFacet ( bool `$flag` )
public SolrQuery setFacetDateEnd ( string `$value` [, string `$field_override` ] )
public SolrQuery setFacetDateGap ( string `$value` [, string `$field_override` ] )
public SolrQuery setFacetDateHardEnd ( bool `$value` [, string `$field_override` ] )
public SolrQuery setFacetDateStart ( string `$value` [, string `$field_override` ] )
public SolrQuery setFacetEnumCacheMinDefaultFrequency ( int `$frequency` [, string `$field_override` ] )
public SolrQuery setFacetLimit ( int `$limit` [, string `$field_override` ] )
public SolrQuery setFacetMethod ( string `$method` [, string `$field_override` ] )
public SolrQuery setFacetMinCount ( int `$mincount` [, string `$field_override` ] )
public SolrQuery setFacetMissing ( bool `$flag` [, string `$field_override` ] )
public SolrQuery setFacetOffset ( int `$offset` [, string `$field_override` ] )
public SolrQuery setFacetPrefix ( string `$prefix` [, string `$field_override` ] )
public SolrQuery setFacetSort ( int `$facetSort` [, string `$field_override` ] )
public SolrQuery setHighlight ( bool `$flag` )
public SolrQuery setHighlightAlternateField ( string `$field` [, string `$field_override` ] )
public SolrQuery setHighlightFormatter ( string `$formatter` [, string `$field_override` ] )
public SolrQuery setHighlightFragmenter ( string `$fragmenter` [, string `$field_override` ] )
public SolrQuery setHighlightFragsize ( int `$size` [, string `$field_override` ] )
public SolrQuery setHighlightHighlightMultiTerm ( bool `$flag` )
public SolrQuery setHighlightMaxAlternateFieldLength ( int `$fieldLength` [, string `$field_override` ] )
public SolrQuery setHighlightMaxAnalyzedChars ( int `$value` )
public SolrQuery setHighlightMergeContiguous ( bool `$flag` [, string `$field_override` ] )
public SolrQuery setHighlightRegexMaxAnalyzedChars ( int `$maxAnalyzedChars` )
public SolrQuery setHighlightRegexPattern ( string `$value` )
public SolrQuery setHighlightRegexSlop ( float `$factor` )
public SolrQuery setHighlightRequireFieldMatch ( bool `$flag` )
public SolrQuery setHighlightSimplePost ( string `$simplePost` [, string `$field_override` ] )
public SolrQuery setHighlightSimplePre ( string `$simplePre` [, string `$field_override` ] )
public SolrQuery setHighlightSnippets ( int `$value` [, string `$field_override` ] )
public SolrQuery setHighlightUsePhraseHighlighter ( bool `$flag` )
public SolrQuery setMlt ( bool `$flag` )
public SolrQuery setMltBoost ( bool `$flag` )
public SolrQuery setMltCount ( int `$count` )
public SolrQuery setMltMaxNumQueryTerms ( int `$value` )
public SolrQuery setMltMaxNumTokens ( int `$value` )
public SolrQuery setMltMaxWordLength ( int `$maxWordLength` )
public SolrQuery setMltMinDocFrequency ( int `$minDocFrequency` )
public SolrQuery setMltMinTermFrequency ( int `$minTermFrequency` )
public SolrQuery setMltMinWordLength ( int `$minWordLength` )
public SolrQuery setOmitHeader ( bool `$flag` )
public SolrQuery setQuery ( string `$query` )
public SolrQuery setRows ( int `$rows` )
public SolrQuery setShowDebugInfo ( bool `$flag` )
public SolrQuery setStart ( int `$start` )
public SolrQuery setStats ( bool `$flag` )
public SolrQuery setTerms ( bool `$flag` )
public SolrQuery setTermsField ( string `$fieldname` )
public SolrQuery setTermsIncludeLowerBound ( bool `$flag` )
public SolrQuery setTermsIncludeUpperBound ( bool `$flag` )
public SolrQuery setTermsLimit ( int `$limit` )
public SolrQuery setTermsLowerBound ( string `$lowerBound` )
public SolrQuery setTermsMaxCount ( int `$frequency` )
public SolrQuery setTermsMinCount ( int `$frequency` )
public SolrQuery setTermsPrefix ( string `$prefix` )
public SolrQuery setTermsReturnRaw ( bool `$flag` )
public SolrQuery setTermsSort ( int `$sortType` )
public SolrQuery setTermsUpperBound ( string `$upperBound` )
public SolrQuery setTimeAllowed ( int `$timeAllowed` )
/* Inherited methods */
public SolrModifiableParams::__construct ( void )
public void SolrModifiableParams::__destruct ( void )
}

## Predefined Constants

`SolrQuery::ORDER_ASC`

  Used to specify that the sorting should be in acending order

`SolrQuery::ORDER_DESC`

  Used to specify that the sorting should be in descending order

`SolrQuery::FACET_SORT_INDEX`

  Used to specify that the facet should sort by index

`SolrQuery::FACET_SORT_COUNT`

  Used to specify that the facet should sort by count

`SolrQuery::TERMS_SORT_INDEX`

  Used in the TermsComponent

`SolrQuery::TERMS_SORT_COUNT`

  Used in the TermsComponent

## Table of Contents

- SolrQuery::addFacetDateField — Maps to facet.date
- SolrQuery::addFacetDateOther — Adds another facet.date.other parameter
- SolrQuery::addFacetField — Adds another field to the facet
- SolrQuery::addFacetQuery — Adds a facet query
- SolrQuery::addField — Specifies which fields to return in the result
- SolrQuery::addFilterQuery — Specifies a filter query
- SolrQuery::addHighlightField — Maps to hl.fl
- SolrQuery::addMltField — Sets a field to use for similarity
- SolrQuery::addMltQueryField — Maps to mlt.qf
- SolrQuery::addSortField — Used to control how the results should be sorted
- SolrQuery::addStatsFacet — Requests a return of sub results for values within the given facet
- SolrQuery::addStatsField — Maps to stats.field parameter
- SolrQuery::__construct — Constructor
- SolrQuery::__destruct — Destructor
- SolrQuery::getFacet — Returns the value of the facet parameter
- SolrQuery::getFacetDateEnd — Returns the value for the facet.date.end parameter
- SolrQuery::getFacetDateFields — Returns all the facet.date fields
- SolrQuery::getFacetDateGap — Returns the value of the facet.date.gap parameter
- SolrQuery::getFacetDateHardEnd — Returns the value of the facet.date.hardend parameter
- SolrQuery::getFacetDateOther — Returns the value for the facet.date.other parameter
- SolrQuery::getFacetDateStart — Returns the lower bound for the first date range for all date faceting on this field
- SolrQuery::getFacetFields — Returns all the facet fields
- SolrQuery::getFacetLimit — Returns the maximum number of constraint counts that should be returned for the facet fields
- SolrQuery::getFacetMethod — Returns the value of the facet.method parameter
- SolrQuery::getFacetMinCount — Returns the minimum counts for facet fields should be included in the response
- SolrQuery::getFacetMissing — Returns the current state of the facet.missing parameter
- SolrQuery::getFacetOffset — Returns an offset into the list of constraints to be used for pagination
- SolrQuery::getFacetPrefix — Returns the facet prefix
- SolrQuery::getFacetQueries — Returns all the facet queries
- SolrQuery::getFacetSort — Returns the facet sort type
- SolrQuery::getFields — Returns the list of fields that will be returned in the response
- SolrQuery::getFilterQueries — Returns an array of filter queries
- SolrQuery::getHighlight — Returns the state of the hl parameter
- SolrQuery::getHighlightAlternateField — Returns the highlight field to use as backup or default
- SolrQuery::getHighlightFields — Returns all the fields that Solr should generate highlighted snippets for
- SolrQuery::getHighlightFormatter — Returns the formatter for the highlighted output
- SolrQuery::getHighlightFragmenter — Returns the text snippet generator for highlighted text
- SolrQuery::getHighlightFragsize — Returns the number of characters of fragments to consider for highlighting
- SolrQuery::getHighlightHighlightMultiTerm — Returns whether or not to enable highlighting for range/wildcard/fuzzy/prefix queries
- SolrQuery::getHighlightMaxAlternateFieldLength — Returns the maximum number of characters of the field to return
- SolrQuery::getHighlightMaxAnalyzedChars — Returns the maximum number of characters into a document to look for suitable snippets
- SolrQuery::getHighlightMergeContiguous — Returns whether or not the collapse contiguous fragments into a single fragment
- SolrQuery::getHighlightRegexMaxAnalyzedChars — Returns the maximum number of characters from a field when using the regex fragmenter
- SolrQuery::getHighlightRegexPattern — Returns the regular expression for fragmenting
- SolrQuery::getHighlightRegexSlop — Returns the deviation factor from the ideal fragment size
- SolrQuery::getHighlightRequireFieldMatch — Returns if a field will only be highlighted if the query matched in this particular field
- SolrQuery::getHighlightSimplePost — Returns the text which appears after a highlighted term
- SolrQuery::getHighlightSimplePre — Returns the text which appears before a highlighted term
- SolrQuery::getHighlightSnippets — Returns the maximum number of highlighted snippets to generate per field
- SolrQuery::getHighlightUsePhraseHighlighter — Returns the state of the hl.usePhraseHighlighter parameter
- SolrQuery::getMlt — Returns whether or not MoreLikeThis results should be enabled
- SolrQuery::getMltBoost — Returns whether or not the query will be boosted by the interesting term relevance
- SolrQuery::getMltCount — Returns the number of similar documents to return for each result
- SolrQuery::getMltFields — Returns all the fields to use for similarity
- SolrQuery::getMltMaxNumQueryTerms — Returns the maximum number of query terms that will be included in any generated query
- SolrQuery::getMltMaxNumTokens — Returns the maximum number of tokens to parse in each document field that is not stored with TermVector support
- SolrQuery::getMltMaxWordLength — Returns the maximum word length above which words will be ignored
- SolrQuery::getMltMinDocFrequency — Returns the treshold frequency at which words will be ignored which do not occur in at least this many docs
- SolrQuery::getMltMinTermFrequency — Returns the frequency below which terms will be ignored in the source document
- SolrQuery::getMltMinWordLength — Returns the minimum word length below which words will be ignored
- SolrQuery::getMltQueryFields — Returns the query fields and their boosts
- SolrQuery::getQuery — Returns the main query
- SolrQuery::getRows — Returns the maximum number of documents
- SolrQuery::getSortFields — Returns all the sort fields
- SolrQuery::getStart — Returns the offset in the complete result set
- SolrQuery::getStats — Returns whether or not stats is enabled
- SolrQuery::getStatsFacets — Returns all the stats facets that were set
- SolrQuery::getStatsFields — Returns all the statistics fields
- SolrQuery::getTerms — Returns whether or not the TermsComponent is enabled
- SolrQuery::getTermsField — Returns the field from which the terms are retrieved
- SolrQuery::getTermsIncludeLowerBound — Returns whether or not to include the lower bound in the result set
- SolrQuery::getTermsIncludeUpperBound — Returns whether or not to include the upper bound term in the result set
- SolrQuery::getTermsLimit — Returns the maximum number of terms Solr should return
- SolrQuery::getTermsLowerBound — Returns the term to start at
- SolrQuery::getTermsMaxCount — Returns the maximum document frequency
- SolrQuery::getTermsMinCount — Returns the minimum document frequency to return in order to be included
- SolrQuery::getTermsPrefix — Returns the term prefix
- SolrQuery::getTermsReturnRaw — Whether or not to return raw characters
- SolrQuery::getTermsSort — Returns an integer indicating how terms are sorted
- SolrQuery::getTermsUpperBound — Returns the term to stop at
- SolrQuery::getTimeAllowed — Returns the time in milliseconds allowed for the query to finish
- SolrQuery::removeFacetDateField — Removes one of the facet date fields
- SolrQuery::removeFacetDateOther — Removes one of the facet.date.other parameters
- SolrQuery::removeFacetField — Removes one of the facet.date parameters
- SolrQuery::removeFacetQuery — Removes one of the facet.query parameters
- SolrQuery::removeField — Removes a field from the list of fields
- SolrQuery::removeFilterQuery — Removes a filter query
- SolrQuery::removeHighlightField — Removes one of the fields used for highlighting
- SolrQuery::removeMltField — Removes one of the moreLikeThis fields
- SolrQuery::removeMltQueryField — Removes one of the moreLikeThis query fields
- SolrQuery::removeSortField — Removes one of the sort fields
- SolrQuery::removeStatsFacet — Removes one of the stats.facet parameters
- SolrQuery::removeStatsField — Removes one of the stats.field parameters
- SolrQuery::setEchoHandler — Toggles the echoHandler parameter
- SolrQuery::setEchoParams — Determines what kind of parameters to include in the response
- SolrQuery::setExplainOther — Sets the explainOther common query parameter
- SolrQuery::setFacet — Maps to the facet parameter. Enables or disables facetting
- SolrQuery::setFacetDateEnd — Maps to facet.date.end
- SolrQuery::setFacetDateGap — Maps to facet.date.gap
- SolrQuery::setFacetDateHardEnd — Maps to facet.date.hardend
- SolrQuery::setFacetDateStart — Maps to facet.date.start
- SolrQuery::setFacetEnumCacheMinDefaultFrequency — Sets the minimum document frequency used for determining term count
- SolrQuery::setFacetLimit — Maps to facet.limit
- SolrQuery::setFacetMethod — Specifies the type of algorithm to use when faceting a field
- SolrQuery::setFacetMinCount — Maps to facet.mincount
- SolrQuery::setFacetMissing — Maps to facet.missing
- SolrQuery::setFacetOffset — Sets the offset into the list of constraints to allow for pagination
- SolrQuery::setFacetPrefix — Specifies a string prefix with which to limits the terms on which to facet
- SolrQuery::setFacetSort — Determines the ordering of the facet field constraints
- SolrQuery::setHighlight — Enables or disables highlighting
- SolrQuery::setHighlightAlternateField — Specifies the backup field to use
- SolrQuery::setHighlightFormatter — Specify a formatter for the highlight output
- SolrQuery::setHighlightFragmenter — Sets a text snippet generator for highlighted text
- SolrQuery::setHighlightFragsize — The size of fragments to consider for highlighting
- SolrQuery::setHighlightHighlightMultiTerm — Use SpanScorer to highlight phrase terms
- SolrQuery::setHighlightMaxAlternateFieldLength — Sets the maximum number of characters of the field to return
- SolrQuery::setHighlightMaxAnalyzedChars — Specifies the number of characters into a document to look for suitable snippets
- SolrQuery::setHighlightMergeContiguous — Whether or not to collapse contiguous fragments into a single fragment
- SolrQuery::setHighlightRegexMaxAnalyzedChars — Specify the maximum number of characters to analyze
- SolrQuery::setHighlightRegexPattern — Specify the regular expression for fragmenting
- SolrQuery::setHighlightRegexSlop — Sets the factor by which the regex fragmenter can stray from the ideal fragment size
- SolrQuery::setHighlightRequireFieldMatch — Require field matching during highlighting
- SolrQuery::setHighlightSimplePost — Sets the text which appears after a highlighted term
- SolrQuery::setHighlightSimplePre — Sets the text which appears before a highlighted term
- SolrQuery::setHighlightSnippets — Sets the maximum number of highlighted snippets to generate per field
- SolrQuery::setHighlightUsePhraseHighlighter — Whether to highlight phrase terms only when they appear within the query phrase
- SolrQuery::setMlt — Enables or disables moreLikeThis
- SolrQuery::setMltBoost — Set if the query will be boosted by the interesting term relevance
- SolrQuery::setMltCount — Set the number of similar documents to return for each result
- SolrQuery::setMltMaxNumQueryTerms — Sets the maximum number of query terms included
- SolrQuery::setMltMaxNumTokens — Specifies the maximum number of tokens to parse
- SolrQuery::setMltMaxWordLength — Sets the maximum word length
- SolrQuery::setMltMinDocFrequency — Sets the mltMinDoc frequency
- SolrQuery::setMltMinTermFrequency — Sets the frequency below which terms will be ignored in the source docs
- SolrQuery::setMltMinWordLength — Sets the minimum word length
- SolrQuery::setOmitHeader — Exclude the header from the returned results
- SolrQuery::setQuery — Sets the search query
- SolrQuery::setRows — Specifies the maximum number of rows to return in the result
- SolrQuery::setShowDebugInfo — Flag to show debug information
- SolrQuery::setStart — Specifies the number of rows to skip
- SolrQuery::setStats — Enables or disables the Stats component
- SolrQuery::setTerms — Enables or disables the TermsComponent
- SolrQuery::setTermsField — Sets the name of the field to get the Terms from
- SolrQuery::setTermsIncludeLowerBound — Include the lower bound term in the result set
- SolrQuery::setTermsIncludeUpperBound — Include the upper bound term in the result set
- SolrQuery::setTermsLimit — Sets the maximum number of terms to return
- SolrQuery::setTermsLowerBound — Specifies the Term to start from
- SolrQuery::setTermsMaxCount — Sets the maximum document frequency
- SolrQuery::setTermsMinCount — Sets the minimum document frequency
- SolrQuery::setTermsPrefix — Restrict matches to terms that start with the prefix
- SolrQuery::setTermsReturnRaw — Return the raw characters of the indexed term
- SolrQuery::setTermsSort — Specifies how to sort the returned terms
- SolrQuery::setTermsUpperBound — Sets the term to stop at
- SolrQuery::setTimeAllowed — The time allowed for search to finish

SolrModifiableParams::__destruct
SolrQuery::addFacetDateField
Solr
PHP Manual