SolrDisMaxQuery

class SolrDisMaxQuery extends SolrQuery implements Serializable (View source)

(PECL solr >= 2.1.0)
Version not present on php.net documentation, determined here by using PECL solr changelog: https://pecl.php.net/package-changelog.php?package=solr&release=2.1.0
Class SolrDisMaxQuery

Constants

ORDER_ASC

ORDER_DESC

FACET_SORT_INDEX

FACET_SORT_COUNT

TERMS_SORT_INDEX

TERMS_SORT_COUNT

Methods

SolrParams|false
add(string $name, string $value)

(PECL solr >= 0.9.2)
This is an alias for SolrParams::addParam

from  SolrParams
SolrParams|false
addParam(string $name, string $value)

(PECL solr >= 0.9.2)
Adds a parameter to the object

from  SolrParams
mixed
get(string $param_name)

(PECL solr >= 0.9.2)
This is an alias for SolrParams::getParam

from  SolrParams
mixed
getParam(string $param_name)

(PECL solr >= 0.9.2)
Returns a parameter value

from  SolrParams
array
getParams()

(PECL solr >= 0.9.2)
Returns an array of non URL-encoded parameters

from  SolrParams
array
getPreparedParams()

(PECL solr >= 0.9.2)
Returns an array of URL-encoded parameters

from  SolrParams
string|null
serialize()

(PECL solr >= 0.9.2)
Used for custom serialization

from  SolrParams
SolrParams|false
set(string $name, string $value)

(PECL solr >= 0.9.2)
An alias of SolrParams::setParam

from  SolrParams
SolrParams|false
setParam(string $name, string $value)

(PECL solr >= 0.9.2)
Sets the parameter to the specified value

from  SolrParams
string|false
toString(bool $url_encode = false)

(PECL solr >= 0.9.2)
Returns all the name-value pair parameters in the object

from  SolrParams
void
unserialize(string $serialized)

(PECL solr >= 0.9.2)
Used for custom serialization

from  SolrParams
__construct(string $q = '')

(PECL solr >= 0.9.2)
SolrQuery constructor.

from  SolrQuery
__destruct()

(PECL solr >= 0.9.2)
Destructor

from  SolrQuery
SolrQuery
addExpandFilterQuery(string $fq)

(PECL solr >= 2.2.0)
Overrides main filter query, determines which documents to include in the main group.

from  SolrQuery
SolrQuery
addExpandSortField(string $field, string $order)

(PECL solr >= 2.2.0)
Orders the documents within the expanded groups (expand.sort parameter).

from  SolrQuery
SolrQuery
addFacetDateField(string $dateField)

(PECL solr >= 0.9.2)
Maps to facet.date

from  SolrQuery
SolrQuery
addFacetDateOther(string $value, string $field_override)

(PECL solr >= 0.9.2)
Adds another facet.date.other parameter

from  SolrQuery
SolrQuery
addFacetField(string $field)

(PECL solr >= 0.9.2)
Adds another field to the facet

from  SolrQuery
SolrQuery
addFacetQuery(string $facetQuery)

(PECL solr >= 0.9.2)
Adds a facet query

from  SolrQuery
SolrQuery
addField(string $field)

(PECL solr >= 0.9.2)
Specifies which fields to return in the result

from  SolrQuery
SolrQuery
addFilterQuery(string $fq)

(PECL solr >= 0.9.2)
Specifies a filter query

from  SolrQuery
SolrQuery
addGroupField(string $value)

(PECL solr >= 2.2.0)
Add a field to be used to group results.

from  SolrQuery
SolrQuery
addGroupFunction(string $value)

(PECL solr >= 2.2.0)
Allows grouping results based on the unique values of a function query (group.func parameter).

from  SolrQuery
SolrQuery
addGroupQuery(string $value)

(PECL solr >= 2.2.0)
Allows grouping of documents that match the given query.

from  SolrQuery
SolrQuery
addGroupSortField(string $field, int $order)

(PECL solr >= 2.2.0)
Add a group sort field (group.sort parameter).

from  SolrQuery
SolrQuery
addHighlightField(string $field)

(PECL solr >= 0.9.2)
Maps to hl.fl

from  SolrQuery
SolrQuery
addMltField(string $field)

(PECL solr >= 0.9.2)
Sets a field to use for similarity

from  SolrQuery
SolrQuery
addMltQueryField(string $field, float $boost)

(PECL solr >= 0.9.2)
Maps to mlt.qf

from  SolrQuery
SolrQuery
addSortField(string $field, int $order = SolrQuery::ORDER_DESC)

(PECL solr >= 0.9.2)
Used to control how the results should be sorted

from  SolrQuery
SolrQuery
addStatsFacet(string $field)

(PECL solr >= 0.9.2)
Requests a return of sub results for values within the given facet

from  SolrQuery
SolrQuery
addStatsField(string $field)

(PECL solr >= 0.9.2)
Maps to stats.field parameter

from  SolrQuery
SolrQuery
collapse(SolrCollapseFunction $collapseFunction)

(No version information available, might only be in Git)
Collapses the result set to a single document per group

from  SolrQuery
bool
getExpand()

(PECL solr >= 2.2.0)
Returns true if group expanding is enabled

from  SolrQuery
array
getExpandFilterQueries()

(PECL solr >= 2.2.0)
Returns the expand filter queries

from  SolrQuery
array
getExpandQuery()

(PECL solr >= 2.2.0)
Returns the expand query expand.q parameter

from  SolrQuery
int
getExpandRows()

(PECL solr >= 2.2.0)
Returns The number of rows to display in each group (expand.rows)

from  SolrQuery
array
getExpandSortFields()

(PECL solr >= 2.2.0)
Returns an array of fields

from  SolrQuery
bool|null
getFacet()

(PECL solr >= 0.9.2)
Returns the value of the facet parameter

from  SolrQuery
string|null
getFacetDateEnd(string $field_override)

(PECL solr >= 0.9.2)
Returns the value for the facet.date.end parameter

from  SolrQuery
array|null
getFacetDateFields()

(PECL solr >= 0.9.2)
Returns all the facet.date fields

from  SolrQuery
string|null
getFacetDateGap(string $field_override)

(PECL solr >= 0.9.2)
Returns the value of the facet.date.gap parameter

from  SolrQuery
string|null
getFacetDateHardEnd(string $field_override)

(PECL solr >= 0.9.2)
Returns the value of the facet.date.hardend parameter

from  SolrQuery
array|null
getFacetDateOther(string $field_override)

(PECL solr >= 0.9.2)
Returns the value for the facet.date.other parameter

from  SolrQuery
string|null
getFacetDateStart(string $field_override)

(PECL solr >= 0.9.2)
Returns the lower bound for the first date range for all date faceting on this field

from  SolrQuery
array|null
getFacetFields()

(PECL solr >= 0.9.2)
Returns all the facet fields

from  SolrQuery
int|null
getFacetLimit(string $field_override)

(PECL solr >= 0.9.2)
Returns the maximum number of constraint counts that should be returned for the facet fields

from  SolrQuery
string|null
getFacetMethod(string $field_override)

(PECL solr >= 0.9.2)
Returns the value of the facet.method parameter

from  SolrQuery
int|null
getFacetMinCount(string $field_override)

(PECL solr >= 0.9.2)
Returns the minimum counts for facet fields should be included in the response

from  SolrQuery
string|null
getFacetMissing(string $field_override)

(PECL solr >= 0.9.2)
Returns the current state of the facet.missing parameter

from  SolrQuery
int|null
getFacetOffset(string $field_override)

(PECL solr >= 0.9.2)
Returns an offset into the list of constraints to be used for pagination

from  SolrQuery
string|null
getFacetPrefix(string $field_override)

(PECL solr >= 0.9.2)
Returns the facet prefix

from  SolrQuery
string|null
getFacetQueries()

(PECL solr >= 0.9.2)
Returns all the facet queries

from  SolrQuery
int|null
getFacetSort(string $field_override)

(PECL solr >= 0.9.2)
Returns the facet sort type

from  SolrQuery
string|null
getFields()

(PECL solr >= 0.9.2)
Returns the list of fields that will be returned in the response

from  SolrQuery
string|null
getFilterQueries()

(PECL solr >= 0.9.2)
Returns an array of filter queries

from  SolrQuery
bool
getGroup()

(PECL solr >= 2.2.0)
Returns true if grouping is enabled https://secure.php.net/manual/en/solrquery.getgroup.php

from  SolrQuery
int
getGroupCachePercent()

(PECL solr >= 2.2.0)
Returns group cache percent value

from  SolrQuery
bool
getGroupFacet()

(PECL solr >= 2.2.0)
Returns the group.facet parameter value

from  SolrQuery
array
getGroupFields()

(PECL solr >= 2.2.0)
Returns group fields (group.field parameter values)

from  SolrQuery
string
getGroupFormat()

(PECL solr >= 2.2.0)
Returns the group.format value

from  SolrQuery
array
getGroupFunctions()

(PECL solr >= 2.2.0)
Returns group functions (group.func parameter values)

from  SolrQuery
int
getGroupLimit()

(PECL solr >= 2.2.0)
Returns the group.limit value

from  SolrQuery
bool
getGroupMain()

(PECL solr >= 2.2.0)
Returns the group.main value

from  SolrQuery
bool
getGroupNGroups()

(PECL solr >= 2.2.0)
Returns the group.ngroups value

from  SolrQuery
bool
getGroupOffset()

(PECL solr >= 2.2.0)
Returns the group.offset value

from  SolrQuery
array
getGroupQueries()

(PECL solr >= 2.2.0)
Returns all the group.query parameter values

from  SolrQuery
array
getGroupSortFields()

(PECL solr >= 2.2.0)
Returns the group.sort value

from  SolrQuery
bool
getGroupTruncate()

(PECL solr >= 2.2.0)
Returns the group.truncate value

from  SolrQuery
bool
getHighlight()

(PECL solr >= 0.9.2)
Returns the state of the hl parameter

from  SolrQuery
string|null
getHighlightAlternateField(string $field_override)

(PECL solr >= 0.9.2)
Returns the highlight field to use as backup or default

from  SolrQuery
array|null
getHighlightFields()

(PECL solr >= 0.9.2)
Returns all the fields that Solr should generate highlighted snippets for

from  SolrQuery
string|null
getHighlightFormatter(string $field_override)

(PECL solr >= 0.9.2)
Returns the formatter for the highlighted output

from  SolrQuery
string|null
getHighlightFragmenter(string $field_override)

(PECL solr >= 0.9.2)
Returns the text snippet generator for highlighted text

from  SolrQuery
int|null
getHighlightFragsize(string $field_override)

(PECL solr >= 0.9.2)
Returns the number of characters of fragments to consider for highlighting

from  SolrQuery
bool|null
getHighlightHighlightMultiTerm()

(PECL solr >= 0.9.2)
Returns whether or not to enable highlighting for range/wildcard/fuzzy/prefix queries

from  SolrQuery
int|null
getHighlightMaxAlternateFieldLength(string $field_override)

(PECL solr >= 0.9.2)
Returns the maximum number of characters of the field to return

from  SolrQuery
int|null
getHighlightMaxAnalyzedChars()

(PECL solr >= 0.9.2)
Returns the maximum number of characters into a document to look for suitable snippets

from  SolrQuery
bool|null
getHighlightMergeContiguous(string $field_override)

(PECL solr >= 0.9.2)
Returns whether or not the collapse contiguous fragments into a single fragment

from  SolrQuery
int|null
getHighlightRegexMaxAnalyzedChars()

(PECL solr >= 0.9.2)
Returns the maximum number of characters from a field when using the regex fragmenter

from  SolrQuery
string
getHighlightRegexPattern()

(PECL solr >= 0.9.2)
Returns the regular expression for fragmenting

from  SolrQuery
float|null
getHighlightRegexSlop()

(PECL solr >= 0.9.2)
Returns the deviation factor from the ideal fragment size

from  SolrQuery
bool|null
getHighlightRequireFieldMatch()

(PECL solr >= 0.9.2)
Returns if a field will only be highlighted if the query matched in this particular field

from  SolrQuery
string|null
getHighlightSimplePost(string $field_override)

(PECL solr >= 0.9.2)
Returns the text which appears after a highlighted term

from  SolrQuery
string|null
getHighlightSimplePre(string $field_override)

(PECL solr >= 0.9.2)
Returns the text which appears before a highlighted term

from  SolrQuery
int|null
getHighlightSnippets(string $field_override)

(PECL solr >= 0.9.2)
Returns the maximum number of highlighted snippets to generate per field

from  SolrQuery
bool|null
getHighlightUsePhraseHighlighter()

(PECL solr >= 0.9.2)
Returns the state of the hl.usePhraseHighlighter parameter

from  SolrQuery
bool|null
getMlt()

(PECL solr >= 0.9.2)
Returns whether or not MoreLikeThis results should be enabled

from  SolrQuery
bool|null
getMltBoost()

(PECL solr >= 0.9.2)
Returns whether or not the query will be boosted by the interesting term relevance

from  SolrQuery
int|null
getMltCount()

(PECL solr >= 0.9.2)
Returns the number of similar documents to return for each result

from  SolrQuery
array
getMltFields()

(PECL solr >= 0.9.2)
Returns all the fields to use for similarity

from  SolrQuery
int|null
getMltMaxNumQueryTerms()

(PECL solr >= 0.9.2)
Returns the maximum number of query terms that will be included in any generated query

from  SolrQuery
int
getMltMaxNumTokens()

(PECL solr >= 0.9.2)
Returns the maximum number of tokens to parse in each document field that is not stored with TermVector support

from  SolrQuery
int|null
getMltMaxWordLength()

(PECL solr >= 0.9.2)
Returns the maximum word length above which words will be ignored

from  SolrQuery
int|null
getMltMinDocFrequency()

(PECL solr >= 0.9.2)
Returns the threshold frequency at which words will be ignored which do not occur in at least this many docs

from  SolrQuery
int|null
getMltMinTermFrequency()

(PECL solr >= 0.9.2)
Returns the frequency below which terms will be ignored in the source document

from  SolrQuery
int
getMltMinWordLength()

(PECL solr >= 0.9.2)
Returns the minimum word length below which words will be ignored

from  SolrQuery
array|null
getMltQueryFields()

(PECL solr >= 0.9.2)
Returns the query fields and their boosts

from  SolrQuery
string
getQuery()

(PECL solr >= 0.9.2)
Returns the main query

from  SolrQuery
int|null
getRows()

(PECL solr >= 0.9.2)
Returns the maximum number of documents

from  SolrQuery
array
getSortFields()

(PECL solr >= 0.9.2)
Returns all the sort fields

from  SolrQuery
int|null
getStart()

(PECL solr >= 0.9.2)
Returns the offset in the complete result set

from  SolrQuery
bool|null
getStats()

(PECL solr >= 0.9.2)
Returns whether or not stats is enabled

from  SolrQuery
array|null
getStatsFacets()

(PECL solr >= 0.9.2)
Returns all the stats facets that were set

from  SolrQuery
array|null
getStatsFields()

(PECL solr >= 0.9.2)
Returns all the statistics fields

from  SolrQuery
bool|null
getTerms()

(PECL solr >= 0.9.2)
Returns whether or not the TermsComponent is enabled

from  SolrQuery
string|null
getTermsField()

(PECL solr >= 0.9.2)
Returns the field from which the terms are retrieved

from  SolrQuery
bool|null
getTermsIncludeLowerBound()

(PECL solr >= 0.9.2)
Returns whether or not to include the lower bound in the result set

from  SolrQuery
bool|null
getTermsIncludeUpperBound()

(PECL solr >= 0.9.2)
Returns whether or not to include the upper bound term in the result set

from  SolrQuery
int|null
getTermsLimit()

(PECL solr >= 0.9.2)
Returns the maximum number of terms Solr should return

from  SolrQuery
string|null
getTermsLowerBound()

(PECL solr >= 0.9.2)
Returns the term to start at

from  SolrQuery
int|null
getTermsMaxCount()

(PECL solr >= 0.9.2)
Returns the maximum document frequency

from  SolrQuery
int|null
getTermsMinCount()

(PECL solr >= 0.9.2)
Returns the minimum document frequency to return in order to be included

from  SolrQuery
string|null
getTermsPrefix()

(PECL solr >= 0.9.2)
Returns the term prefix

from  SolrQuery
bool|null
getTermsReturnRaw()

(PECL solr >= 0.9.2)
Whether or not to return raw characters

from  SolrQuery
int|null
getTermsSort()

(PECL solr >= 0.9.2)
Returns an integer indicating how terms are sorted

from  SolrQuery
string|null
getTermsUpperBound()

(PECL solr >= 0.9.2)
Returns the term to stop at

from  SolrQuery
int|null
getTimeAllowed()

(PECL solr >= 0.9.2)
Returns the time in milliseconds allowed for the query to finish

from  SolrQuery
SolrQuery
removeExpandFilterQuery(string $fq)

(PECL solr >= 2.2.0)
Removes an expand filter query

from  SolrQuery
SolrQuery
removeExpandSortField(string $field)

(PECL solr >= 2.2.0)
Removes an expand sort field from the expand.sort parameter.

from  SolrQuery
SolrQuery
removeFacetDateField(string $field)

(PECL solr >= 0.9.2)
Removes one of the facet date fields

from  SolrQuery
SolrQuery
removeFacetDateOther(string $value, string $field_override)

(PECL solr >= 0.9.2)
Removes one of the facet.date.other parameters

from  SolrQuery
SolrQuery
removeFacetField(string $field)

(PECL solr >= 0.9.2)
Removes one of the facet.date parameters

from  SolrQuery
SolrQuery
removeFacetQuery(string $value)

(PECL solr >= 0.9.2)
Removes one of the facet.query parameters

from  SolrQuery
SolrQuery
removeField(string $field)

(PECL solr >= 0.9.2)
Removes a field from the list of fields

from  SolrQuery
SolrQuery
removeFilterQuery(string $fq)

(PECL solr >= 0.9.2)
Removes a filter query

from  SolrQuery
SolrQuery
removeHighlightField(string $field)

(PECL solr >= 0.9.2)
Removes one of the fields used for highlighting

from  SolrQuery
SolrQuery
removeMltField(string $field)

(PECL solr >= 0.9.2)
Removes one of the moreLikeThis fields

from  SolrQuery
SolrQuery
removeMltQueryField(string $queryField)

(PECL solr >= 0.9.2)
Removes one of the moreLikeThis query fields

from  SolrQuery
SolrQuery
removeSortField(string $field)

(PECL solr >= 0.9.2)
Removes one of the sort fields

from  SolrQuery
SolrQuery
removeStatsFacet(string $value)

(PECL solr >= 0.9.2)
Removes one of the stats.facet parameters

from  SolrQuery
SolrQuery
removeStatsField(string $field)

(PECL solr >= 0.9.2)
Removes one of the stats.field parameters

from  SolrQuery
SolrQuery
setEchoHandler(bool $flag)

(PECL solr >= 0.9.2)
Toggles the echoHandler parameter

from  SolrQuery
SolrQuery
setEchoParams(string $type)

(PECL solr >= 0.9.2)
Determines what kind of parameters to include in the response

from  SolrQuery
SolrQuery
setExpand(bool $value)

(PECL solr >= 2.2.0)
Enables/Disables the Expand Component

from  SolrQuery
SolrQuery
setExpandQuery(string $q)

(PECL solr >= 2.2.0)
Sets the expand.q parameter

from  SolrQuery
SolrQuery
setExpandRows(int $value)

(PECL solr >= 2.2.0)
Sets the number of rows to display in each group (expand.rows). Server Default 5

from  SolrQuery
SolrQuery
setExplainOther(string $query)

(PECL solr >= 0.9.2)
Sets the explainOther common query parameter

from  SolrQuery
SolrQuery
setFacet(bool $flag)

(PECL solr >= 0.9.2)
Maps to the facet parameter. Enables or disables facetting

from  SolrQuery
SolrQuery
setFacetDateEnd(string $value, string $field_override)

(PECL solr >= 0.9.2)
Maps to facet.date.end

from  SolrQuery
SolrQuery
setFacetDateGap(string $value, string $field_override)

(PECL solr >= 0.9.2)
Maps to facet.date.gap

from  SolrQuery
SolrQuery
setFacetDateHardEnd(bool $value, string $field_override)

(PECL solr >= 0.9.2)
Maps to facet.date.hardend

from  SolrQuery
SolrQuery
setFacetDateStart(string $value, string $field_override)

(PECL solr >= 0.9.2)
Maps to facet.date.start

from  SolrQuery
SolrQuery
setFacetEnumCacheMinDefaultFrequency(int $frequency, string $field_override)

(PECL solr >= 0.9.2)
Sets the minimum document frequency used for determining term count

from  SolrQuery
SolrQuery
setFacetLimit(int $limit, string $field_override)

(PECL solr >= 0.9.2)
Maps to facet.limit

from  SolrQuery
SolrQuery
setFacetMethod(string $method, string $field_override)

(PECL solr >= 0.9.2)
Specifies the type of algorithm to use when faceting a field

from  SolrQuery
SolrQuery
setFacetMinCount(int $mincount, string $field_override)

(PECL solr >= 0.9.2)
Maps to facet.mincount

from  SolrQuery
SolrQuery
setFacetMissing(bool $flag, string $field_override)

(PECL solr >= 0.9.2)
Maps to facet.missing

from  SolrQuery
SolrQuery
setFacetOffset(int $offset, string $field_override)

(PECL solr >= 0.9.2)
Sets the offset into the list of constraints to allow for pagination

from  SolrQuery
SolrQuery
setFacetPrefix(string $prefix, string $field_override)

(PECL solr >= 0.9.2)
Specifies a string prefix with which to limits the terms on which to facet

from  SolrQuery
SolrQuery
setFacetSort(int $facetSort, string $field_override)

(PECL solr >= 0.9.2)
Determines the ordering of the facet field constraints

from  SolrQuery
SolrQuery
setGroup(bool $value)

(PECL solr >= 2.2.0)
Enable/Disable result grouping (group parameter)

from  SolrQuery
SolrQuery
setGroupCachePercent(int $percent)

(PECL solr >= 2.2.0)
Enables caching for result grouping

from  SolrQuery
SolrQuery
setGroupFacet(bool $value)

(PECL solr >= 2.2.0)
Sets group.facet parameter

from  SolrQuery
SolrQuery
setGroupFormat(string $value)

(PECL solr >= 2.2.0)
Sets the group format, result structure (group.format parameter).

from  SolrQuery
SolrQuery
setGroupLimit(int $value)

(PECL solr >= 2.2.0)
Specifies the number of results to return for each group. The server default value is 1.

from  SolrQuery
SolrQuery
setGroupMain(string $value)

(PECL solr >= 2.2.0)
If true, the result of the first field grouping command is used as the main result list in the response, using group.format=simple.

from  SolrQuery
SolrQuery
setGroupNGroups(bool $value)

(PECL solr >= 2.2.0)
If true, Solr includes the number of groups that have matched the query in the results.

from  SolrQuery
SolrQuery
setGroupOffset(int $value)

(PECL solr >= 2.2.0)
Sets the group.offset parameter.

from  SolrQuery
SolrQuery
setGroupTruncate(bool $value)

(PECL solr >= 2.2.0)
If true, facet counts are based on the most relevant document of each group matching the query.

from  SolrQuery
SolrQuery
setHighlight(bool $flag)

(PECL solr >= 0.9.2)
Enables or disables highlighting

from  SolrQuery
SolrQuery
setHighlightAlternateField(string $field, string $field_override)

(PECL solr >= 0.9.2)
Specifies the backup field to use

from  SolrQuery
SolrQuery
setHighlightFormatter(string $formatter, string $field_override)

(PECL solr >= 0.9.2)
Specify a formatter for the highlight output

from  SolrQuery
SolrQuery
setHighlightFragmenter(string $fragmenter, string $field_override)

(PECL solr >= 0.9.2)
Sets a text snippet generator for highlighted text

from  SolrQuery
SolrQuery
setHighlightFragsize(int $size, string $field_override)

(PECL solr >= 0.9.2)
The size of fragments to consider for highlighting

from  SolrQuery
SolrQuery
setHighlightHighlightMultiTerm(bool $flag)

(PECL solr >= 0.9.2)
Use SpanScorer to highlight phrase terms

from  SolrQuery
SolrQuery
setHighlightMaxAlternateFieldLength(int $fieldLength, string $field_override)

(PECL solr >= 0.9.2)
Sets the maximum number of characters of the field to return

from  SolrQuery
SolrQuery
setHighlightMaxAnalyzedChars(int $value)

(PECL solr >= 0.9.2)
Specifies the number of characters into a document to look for suitable snippets

from  SolrQuery
SolrQuery
setHighlightMergeContiguous(bool $flag, string $field_override)

(PECL solr >= 0.9.2)
Whether or not to collapse contiguous fragments into a single fragment

from  SolrQuery
SolrQuery
setHighlightRegexMaxAnalyzedChars(int $maxAnalyzedChars)

(PECL solr >= 0.9.2)
Specify the maximum number of characters to analyze

from  SolrQuery
SolrQuery
setHighlightRegexPattern(string $value)

(PECL solr >= 0.9.2)
Specify the regular expression for fragmenting

from  SolrQuery
SolrQuery
setHighlightRegexSlop(float $factor)

(PECL solr >= 0.9.2)
Sets the factor by which the regex fragmenter can stray from the ideal fragment size

from  SolrQuery
SolrQuery
setHighlightRequireFieldMatch(bool $flag)

(PECL solr >= 0.9.2)
Require field matching during highlighting

from  SolrQuery
SolrQuery
setHighlightSimplePost(string $simplePost, string $field_override)

(PECL solr >= 0.9.2)
Sets the text which appears after a highlighted term

from  SolrQuery
SolrQuery
setHighlightSimplePre(string $simplePre, string $field_override)

(PECL solr >= 0.9.2)
Sets the text which appears before a highlighted term

from  SolrQuery
SolrQuery
setHighlightSnippets(int $value, string $field_override)

(PECL solr >= 0.9.2)
Sets the maximum number of highlighted snippets to generate per field

from  SolrQuery
SolrQuery
setHighlightUsePhraseHighlighter(bool $flag)

(PECL solr >= 0.9.2)
Whether to highlight phrase terms only when they appear within the query phrase

from  SolrQuery
SolrQuery
setMlt(bool $flag)

(PECL solr >= 0.9.2)
Enables or disables moreLikeThis

from  SolrQuery
SolrQuery
setMltBoost(bool $flag)

(PECL solr >= 0.9.2)
Set if the query will be boosted by the interesting term relevance

from  SolrQuery
SolrQuery
setMltCount(int $count)

(PECL solr >= 0.9.2)
Set the number of similar documents to return for each result

from  SolrQuery
SolrQuery
setMltMaxNumQueryTerms(int $value)

(PECL solr >= 0.9.2)
Sets the maximum number of query terms included

from  SolrQuery
SolrQuery
setMltMaxNumTokens(int $value)

(PECL solr >= 0.9.2)
Specifies the maximum number of tokens to parse

from  SolrQuery
SolrQuery
setMltMaxWordLength(int $maxWordLength)

(PECL solr >= 0.9.2)
Sets the maximum word length

from  SolrQuery
SolrQuery
setMltMinDocFrequency(int $minDocFrequency)

(PECL solr >= 0.9.2)
Sets the mltMinDoc frequency

from  SolrQuery
SolrQuery
setMltMinTermFrequency(int $minTermFrequency)

(PECL solr >= 0.9.2)
Sets the frequency below which terms will be ignored in the source docs

from  SolrQuery
SolrQuery
setMltMinWordLength(int $minWordLength)

(PECL solr >= 0.9.2)
Sets the minimum word length

from  SolrQuery
SolrQuery
setOmitHeader(bool $flag)

(PECL solr >= 0.9.2)
Exclude the header from the returned results

from  SolrQuery
SolrQuery
setQuery(string $query)

(PECL solr >= 0.9.2)
Sets the search query

from  SolrQuery
SolrQuery
setRows(int $rows)

(PECL solr >= 0.9.2)
Specifies the maximum number of rows to return in the result

from  SolrQuery
SolrQuery
setShowDebugInfo(bool $flag)

(PECL solr >= 0.9.2)
Flag to show debug information

from  SolrQuery
SolrQuery
setStart(int $start)

(PECL solr >= 0.9.2)
Specifies the number of rows to skip

from  SolrQuery
SolrQuery
setStats(bool $flag)

(PECL solr >= 0.9.2)
Enables or disables the Stats component

from  SolrQuery
SolrQuery
setTerms(bool $flag)

(PECL solr >= 0.9.2)
Enables or disables the TermsComponent

from  SolrQuery
SolrQuery
setTermsField(string $fieldname)

(PECL solr >= 0.9.2)
Sets the name of the field to get the Terms from

from  SolrQuery
SolrQuery
setTermsIncludeLowerBound(bool $flag)

(PECL solr >= 0.9.2)
Include the lower bound term in the result set

from  SolrQuery
SolrQuery
setTermsIncludeUpperBound(bool $flag)

(PECL solr >= 0.9.2)
Include the upper bound term in the result set

from  SolrQuery
SolrQuery
setTermsLimit(int $limit)

(PECL solr >= 0.9.2)
Sets the maximum number of terms to return

from  SolrQuery
SolrQuery
setTermsLowerBound(string $lowerBound)

(PECL solr >= 0.9.2)
Specifies the Term to start from

from  SolrQuery
SolrQuery
setTermsMaxCount(int $frequency)

(PECL solr >= 0.9.2)
Sets the maximum document frequency

from  SolrQuery
SolrQuery
setTermsMinCount(int $frequency)

(PECL solr >= 0.9.2)
Sets the minimum document frequency

from  SolrQuery
SolrQuery
setTermsPrefix(string $prefix)

(PECL solr >= 0.9.2)
Restrict matches to terms that start with the prefix

from  SolrQuery
SolrQuery
setTermsReturnRaw(bool $flag)

(PECL solr >= 0.9.2)
Return the raw characters of the indexed term

from  SolrQuery
SolrQuery
setTermsSort(int $sortType)

(PECL solr >= 0.9.2)
Specifies how to sort the returned terms

from  SolrQuery
SolrQuery
setTermsUpperBound(string $upperBound)

(PECL solr >= 0.9.2)
Sets the term to stop at

from  SolrQuery
SolrQuery
setTimeAllowed(int $timeAllowed)

(PECL solr >= 0.9.2)
The time allowed for search to finish

from  SolrQuery
SolrDisMaxQuery
addBigramPhraseField(string $field, string $boost, string $slop)

(PECL solr >= 2.1.0)
Adds a Phrase Bigram Field (pf2 parameter)

SolrDisMaxQuery
addBoostQuery(string $field, string $value, string $boost)

(PECL solr >= 2.1.0)
Adds a boost query field with value and optional boost (bq parameter)

SolrDisMaxQuery
addPhraseField(string $field, string $boost, string $slop)

(PECL solr >= 2.1.0)
Adds a Phrase Field (pf parameter)

SolrDisMaxQuery
addQueryField(string $field, string $boost)

(PECL solr >= 2.1.0)
Add a query field with optional boost (qf parameter)

SolrDisMaxQuery
addTrigramPhraseField(string $field, string $boost, string $slop)

(PECL solr >= 2.1.0)
Adds a Trigram Phrase Field (pf3 parameter)

SolrDisMaxQuery
addUserField(string $field)

(PECL solr >= 2.1.0)
Adds a field to User Fields Parameter (uf)

SolrDisMaxQuery
removeBigramPhraseField(string $field)

(PECL solr >= 2.1.0)
Removes phrase bigram field (pf2 parameter)

SolrDisMaxQuery
removeBoostQuery(string $field)

(PECL solr >= 2.1.0)
Removes a boost query partial by field name (bq)

SolrDisMaxQuery
removePhraseField(string $field)

(PECL solr >= 2.1.0)
Removes a Phrase Field (pf parameter)

SolrDisMaxQuery
removeQueryField(string $field)

(PECL solr >= 2.1.0)
Removes a Query Field (qf parameter)

SolrDisMaxQuery
removeTrigramPhraseField(string $field)

(PECL solr >= 2.1.0)
Removes a Trigram Phrase Field (pf3 parameter)

SolrDisMaxQuery
removeUserField(string $field)

(PECL solr >= 2.1.0)
Removes a field from The User Fields Parameter (uf)

Warning
This function is currently not documented; only its argument list is available.

SolrDisMaxQuery
setBigramPhraseFields(string $fields)

(PECL solr >= 2.1.0)
Sets Bigram Phrase Fields and their boosts (and slops) using pf2 parameter

SolrDisMaxQuery
setBigramPhraseSlop(string $slop)

(PECL solr >= 2.1.0)
Sets Bigram Phrase Slop (ps2 parameter)

SolrDisMaxQuery
setBoostFunction(string $function)

(PECL solr >= 2.1.0)
Sets a Boost Function (bf parameter).

SolrDisMaxQuery
setBoostQuery(string $q)

(PECL solr >= 2.1.0)
Directly Sets Boost Query Parameter (bq)

SolrDisMaxQuery
setMinimumMatch(string $value)

(PECL solr >= 2.1.0)
Set Minimum "Should" Match (mm)

SolrDisMaxQuery
setPhraseFields(string $fields)

(PECL solr >= 2.1.0)
Sets Phrase Fields and their boosts (and slops) using pf2 parameter

SolrDisMaxQuery
setPhraseSlop(string $slop)

(PECL solr >= 2.1.0)
Sets the default slop on phrase queries (ps parameter)

SolrDisMaxQuery
setQueryAlt(string $q)

(PECL solr >= 2.1.0)
Set Query Alternate (q.alt parameter)

SolrDisMaxQuery
setQueryPhraseSlop(string $slop)

(PECL solr >= 2.1.0)
Specifies the amount of slop permitted on phrase queries explicitly included in the user's query string (qf parameter)

SolrDisMaxQuery
setTieBreaker(string $tieBreaker)

(PECL solr >= 2.1.0)
Sets Tie Breaker parameter (tie parameter)

SolrDisMaxQuery
setTrigramPhraseFields(string $fields)

(PECL solr >= 2.1.0)
Directly Sets Trigram Phrase Fields (pf3 parameter)

SolrDisMaxQuery
setTrigramPhraseSlop(string $slop)

(PECL solr >= 2.1.0)
Sets Trigram Phrase Slop (ps3 parameter)

SolrDisMaxQuery
setUserFields(string $fields)

(PECL solr >= 2.1.0)
Sets User Fields parameter (uf)

SolrDisMaxQuery
useDisMaxQueryParser()

(PECL solr >= 2.1.0)
Switch QueryParser to be DisMax Query Parser

SolrDisMaxQuery
useEDisMaxQueryParser()

(PECL solr >= 2.1.0)
Switch QueryParser to be EDisMax
By default the query builder uses edismax, if it was switched using SolrDisMaxQuery::useDisMaxQueryParser(), it can be switched back using this method.

Details

in SolrParams at line 31
SolrParams|false add(string $name, string $value)

(PECL solr >= 0.9.2)
This is an alias for SolrParams::addParam

Parameters

string $name

The name of the parameter

string $value

The value of the parameter

Return Value

SolrParams|false

Returns a SolrParams instance on success and FALSE on failure.

in SolrParams at line 47
SolrParams|false addParam(string $name, string $value)

(PECL solr >= 0.9.2)
Adds a parameter to the object

Parameters

string $name

The name of the parameter

string $value

The value of the parameter

Return Value

SolrParams|false

Returns a SolrParams instance on success and FALSE on failure.

in SolrParams at line 60
final mixed get(string $param_name)

(PECL solr >= 0.9.2)
This is an alias for SolrParams::getParam

Parameters

string $param_name

The name of the parameter

Return Value

mixed

Returns an array or string depending on the type of parameter

in SolrParams at line 73
final mixed getParam(string $param_name)

(PECL solr >= 0.9.2)
Returns a parameter value

Parameters

string $param_name

The name of the parameter

Return Value

mixed

Returns an array or string depending on the type of parameter

in SolrParams at line 83
final array getParams()

(PECL solr >= 0.9.2)
Returns an array of non URL-encoded parameters

Return Value

array

Returns an array of non URL-encoded parameters

in SolrParams at line 93
final array getPreparedParams()

(PECL solr >= 0.9.2)
Returns an array of URL-encoded parameters

Return Value

array

Returns an array of URL-encoded parameters

in SolrParams at line 103
final string|null serialize()

(PECL solr >= 0.9.2)
Used for custom serialization

Return Value

string|null

The string representation of the object or null

in SolrParams at line 119
final SolrParams|false set(string $name, string $value)

(PECL solr >= 0.9.2)
An alias of SolrParams::setParam

Parameters

string $name

The name of the parameter

string $value

The parameter value

Return Value

SolrParams|false

Returns a SolrParams instance on success and FALSE on failure.

in SolrParams at line 135
SolrParams|false setParam(string $name, string $value)

(PECL solr >= 0.9.2)
Sets the parameter to the specified value

Parameters

string $name

The name of the parameter

string $value

The parameter value

Return Value

SolrParams|false

Returns a SolrParams instance on success and FALSE on failure.

in SolrParams at line 148
final string|false toString(bool $url_encode = false)

(PECL solr >= 0.9.2)
Returns all the name-value pair parameters in the object

Parameters

bool $url_encode

Whether to return URL-encoded values

Return Value

string|false

Returns a string on success and FALSE on failure.

in SolrParams at line 158
final void unserialize(string $serialized)

(PECL solr >= 0.9.2)
Used for custom serialization

Parameters

string $serialized

The serialized representation of the object

Return Value

void

in SolrQuery at line 298
__construct(string $q = '')

(PECL solr >= 0.9.2)
SolrQuery constructor.

Parameters

string $q

Optional search query

in SolrQuery at line 305
__destruct()

(PECL solr >= 0.9.2)
Destructor

in SolrQuery at line 44
SolrQuery addExpandFilterQuery(string $fq)

(PECL solr >= 2.2.0)
Overrides main filter query, determines which documents to include in the main group.

Parameters

string $fq

Return Value

SolrQuery

Returns a SolrQuery object.

in SolrQuery at line 63
SolrQuery addExpandSortField(string $field, string $order)

(PECL solr >= 2.2.0)
Orders the documents within the expanded groups (expand.sort parameter).

Parameters

string $field

Field name

string $order

[optional]

Order ASC/DESC, utilizes SolrQuery::ORDER_* constants.

Default: SolrQuery::ORDER_DESC

Return Value

SolrQuery

Returns a SolrQuery object.

in SolrQuery at line 76
SolrQuery addFacetDateField(string $dateField)

(PECL solr >= 0.9.2)
Maps to facet.date

Parameters

string $dateField

The name of the date field.

Return Value

SolrQuery

Returns a SolrQuery object.

in SolrQuery at line 92
SolrQuery addFacetDateOther(string $value, string $field_override)

(PECL solr >= 0.9.2)
Adds another facet.date.other parameter

Parameters

string $value

The value to use.

string $field_override

The field name for the override.

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 105
SolrQuery addFacetField(string $field)

(PECL solr >= 0.9.2)
Adds another field to the facet

Parameters

string $field

The name of the field

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 118
SolrQuery addFacetQuery(string $facetQuery)

(PECL solr >= 0.9.2)
Adds a facet query

Parameters

string $facetQuery

The facet query

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 131
SolrQuery addField(string $field)

(PECL solr >= 0.9.2)
Specifies which fields to return in the result

Parameters

string $field

The name of the field

Return Value

SolrQuery

Returns a SolrQuery object.

in SolrQuery at line 144
SolrQuery addFilterQuery(string $fq)

(PECL solr >= 0.9.2)
Specifies a filter query

Parameters

string $fq

The filter query

Return Value

SolrQuery

Returns a SolrQuery object.

in SolrQuery at line 155
SolrQuery addGroupField(string $value)

(PECL solr >= 2.2.0)
Add a field to be used to group results.

Parameters

string $value

Return Value

SolrQuery

Returns a SolrQuery object.

in SolrQuery at line 166
SolrQuery addGroupFunction(string $value)

(PECL solr >= 2.2.0)
Allows grouping results based on the unique values of a function query (group.func parameter).

Parameters

string $value

Return Value

SolrQuery

Returns a SolrQuery object.

in SolrQuery at line 177
SolrQuery addGroupQuery(string $value)

(PECL solr >= 2.2.0)
Allows grouping of documents that match the given query.

Parameters

string $value

Return Value

SolrQuery

Returns a SolrQuery object.

in SolrQuery at line 193
SolrQuery addGroupSortField(string $field, int $order)

(PECL solr >= 2.2.0)
Add a group sort field (group.sort parameter).

Parameters

string $field

Field name

int $order

Order ASC/DESC, utilizes SolrQuery::ORDER_* constants

Return Value

SolrQuery

Returns a SolrQuery object.

in SolrQuery at line 206
SolrQuery addHighlightField(string $field)

(PECL solr >= 0.9.2)
Maps to hl.fl

Parameters

string $field

Name of the field

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 219
SolrQuery addMltField(string $field)

(PECL solr >= 0.9.2)
Sets a field to use for similarity

Parameters

string $field

The name of the field

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 235
SolrQuery addMltQueryField(string $field, float $boost)

(PECL solr >= 0.9.2)
Maps to mlt.qf

Parameters

string $field

The name of the field

float $boost

Its boost value

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 251
SolrQuery addSortField(string $field, int $order = SolrQuery::ORDER_DESC)

(PECL solr >= 0.9.2)
Used to control how the results should be sorted

Parameters

string $field

The name of the field

int $order

The sort direction. This should be either SolrQuery::ORDER_ASC or SolrQuery::ORDER_DESC.

Return Value

SolrQuery

Returns a SolrQuery object.

in SolrQuery at line 264
SolrQuery addStatsFacet(string $field)

(PECL solr >= 0.9.2)
Requests a return of sub results for values within the given facet

Parameters

string $field

The name of the field

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 277
SolrQuery addStatsField(string $field)

(PECL solr >= 0.9.2)
Maps to stats.field parameter

Parameters

string $field

The name of the field

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 288
SolrQuery collapse(SolrCollapseFunction $collapseFunction)

(No version information available, might only be in Git)
Collapses the result set to a single document per group

Parameters

SolrCollapseFunction $collapseFunction

Return Value

SolrQuery

Returns a SolrQuery object.

in SolrQuery at line 315
bool getExpand()

(PECL solr >= 2.2.0)
Returns true if group expanding is enabled

Return Value

bool

Returns TRUE if group expanding is enabled

in SolrQuery at line 325
array getExpandFilterQueries()

(PECL solr >= 2.2.0)
Returns the expand filter queries

Return Value

array

Returns the expand filter queries

in SolrQuery at line 335
array getExpandQuery()

(PECL solr >= 2.2.0)
Returns the expand query expand.q parameter

Return Value

array

Returns the expand query expand.q parameter

in SolrQuery at line 345
int getExpandRows()

(PECL solr >= 2.2.0)
Returns The number of rows to display in each group (expand.rows)

Return Value

int

Returns The number of rows to display in each group (expand.rows)

in SolrQuery at line 355
array getExpandSortFields()

(PECL solr >= 2.2.0)
Returns an array of fields

Return Value

array

Returns an array of fields

in SolrQuery at line 365
bool|null getFacet()

(PECL solr >= 0.9.2)
Returns the value of the facet parameter

Return Value

bool|null

Returns a boolean on success and NULL if not set

in SolrQuery at line 378
string|null getFacetDateEnd(string $field_override)

(PECL solr >= 0.9.2)
Returns the value for the facet.date.end parameter

Parameters

string $field_override

[optional]

The name of the field

Return Value

string|null

Returns a string on success and NULL if not set

in SolrQuery at line 388
array|null getFacetDateFields()

(PECL solr >= 0.9.2)
Returns all the facet.date fields

Return Value

array|null

Returns all the facet.date fields as an array or NULL if none was set

in SolrQuery at line 401
string|null getFacetDateGap(string $field_override)

(PECL solr >= 0.9.2)
Returns the value of the facet.date.gap parameter

Parameters

string $field_override

[optional]

The name of the field

Return Value

string|null

Returns a string on success and NULL if not set

in SolrQuery at line 414
string|null getFacetDateHardEnd(string $field_override)

(PECL solr >= 0.9.2)
Returns the value of the facet.date.hardend parameter

Parameters

string $field_override

[optional]

The name of the field

Return Value

string|null

Returns a string on success and NULL if not set

in SolrQuery at line 427
array|null getFacetDateOther(string $field_override)

(PECL solr >= 0.9.2)
Returns the value for the facet.date.other parameter

Parameters

string $field_override

[optional]

The name of the field

Return Value

array|null

Returns an array on success and NULL if not set

in SolrQuery at line 440
string|null getFacetDateStart(string $field_override)

(PECL solr >= 0.9.2)
Returns the lower bound for the first date range for all date faceting on this field

Parameters

string $field_override

[optional]

The name of the field

Return Value

string|null

Returns a string on success and NULL if not set

in SolrQuery at line 450
array|null getFacetFields()

(PECL solr >= 0.9.2)
Returns all the facet fields

Return Value

array|null

Returns an array of all the fields and NULL if none was set

in SolrQuery at line 463
int|null getFacetLimit(string $field_override)

(PECL solr >= 0.9.2)
Returns the maximum number of constraint counts that should be returned for the facet fields

Parameters

string $field_override

[optional]

The name of the field

Return Value

int|null

Returns an integer on success and NULL if not set

in SolrQuery at line 476
string|null getFacetMethod(string $field_override)

(PECL solr >= 0.9.2)
Returns the value of the facet.method parameter

Parameters

string $field_override

[optional]

The name of the field

Return Value

string|null

Returns a string on success and NULL if not set

in SolrQuery at line 489
int|null getFacetMinCount(string $field_override)

(PECL solr >= 0.9.2)
Returns the minimum counts for facet fields should be included in the response

Parameters

string $field_override

[optional]

The name of the field

Return Value

int|null

Returns an integer on success and NULL if not set

in SolrQuery at line 502
string|null getFacetMissing(string $field_override)

(PECL solr >= 0.9.2)
Returns the current state of the facet.missing parameter

Parameters

string $field_override

[optional]

The name of the field

Return Value

string|null

Returns a boolean on success and NULL if not set

in SolrQuery at line 515
int|null getFacetOffset(string $field_override)

(PECL solr >= 0.9.2)
Returns an offset into the list of constraints to be used for pagination

Parameters

string $field_override

[optional]

The name of the field

Return Value

int|null

Returns an integer on success and NULL if not set

in SolrQuery at line 528
string|null getFacetPrefix(string $field_override)

(PECL solr >= 0.9.2)
Returns the facet prefix

Parameters

string $field_override

[optional]

The name of the field

Return Value

string|null

Returns a string on success and NULL if not set

in SolrQuery at line 538
string|null getFacetQueries()

(PECL solr >= 0.9.2)
Returns all the facet queries

Return Value

string|null

Returns an array on success and NULL if not set

in SolrQuery at line 552
int|null getFacetSort(string $field_override)

(PECL solr >= 0.9.2)
Returns the facet sort type

Parameters

string $field_override

[optional]

The name of the field

Return Value

int|null

Returns an integer (SolrQuery::FACET_SORT_INDEX or SolrQuery::FACET_SORT_COUNT) on success or NULL if not set.

in SolrQuery at line 562
string|null getFields()

(PECL solr >= 0.9.2)
Returns the list of fields that will be returned in the response

Return Value

string|null

Returns an array on success and NULL if not set

in SolrQuery at line 572
string|null getFilterQueries()

(PECL solr >= 0.9.2)
Returns an array of filter queries

Return Value

string|null

Returns an array on success and NULL if not set

in SolrQuery at line 582
bool getGroup()

(PECL solr >= 2.2.0)
Returns true if grouping is enabled https://secure.php.net/manual/en/solrquery.getgroup.php

Return Value

bool

Returns true if grouping is enabled

in SolrQuery at line 592
int getGroupCachePercent()

(PECL solr >= 2.2.0)
Returns group cache percent value

Return Value

int

Returns group cache percent value

in SolrQuery at line 602
bool getGroupFacet()

(PECL solr >= 2.2.0)
Returns the group.facet parameter value

Return Value

bool

Returns the group.facet parameter value

in SolrQuery at line 612
array getGroupFields()

(PECL solr >= 2.2.0)
Returns group fields (group.field parameter values)

Return Value

array

Returns group fields (group.field parameter values)

in SolrQuery at line 622
string getGroupFormat()

(PECL solr >= 2.2.0)
Returns the group.format value

Return Value

string

Returns the group.format value

in SolrQuery at line 632
array getGroupFunctions()

(PECL solr >= 2.2.0)
Returns group functions (group.func parameter values)

Return Value

array

Returns group functions (group.func parameter values)

in SolrQuery at line 642
int getGroupLimit()

(PECL solr >= 2.2.0)
Returns the group.limit value

Return Value

int

Returns the group.limit value

in SolrQuery at line 652
bool getGroupMain()

(PECL solr >= 2.2.0)
Returns the group.main value

Return Value

bool

Returns the group.main value

in SolrQuery at line 662
bool getGroupNGroups()

(PECL solr >= 2.2.0)
Returns the group.ngroups value

Return Value

bool

Returns the group.ngroups value

in SolrQuery at line 672
bool getGroupOffset()

(PECL solr >= 2.2.0)
Returns the group.offset value

Return Value

bool

Returns the group.offset value

in SolrQuery at line 682
array getGroupQueries()

(PECL solr >= 2.2.0)
Returns all the group.query parameter values

Return Value

array

Returns all the group.query parameter values

in SolrQuery at line 692
array getGroupSortFields()

(PECL solr >= 2.2.0)
Returns the group.sort value

Return Value

array

Returns all the group.sort parameter values

in SolrQuery at line 702
bool getGroupTruncate()

(PECL solr >= 2.2.0)
Returns the group.truncate value

Return Value

bool

Returns the group.truncate value

in SolrQuery at line 712
bool getHighlight()

(PECL solr >= 0.9.2)
Returns the state of the hl parameter

Return Value

bool

Returns the state of the hl parameter

in SolrQuery at line 725
string|null getHighlightAlternateField(string $field_override)

(PECL solr >= 0.9.2)
Returns the highlight field to use as backup or default

Parameters

string $field_override

[optional]

The name of the field

Return Value

string|null

Returns a string on success and NULL if not set

in SolrQuery at line 735
array|null getHighlightFields()

(PECL solr >= 0.9.2)
Returns all the fields that Solr should generate highlighted snippets for

Return Value

array|null

Returns an array on success and NULL if not set

in SolrQuery at line 748
string|null getHighlightFormatter(string $field_override)

(PECL solr >= 0.9.2)
Returns the formatter for the highlighted output

Parameters

string $field_override

[optional]

The name of the field

Return Value

string|null

Returns a string on success and NULL if not set

in SolrQuery at line 761
string|null getHighlightFragmenter(string $field_override)

(PECL solr >= 0.9.2)
Returns the text snippet generator for highlighted text

Parameters

string $field_override

[optional]

The name of the field

Return Value

string|null

Returns a string on success and NULL if not set

in SolrQuery at line 774
int|null getHighlightFragsize(string $field_override)

(PECL solr >= 0.9.2)
Returns the number of characters of fragments to consider for highlighting

Parameters

string $field_override

[optional]

The name of the field

Return Value

int|null

Returns an integer on success and NULL if not set

in SolrQuery at line 784
bool|null getHighlightHighlightMultiTerm()

(PECL solr >= 0.9.2)
Returns whether or not to enable highlighting for range/wildcard/fuzzy/prefix queries

Return Value

bool|null

Returns a boolean on success and NULL if not set

in SolrQuery at line 797
int|null getHighlightMaxAlternateFieldLength(string $field_override)

(PECL solr >= 0.9.2)
Returns the maximum number of characters of the field to return

Parameters

string $field_override

[optional]

The name of the field

Return Value

int|null

Returns an integer on success and NULL if not set

in SolrQuery at line 807
int|null getHighlightMaxAnalyzedChars()

(PECL solr >= 0.9.2)
Returns the maximum number of characters into a document to look for suitable snippets

Return Value

int|null

Returns an integer on success and NULL if not set

in SolrQuery at line 820
bool|null getHighlightMergeContiguous(string $field_override)

(PECL solr >= 0.9.2)
Returns whether or not the collapse contiguous fragments into a single fragment

Parameters

string $field_override

[optional]

The name of the field

Return Value

bool|null

Returns a boolean on success and NULL if not set

in SolrQuery at line 830
int|null getHighlightRegexMaxAnalyzedChars()

(PECL solr >= 0.9.2)
Returns the maximum number of characters from a field when using the regex fragmenter

Return Value

int|null

Returns an integer on success and NULL if not set

in SolrQuery at line 840
string getHighlightRegexPattern()

(PECL solr >= 0.9.2)
Returns the regular expression for fragmenting

Return Value

string

Returns a string on success and NULL if not set

in SolrQuery at line 850
float|null getHighlightRegexSlop()

(PECL solr >= 0.9.2)
Returns the deviation factor from the ideal fragment size

Return Value

float|null

Returns a double on success and NULL if not set.

in SolrQuery at line 860
bool|null getHighlightRequireFieldMatch()

(PECL solr >= 0.9.2)
Returns if a field will only be highlighted if the query matched in this particular field

Return Value

bool|null

Returns a boolean on success and NULL if not set

in SolrQuery at line 873
string|null getHighlightSimplePost(string $field_override)

(PECL solr >= 0.9.2)
Returns the text which appears after a highlighted term

Parameters

string $field_override

[optional]

The name of the field

Return Value

string|null

Returns a string on success and NULL if not set

in SolrQuery at line 886
string|null getHighlightSimplePre(string $field_override)

(PECL solr >= 0.9.2)
Returns the text which appears before a highlighted term

Parameters

string $field_override

[optional]

The name of the field

Return Value

string|null

Returns a string on success and NULL if not set

in SolrQuery at line 899
int|null getHighlightSnippets(string $field_override)

(PECL solr >= 0.9.2)
Returns the maximum number of highlighted snippets to generate per field

Parameters

string $field_override

[optional]

The name of the field

Return Value

int|null

Returns an integer on success and NULL if not set

in SolrQuery at line 909
bool|null getHighlightUsePhraseHighlighter()

(PECL solr >= 0.9.2)
Returns the state of the hl.usePhraseHighlighter parameter

Return Value

bool|null

Returns a boolean on success and NULL if not set

in SolrQuery at line 919
bool|null getMlt()

(PECL solr >= 0.9.2)
Returns whether or not MoreLikeThis results should be enabled

Return Value

bool|null

Returns a boolean on success and NULL if not set

in SolrQuery at line 929
bool|null getMltBoost()

(PECL solr >= 0.9.2)
Returns whether or not the query will be boosted by the interesting term relevance

Return Value

bool|null

Returns a boolean on success and NULL if not set

in SolrQuery at line 939
int|null getMltCount()

(PECL solr >= 0.9.2)
Returns the number of similar documents to return for each result

Return Value

int|null

Returns an integer on success and NULL if not set

in SolrQuery at line 949
array getMltFields()

(PECL solr >= 0.9.2)
Returns all the fields to use for similarity

Return Value

array

Returns an array on success and NULL if not set

in SolrQuery at line 959
int|null getMltMaxNumQueryTerms()

(PECL solr >= 0.9.2)
Returns the maximum number of query terms that will be included in any generated query

Return Value

int|null

Returns an integer on success and NULL if not set

in SolrQuery at line 969
int getMltMaxNumTokens()

(PECL solr >= 0.9.2)
Returns the maximum number of tokens to parse in each document field that is not stored with TermVector support

Return Value

int

Returns an integer on success and NULL if not set

in SolrQuery at line 979
int|null getMltMaxWordLength()

(PECL solr >= 0.9.2)
Returns the maximum word length above which words will be ignored

Return Value

int|null

Returns an integer on success and NULL if not set

in SolrQuery at line 989
int|null getMltMinDocFrequency()

(PECL solr >= 0.9.2)
Returns the threshold frequency at which words will be ignored which do not occur in at least this many docs

Return Value

int|null

Returns an integer on success and NULL if not set

in SolrQuery at line 999
int|null getMltMinTermFrequency()

(PECL solr >= 0.9.2)
Returns the frequency below which terms will be ignored in the source document

Return Value

int|null

Returns an integer on success and NULL if not set

in SolrQuery at line 1009
int getMltMinWordLength()

(PECL solr >= 0.9.2)
Returns the minimum word length below which words will be ignored

Return Value

int

Returns an integer on success and NULL if not set

in SolrQuery at line 1019
array|null getMltQueryFields()

(PECL solr >= 0.9.2)
Returns the query fields and their boosts

Return Value

array|null

Returns an array on success and NULL if not set

in SolrQuery at line 1029
string getQuery()

(PECL solr >= 0.9.2)
Returns the main query

Return Value

string

Returns a string on success and NULL if not set

in SolrQuery at line 1039
int|null getRows()

(PECL solr >= 0.9.2)
Returns the maximum number of documents

Return Value

int|null

Returns an integer on success and NULL if not set

in SolrQuery at line 1049
array getSortFields()

(PECL solr >= 0.9.2)
Returns all the sort fields

Return Value

array

Returns an array on success and NULL if none of the parameters was set.

in SolrQuery at line 1059
int|null getStart()

(PECL solr >= 0.9.2)
Returns the offset in the complete result set

Return Value

int|null

Returns an integer on success and NULL if not set

in SolrQuery at line 1069
bool|null getStats()

(PECL solr >= 0.9.2)
Returns whether or not stats is enabled

Return Value

bool|null

Returns a boolean on success and NULL if not set

in SolrQuery at line 1079
array|null getStatsFacets()

(PECL solr >= 0.9.2)
Returns all the stats facets that were set

Return Value

array|null

Returns an array on success and NULL if not set

in SolrQuery at line 1089
array|null getStatsFields()

(PECL solr >= 0.9.2)
Returns all the statistics fields

Return Value

array|null

Returns an array on success and NULL if not set

in SolrQuery at line 1099
bool|null getTerms()

(PECL solr >= 0.9.2)
Returns whether or not the TermsComponent is enabled

Return Value

bool|null

Returns a boolean on success and NULL if not set

in SolrQuery at line 1109
string|null getTermsField()

(PECL solr >= 0.9.2)
Returns the field from which the terms are retrieved

Return Value

string|null

Returns a string on success and NULL if not set

in SolrQuery at line 1119
bool|null getTermsIncludeLowerBound()

(PECL solr >= 0.9.2)
Returns whether or not to include the lower bound in the result set

Return Value

bool|null

Returns a boolean on success and NULL if not set

in SolrQuery at line 1129
bool|null getTermsIncludeUpperBound()

(PECL solr >= 0.9.2)
Returns whether or not to include the upper bound term in the result set

Return Value

bool|null

Returns a boolean on success and NULL if not set

in SolrQuery at line 1139
int|null getTermsLimit()

(PECL solr >= 0.9.2)
Returns the maximum number of terms Solr should return

Return Value

int|null

Returns an integer on success and NULL if not set

in SolrQuery at line 1149
string|null getTermsLowerBound()

(PECL solr >= 0.9.2)
Returns the term to start at

Return Value

string|null

Returns a string on success and NULL if not set

in SolrQuery at line 1159
int|null getTermsMaxCount()

(PECL solr >= 0.9.2)
Returns the maximum document frequency

Return Value

int|null

Returns an integer on success and NULL if not set

in SolrQuery at line 1169
int|null getTermsMinCount()

(PECL solr >= 0.9.2)
Returns the minimum document frequency to return in order to be included

Return Value

int|null

Returns an integer on success and NULL if not set

in SolrQuery at line 1179
string|null getTermsPrefix()

(PECL solr >= 0.9.2)
Returns the term prefix

Return Value

string|null

Returns a string on success and NULL if not set

in SolrQuery at line 1189
bool|null getTermsReturnRaw()

(PECL solr >= 0.9.2)
Whether or not to return raw characters

Return Value

bool|null

Returns a boolean on success and NULL if not set

in SolrQuery at line 1201
int|null getTermsSort()

(PECL solr >= 0.9.2)
Returns an integer indicating how terms are sorted

Return Value

int|null

Returns an integer on success and NULL if not set
SolrQuery::TERMS_SORT_INDEX indicates that the terms are returned by index order.
SolrQuery::TERMS_SORT_COUNT implies that the terms are sorted by term frequency (highest count first)

in SolrQuery at line 1211
string|null getTermsUpperBound()

(PECL solr >= 0.9.2)
Returns the term to stop at

Return Value

string|null

Returns a string on success and NULL if not set

in SolrQuery at line 1221
int|null getTimeAllowed()

(PECL solr >= 0.9.2)
Returns the time in milliseconds allowed for the query to finish

Return Value

int|null

Returns an integer on success and NULL if not set

in SolrQuery at line 1232
SolrQuery removeExpandFilterQuery(string $fq)

(PECL solr >= 2.2.0)
Removes an expand filter query

Parameters

string $fq

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1245
SolrQuery removeExpandSortField(string $field)

(PECL solr >= 2.2.0)
Removes an expand sort field from the expand.sort parameter.

Parameters

string $field

Field name

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1258
SolrQuery removeFacetDateField(string $field)

(PECL solr >= 0.9.2)
Removes one of the facet date fields

Parameters

string $field

The name of the date field to remove

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1274
SolrQuery removeFacetDateOther(string $value, string $field_override)

(PECL solr >= 0.9.2)
Removes one of the facet.date.other parameters

Parameters

string $value

The value

string $field_override

[optional]

The name of the field.

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1287
SolrQuery removeFacetField(string $field)

(PECL solr >= 0.9.2)
Removes one of the facet.date parameters

Parameters

string $field

The name of the field

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1300
SolrQuery removeFacetQuery(string $value)

(PECL solr >= 0.9.2)
Removes one of the facet.query parameters

Parameters

string $value

The value

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1313
SolrQuery removeField(string $field)

(PECL solr >= 0.9.2)
Removes a field from the list of fields

Parameters

string $field

The name of the field

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1324
SolrQuery removeFilterQuery(string $fq)

(PECL solr >= 0.9.2)
Removes a filter query

Parameters

string $fq

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1337
SolrQuery removeHighlightField(string $field)

(PECL solr >= 0.9.2)
Removes one of the fields used for highlighting

Parameters

string $field

The name of the field

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1350
SolrQuery removeMltField(string $field)

(PECL solr >= 0.9.2)
Removes one of the moreLikeThis fields

Parameters

string $field

The name of the field

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1363
SolrQuery removeMltQueryField(string $queryField)

(PECL solr >= 0.9.2)
Removes one of the moreLikeThis query fields

Parameters

string $queryField

The query field

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1376
SolrQuery removeSortField(string $field)

(PECL solr >= 0.9.2)
Removes one of the sort fields

Parameters

string $field

The name of the field

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1389
SolrQuery removeStatsFacet(string $value)

(PECL solr >= 0.9.2)
Removes one of the stats.facet parameters

Parameters

string $value

The value

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1402
SolrQuery removeStatsField(string $field)

(PECL solr >= 0.9.2)
Removes one of the stats.field parameters

Parameters

string $field

The name of the field

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1415
SolrQuery setEchoHandler(bool $flag)

(PECL solr >= 0.9.2)
Toggles the echoHandler parameter

Parameters

bool $flag

TRUE or FALSE

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1434
SolrQuery setEchoParams(string $type)

(PECL solr >= 0.9.2)
Determines what kind of parameters to include in the response

Parameters

string $type

The type of parameters to include:

  • none: don't include any request parameters for debugging
  • explicit: include the parameters explicitly specified by the client in the request
  • all: include all parameters involved in this request, either specified explicitly by the client, or implicit because of the request handler configuration.

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1447
SolrQuery setExpand(bool $value)

(PECL solr >= 2.2.0)
Enables/Disables the Expand Component

Parameters

bool $value

Bool flag

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1458
SolrQuery setExpandQuery(string $q)

(PECL solr >= 2.2.0)
Sets the expand.q parameter

Parameters

string $q

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1469
SolrQuery setExpandRows(int $value)

(PECL solr >= 2.2.0)
Sets the number of rows to display in each group (expand.rows). Server Default 5

Parameters

int $value

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1482
SolrQuery setExplainOther(string $query)

(PECL solr >= 0.9.2)
Sets the explainOther common query parameter

Parameters

string $query

The Lucene query to identify a set of documents

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1495
SolrQuery setFacet(bool $flag)

(PECL solr >= 0.9.2)
Maps to the facet parameter. Enables or disables facetting

Parameters

bool $flag

TRUE enables faceting and FALSE disables it.

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1511
SolrQuery setFacetDateEnd(string $value, string $field_override)

(PECL solr >= 0.9.2)
Maps to facet.date.end

Parameters

string $value

See facet.date.end

string $field_override

[optional]

Name of the field

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1527
SolrQuery setFacetDateGap(string $value, string $field_override)

(PECL solr >= 0.9.2)
Maps to facet.date.gap

Parameters

string $value

See facet.date.gap

string $field_override

[optional]

Name of the field

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1543
SolrQuery setFacetDateHardEnd(bool $value, string $field_override)

(PECL solr >= 0.9.2)
Maps to facet.date.hardend

Parameters

bool $value

See facet.date.hardend

string $field_override

[optional]

Name of the field

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1559
SolrQuery setFacetDateStart(string $value, string $field_override)

(PECL solr >= 0.9.2)
Maps to facet.date.start

Parameters

string $value

See facet.date.start

string $field_override

[optional]

Name of the field

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1575
SolrQuery setFacetEnumCacheMinDefaultFrequency(int $frequency, string $field_override)

(PECL solr >= 0.9.2)
Sets the minimum document frequency used for determining term count

Parameters

int $frequency

The minimum frequency

string $field_override

[optional]

Name of the field

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1591
SolrQuery setFacetLimit(int $limit, string $field_override)

(PECL solr >= 0.9.2)
Maps to facet.limit

Parameters

int $limit

The maximum number of constraint counts

string $field_override

[optional]

Name of the field

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1607
SolrQuery setFacetMethod(string $method, string $field_override)

(PECL solr >= 0.9.2)
Specifies the type of algorithm to use when faceting a field

Parameters

string $method

The method to use.

string $field_override

[optional]

Name of the field

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1623
SolrQuery setFacetMinCount(int $mincount, string $field_override)

(PECL solr >= 0.9.2)
Maps to facet.mincount

Parameters

int $mincount

The minimum count

string $field_override

[optional]

Name of the field

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1639
SolrQuery setFacetMissing(bool $flag, string $field_override)

(PECL solr >= 0.9.2)
Maps to facet.missing

Parameters

bool $flag

TRUE turns this feature on. FALSE disables it.

string $field_override

[optional]

Name of the field

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1655
SolrQuery setFacetOffset(int $offset, string $field_override)

(PECL solr >= 0.9.2)
Sets the offset into the list of constraints to allow for pagination

Parameters

int $offset

The offset

string $field_override

[optional]

Name of the field

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1671
SolrQuery setFacetPrefix(string $prefix, string $field_override)

(PECL solr >= 0.9.2)
Specifies a string prefix with which to limits the terms on which to facet

Parameters

string $prefix

The prefix string

string $field_override

[optional]

Name of the field

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1687
SolrQuery setFacetSort(int $facetSort, string $field_override)

(PECL solr >= 0.9.2)
Determines the ordering of the facet field constraints

Parameters

int $facetSort

Use SolrQuery::FACET_SORT_INDEX for sorting by index order or SolrQuery::FACET_SORT_COUNT for sorting by count.

string $field_override

[optional]

Name of the field

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1698
SolrQuery setGroup(bool $value)

(PECL solr >= 2.2.0)
Enable/Disable result grouping (group parameter)

Parameters

bool $value

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1714
SolrQuery setGroupCachePercent(int $percent)

(PECL solr >= 2.2.0)
Enables caching for result grouping

Parameters

int $percent

Setting this parameter to a number greater than 0 enables caching for result grouping. Result Grouping executes two searches; this option caches the second search. The server default value is 0. Testing has shown that group caching only improves search time with Boolean, wildcard, and fuzzy queries. For simple queries like term or "match all" queries, group caching degrades performance. group.cache.percent parameter.

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1725
SolrQuery setGroupFacet(bool $value)

(PECL solr >= 2.2.0)
Sets group.facet parameter

Parameters

bool $value

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1740
SolrQuery setGroupFormat(string $value)

(PECL solr >= 2.2.0)
Sets the group format, result structure (group.format parameter).

Parameters

string $value

Sets the group.format parameter. If this parameter is set to simple, the grouped documents are presented in a single flat list, and the start and rows parameters affect the numbers of documents instead of groups.
Accepts: grouped/simple

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1751
SolrQuery setGroupLimit(int $value)

(PECL solr >= 2.2.0)
Specifies the number of results to return for each group. The server default value is 1.

Parameters

int $value

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1763
SolrQuery setGroupMain(string $value)

(PECL solr >= 2.2.0)
If true, the result of the first field grouping command is used as the main result list in the response, using group.format=simple.

Parameters

string $value

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1774
SolrQuery setGroupNGroups(bool $value)

(PECL solr >= 2.2.0)
If true, Solr includes the number of groups that have matched the query in the results.

Parameters

bool $value

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1785
SolrQuery setGroupOffset(int $value)

(PECL solr >= 2.2.0)
Sets the group.offset parameter.

Parameters

int $value

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1796
SolrQuery setGroupTruncate(bool $value)

(PECL solr >= 2.2.0)
If true, facet counts are based on the most relevant document of each group matching the query.

Parameters

bool $value

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1810
SolrQuery setHighlight(bool $flag)

(PECL solr >= 0.9.2)
Enables or disables highlighting

Parameters

bool $flag

Setting it to TRUE enables highlighted snippets to be generated in the query response.
Setting it to FALSE disables highlighting

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1826
SolrQuery setHighlightAlternateField(string $field, string $field_override)

(PECL solr >= 0.9.2)
Specifies the backup field to use

Parameters

string $field

The name of the backup field

string $field_override

[optional]

Name of the field

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1842
SolrQuery setHighlightFormatter(string $formatter, string $field_override)

(PECL solr >= 0.9.2)
Specify a formatter for the highlight output

Parameters

string $formatter

Currently the only legal value is "simple"

string $field_override

[optional]

Name of the field

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1859
SolrQuery setHighlightFragmenter(string $fragmenter, string $field_override)

(PECL solr >= 0.9.2)
Sets a text snippet generator for highlighted text

Parameters

string $fragmenter

The standard fragmenter is gap. Another option is regex, which tries to create fragments that resembles a certain regular expression

string $field_override

[optional]

Name of the field

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1875
SolrQuery setHighlightFragsize(int $size, string $field_override)

(PECL solr >= 0.9.2)
The size of fragments to consider for highlighting

Parameters

int $size

The size, in characters, of fragments to consider for highlighting

string $field_override

[optional]

Name of the field

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1889
SolrQuery setHighlightHighlightMultiTerm(bool $flag)

(PECL solr >= 0.9.2)
Use SpanScorer to highlight phrase terms

Parameters

bool $flag

Whether or not to use SpanScorer to highlight phrase terms only when they appear within the query phrase in the document.

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1912
SolrQuery setHighlightMaxAlternateFieldLength(int $fieldLength, string $field_override)

(PECL solr >= 0.9.2)
Sets the maximum number of characters of the field to return

Parameters

int $fieldLength

The length of the field

If SolrQuery::setHighlightAlternateField() was passed the value TRUE, this parameter specifies the maximum number of characters of the field to return

Any value less than or equal to 0 means unlimited.

string $field_override

[optional]

Name of the field

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1925
SolrQuery setHighlightMaxAnalyzedChars(int $value)

(PECL solr >= 0.9.2)
Specifies the number of characters into a document to look for suitable snippets

Parameters

int $value

The number of characters into a document to look for suitable snippets

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1941
SolrQuery setHighlightMergeContiguous(bool $flag, string $field_override)

(PECL solr >= 0.9.2)
Whether or not to collapse contiguous fragments into a single fragment

Parameters

bool $flag

Whether or not to collapse contiguous fragments into a single fragment

string $field_override

[optional]

Name of the field

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1954
SolrQuery setHighlightRegexMaxAnalyzedChars(int $maxAnalyzedChars)

(PECL solr >= 0.9.2)
Specify the maximum number of characters to analyze

Parameters

int $maxAnalyzedChars

The maximum number of characters to analyze from a field when using the regex fragmenter

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1967
SolrQuery setHighlightRegexPattern(string $value)

(PECL solr >= 0.9.2)
Specify the regular expression for fragmenting

Parameters

string $value

The regular expression for fragmenting. This could be used to extract sentences

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1981
SolrQuery setHighlightRegexSlop(float $factor)

(PECL solr >= 0.9.2)
Sets the factor by which the regex fragmenter can stray from the ideal fragment size

Parameters

float $factor

The factor by which the regex fragmenter can stray from the ideal fragment size (specified by SolrQuery::setHighlightFragsize) to accommodate the regular expression.

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 1995
SolrQuery setHighlightRequireFieldMatch(bool $flag)

(PECL solr >= 0.9.2)
Require field matching during highlighting

Parameters

bool $flag

If TRUE, then a field will only be highlighted if the query matched in this particular field.
This will only work if SolrQuery::setHighlightUsePhraseHighlighter() was set to TRUE.

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 2011
SolrQuery setHighlightSimplePost(string $simplePost, string $field_override)

(PECL solr >= 0.9.2)
Sets the text which appears after a highlighted term

Parameters

string $simplePost

Sets the text which appears after a highlighted term. The default is </em>

string $field_override

[optional]

Name of the field

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 2027
SolrQuery setHighlightSimplePre(string $simplePre, string $field_override)

(PECL solr >= 0.9.2)
Sets the text which appears before a highlighted term

Parameters

string $simplePre

Sets the text which appears before a highlighted term. The default is <em>

string $field_override

[optional]

Name of the field

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 2043
SolrQuery setHighlightSnippets(int $value, string $field_override)

(PECL solr >= 0.9.2)
Sets the maximum number of highlighted snippets to generate per field

Parameters

int $value

The maximum number of highlighted snippets to generate per field

string $field_override

[optional]

Name of the field

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 2057
SolrQuery setHighlightUsePhraseHighlighter(bool $flag)

(PECL solr >= 0.9.2)
Whether to highlight phrase terms only when they appear within the query phrase

Parameters

bool $flag

Whether or not to use SpanScorer to highlight phrase terms only when they appear within the query phrase in the document.

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 2070
SolrQuery setMlt(bool $flag)

(PECL solr >= 0.9.2)
Enables or disables moreLikeThis

Parameters

bool $flag

TRUE enables it and FALSE turns it off.

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 2083
SolrQuery setMltBoost(bool $flag)

(PECL solr >= 0.9.2)
Set if the query will be boosted by the interesting term relevance

Parameters

bool $flag

Sets to TRUE or FALSE

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 2096
SolrQuery setMltCount(int $count)

(PECL solr >= 0.9.2)
Set the number of similar documents to return for each result

Parameters

int $count

The number of similar documents to return for each result

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 2109
SolrQuery setMltMaxNumQueryTerms(int $value)

(PECL solr >= 0.9.2)
Sets the maximum number of query terms included

Parameters

int $value

The maximum number of query terms that will be included in any generated query

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 2122
SolrQuery setMltMaxNumTokens(int $value)

(PECL solr >= 0.9.2)
Specifies the maximum number of tokens to parse

Parameters

int $value

The maximum number of tokens to parse

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 2135
SolrQuery setMltMaxWordLength(int $maxWordLength)

(PECL solr >= 0.9.2)
Sets the maximum word length

Parameters

int $maxWordLength

The maximum word length above which words will be ignored

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 2148
SolrQuery setMltMinDocFrequency(int $minDocFrequency)

(PECL solr >= 0.9.2)
Sets the mltMinDoc frequency

Parameters

int $minDocFrequency

Sets the frequency at which words will be ignored which do not occur in at least this many docs.

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 2161
SolrQuery setMltMinTermFrequency(int $minTermFrequency)

(PECL solr >= 0.9.2)
Sets the frequency below which terms will be ignored in the source docs

Parameters

int $minTermFrequency

The frequency below which terms will be ignored in the source docs

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 2174
SolrQuery setMltMinWordLength(int $minWordLength)

(PECL solr >= 0.9.2)
Sets the minimum word length

Parameters

int $minWordLength

The minimum word length below which words will be ignored

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 2187
SolrQuery setOmitHeader(bool $flag)

(PECL solr >= 0.9.2)
Exclude the header from the returned results

Parameters

bool $flag

TRUE excludes the header from the result.

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 2200
SolrQuery setQuery(string $query)

(PECL solr >= 0.9.2)
Sets the search query

Parameters

string $query

The search query

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 2213
SolrQuery setRows(int $rows)

(PECL solr >= 0.9.2)
Specifies the maximum number of rows to return in the result

Parameters

int $rows

The maximum number of rows to return

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 2226
SolrQuery setShowDebugInfo(bool $flag)

(PECL solr >= 0.9.2)
Flag to show debug information

Parameters

bool $flag

Whether to show debug info. TRUE or FALSE

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 2239
SolrQuery setStart(int $start)

(PECL solr >= 0.9.2)
Specifies the number of rows to skip

Parameters

int $start

The number of rows to skip.

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 2252
SolrQuery setStats(bool $flag)

(PECL solr >= 0.9.2)
Enables or disables the Stats component

Parameters

bool $flag

TRUE turns on the stats component and FALSE disables it.

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 2265
SolrQuery setTerms(bool $flag)

(PECL solr >= 0.9.2)
Enables or disables the TermsComponent

Parameters

bool $flag

TRUE enables it. FALSE turns it off

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 2278
SolrQuery setTermsField(string $fieldname)

(PECL solr >= 0.9.2)
Sets the name of the field to get the Terms from

Parameters

string $fieldname

The field name

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 2291
SolrQuery setTermsIncludeLowerBound(bool $flag)

(PECL solr >= 0.9.2)
Include the lower bound term in the result set

Parameters

bool $flag

Include the lower bound term in the result set

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 2304
SolrQuery setTermsIncludeUpperBound(bool $flag)

(PECL solr >= 0.9.2)
Include the upper bound term in the result set

Parameters

bool $flag

TRUE or FALSE

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 2317
SolrQuery setTermsLimit(int $limit)

(PECL solr >= 0.9.2)
Sets the maximum number of terms to return

Parameters

int $limit

The maximum number of terms to return. All the terms will be returned if the limit is negative.

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 2330
SolrQuery setTermsLowerBound(string $lowerBound)

(PECL solr >= 0.9.2)
Specifies the Term to start from

Parameters

string $lowerBound

The lower bound Term

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 2343
SolrQuery setTermsMaxCount(int $frequency)

(PECL solr >= 0.9.2)
Sets the maximum document frequency

Parameters

int $frequency

The maximum document frequency.

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 2356
SolrQuery setTermsMinCount(int $frequency)

(PECL solr >= 0.9.2)
Sets the minimum document frequency

Parameters

int $frequency

The minimum frequency

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 2369
SolrQuery setTermsPrefix(string $prefix)

(PECL solr >= 0.9.2)
Restrict matches to terms that start with the prefix

Parameters

string $prefix

Restrict matches to terms that start with the prefix

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 2382
SolrQuery setTermsReturnRaw(bool $flag)

(PECL solr >= 0.9.2)
Return the raw characters of the indexed term

Parameters

bool $flag

TRUE or FALSE

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 2396
SolrQuery setTermsSort(int $sortType)

(PECL solr >= 0.9.2)
Specifies how to sort the returned terms

Parameters

int $sortType

If SolrQuery::TERMS_SORT_COUNT, sorts the terms by the term frequency (highest count first).
If SolrQuery::TERMS_SORT_INDEX, returns the terms in index order

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 2409
SolrQuery setTermsUpperBound(string $upperBound)

(PECL solr >= 0.9.2)
Sets the term to stop at

Parameters

string $upperBound

The term to stop at

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

in SolrQuery at line 2424
SolrQuery setTimeAllowed(int $timeAllowed)

(PECL solr >= 0.9.2)
The time allowed for search to finish

Parameters

int $timeAllowed

The time allowed for a search to finish. This value only applies to the search and not to requests in general. Time is in milliseconds. Values less than or equal to zero implies no time restriction. Partial results may be returned, if there are any.

Return Value

SolrQuery

Returns the current SolrQuery object, if the return value is used.

at line 33
SolrDisMaxQuery addBigramPhraseField(string $field, string $boost, string $slop)

(PECL solr >= 2.1.0)
Adds a Phrase Bigram Field (pf2 parameter)

Parameters

string $field

Field name

string $boost

[optional]

Boost value. Boosts documents with matching terms.

string $slop

[optional]

Field Slop

Return Value

SolrDisMaxQuery

at line 48
SolrDisMaxQuery addBoostQuery(string $field, string $value, string $boost)

(PECL solr >= 2.1.0)
Adds a boost query field with value and optional boost (bq parameter)

Parameters

string $field

Field name

string $value
string $boost

[optional]

Boost value. Boosts documents with matching terms.

Return Value

SolrDisMaxQuery

at line 65
SolrDisMaxQuery addPhraseField(string $field, string $boost, string $slop)

(PECL solr >= 2.1.0)
Adds a Phrase Field (pf parameter)

Parameters

string $field

Field name

string $boost

[optional]

Boost value. Boosts documents with matching terms.

string $slop

[optional]

Field Slop

Return Value

SolrDisMaxQuery

at line 79
SolrDisMaxQuery addQueryField(string $field, string $boost)

(PECL solr >= 2.1.0)
Add a query field with optional boost (qf parameter)

Parameters

string $field

Field name

string $boost

[optional]

Boost value. Boosts documents with matching terms.

Return Value

SolrDisMaxQuery

at line 96
SolrDisMaxQuery addTrigramPhraseField(string $field, string $boost, string $slop)

(PECL solr >= 2.1.0)
Adds a Trigram Phrase Field (pf3 parameter)

Parameters

string $field

Field name

string $boost

[optional]

Boost value. Boosts documents with matching terms.

string $slop

[optional]

Field Slop

Return Value

SolrDisMaxQuery

at line 107
SolrDisMaxQuery addUserField(string $field)

(PECL solr >= 2.1.0)
Adds a field to User Fields Parameter (uf)

Parameters

string $field

Field name

Return Value

SolrDisMaxQuery

at line 118
SolrDisMaxQuery removeBigramPhraseField(string $field)

(PECL solr >= 2.1.0)
Removes phrase bigram field (pf2 parameter)

Parameters

string $field

Field name

Return Value

SolrDisMaxQuery

at line 129
SolrDisMaxQuery removeBoostQuery(string $field)

(PECL solr >= 2.1.0)
Removes a boost query partial by field name (bq)

Parameters

string $field

Field name

Return Value

SolrDisMaxQuery

at line 140
SolrDisMaxQuery removePhraseField(string $field)

(PECL solr >= 2.1.0)
Removes a Phrase Field (pf parameter)

Parameters

string $field

Field name

Return Value

SolrDisMaxQuery

at line 151
SolrDisMaxQuery removeQueryField(string $field)

(PECL solr >= 2.1.0)
Removes a Query Field (qf parameter)

Parameters

string $field

Field name

Return Value

SolrDisMaxQuery

at line 162
SolrDisMaxQuery removeTrigramPhraseField(string $field)

(PECL solr >= 2.1.0)
Removes a Trigram Phrase Field (pf3 parameter)

Parameters

string $field

Field name

Return Value

SolrDisMaxQuery

at line 177
SolrDisMaxQuery removeUserField(string $field)

(PECL solr >= 2.1.0)
Removes a field from The User Fields Parameter (uf)

Warning
This function is currently not documented; only its argument list is available.

Parameters

string $field

Field name

Return Value

SolrDisMaxQuery

at line 188
SolrDisMaxQuery setBigramPhraseFields(string $fields)

(PECL solr >= 2.1.0)
Sets Bigram Phrase Fields and their boosts (and slops) using pf2 parameter

Parameters

string $fields

Fields boosts (slops)

Return Value

SolrDisMaxQuery

at line 199
SolrDisMaxQuery setBigramPhraseSlop(string $slop)

(PECL solr >= 2.1.0)
Sets Bigram Phrase Slop (ps2 parameter)

Parameters

string $slop

A default slop for Bigram phrase fields.

Return Value

SolrDisMaxQuery

at line 212
SolrDisMaxQuery setBoostFunction(string $function)

(PECL solr >= 2.1.0)
Sets a Boost Function (bf parameter).

Parameters

string $function

Functions (with optional boosts) that will be included in the user's query to influence the score. Any function supported natively by Solr can be used, along with a boost value. e.g.:
recip(rord(myfield),1,2,3)^1.5

Return Value

SolrDisMaxQuery

at line 221
SolrDisMaxQuery setBoostQuery(string $q)

(PECL solr >= 2.1.0)
Directly Sets Boost Query Parameter (bq)

Parameters

string $q

Return Value

SolrDisMaxQuery

at line 234
SolrDisMaxQuery setMinimumMatch(string $value)

(PECL solr >= 2.1.0)
Set Minimum "Should" Match (mm)

Parameters

string $value

Minimum match value/expression
Set Minimum "Should" Match parameter (mm). If the default query operator is AND then mm=100%, if the default query operator (q.op) is OR, then mm=0%.

Return Value

SolrDisMaxQuery

at line 245
SolrDisMaxQuery setPhraseFields(string $fields)

(PECL solr >= 2.1.0)
Sets Phrase Fields and their boosts (and slops) using pf2 parameter

Parameters

string $fields

Fields, boosts [, slops]

Return Value

SolrDisMaxQuery

at line 257
SolrDisMaxQuery setPhraseSlop(string $slop)

(PECL solr >= 2.1.0)
Sets the default slop on phrase queries (ps parameter)

Parameters

string $slop

Sets the default amount of slop on phrase queries built with "pf", "pf2" and/or "pf3" fields (affects boosting). "ps" parameter

Return Value

SolrDisMaxQuery

at line 268
SolrDisMaxQuery setQueryAlt(string $q)

(PECL solr >= 2.1.0)
Set Query Alternate (q.alt parameter)

Parameters

string $q

Query String

Return Value

SolrDisMaxQuery

at line 285
SolrDisMaxQuery setQueryPhraseSlop(string $slop)

(PECL solr >= 2.1.0)
Specifies the amount of slop permitted on phrase queries explicitly included in the user's query string (qf parameter)

Parameters

string $slop

Amount of slop
The Query Phrase Slop is the amount of slop permitted on phrase queries explicitly included in the user's query string with the qf parameter.

slop refers to the number of positions one token needs to be moved in relation to another token in order to match a phrase specified in a query.

Return Value

SolrDisMaxQuery

at line 297
SolrDisMaxQuery setTieBreaker(string $tieBreaker)

(PECL solr >= 2.1.0)
Sets Tie Breaker parameter (tie parameter)

Parameters

string $tieBreaker

The tie parameter specifies a float value (which should be something much less than 1) to use as tiebreaker in DisMax queries.

Return Value

SolrDisMaxQuery

at line 308
SolrDisMaxQuery setTrigramPhraseFields(string $fields)

(PECL solr >= 2.1.0)
Directly Sets Trigram Phrase Fields (pf3 parameter)

Parameters

string $fields

Trigram Phrase Fields

Return Value

SolrDisMaxQuery

at line 319
SolrDisMaxQuery setTrigramPhraseSlop(string $slop)

(PECL solr >= 2.1.0)
Sets Trigram Phrase Slop (ps3 parameter)

Parameters

string $slop

Phrase slop

Return Value

SolrDisMaxQuery

at line 331
SolrDisMaxQuery setUserFields(string $fields)

(PECL solr >= 2.1.0)
Sets User Fields parameter (uf)

Parameters

string $fields

Fields names separated by space
This parameter supports wildcards.

Return Value

SolrDisMaxQuery

at line 339
SolrDisMaxQuery useDisMaxQueryParser()

(PECL solr >= 2.1.0)
Switch QueryParser to be DisMax Query Parser

Return Value

SolrDisMaxQuery

at line 349
SolrDisMaxQuery useEDisMaxQueryParser()

(PECL solr >= 2.1.0)
Switch QueryParser to be EDisMax
By default the query builder uses edismax, if it was switched using SolrDisMaxQuery::useDisMaxQueryParser(), it can be switched back using this method.

Return Value

SolrDisMaxQuery