* @link https://github.com/pjmazenot/phpsolr-phpdoc */ /** * (PECL solr >= 0.9.2)
* Class SolrQuery
* This class represents a collection of name-value pairs sent to the Solr server during a request. * @link https://php.net/manual/en/class.solrquery.php */ class SolrQuery extends SolrModifiableParams implements Serializable { /** @var int Used to specify that the sorting should be in acending order */ public const ORDER_ASC = 0; /** @var int Used to specify that the sorting should be in descending order */ public const ORDER_DESC = 1; /** @var int Used to specify that the facet should sort by index */ public const FACET_SORT_INDEX = 0; /** @var int Used to specify that the facet should sort by count */ public const FACET_SORT_COUNT = 1; /** @var int Used in the TermsComponent */ public const TERMS_SORT_INDEX = 0; /** @var int Used in the TermsComponent */ public const TERMS_SORT_COUNT = 1; /** * (PECL solr >= 2.2.0)
* Overrides main filter query, determines which documents to include in the main group. * @link https://php.net/manual/en/solrquery.addexpandfilterquery.php * @param string $fq * @return SolrQuery

* Returns a SolrQuery object. *

*/ public function addExpandFilterQuery($fq) {} /** * (PECL solr >= 2.2.0)
* Orders the documents within the expanded groups (expand.sort parameter). * @link https://php.net/manual/en/solrquery.addexpandsortfield.php * @param string $field

* Field name *

* @param string $order [optional]

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

*

* Default: SolrQuery::ORDER_DESC *

* @return SolrQuery

* Returns a SolrQuery object. *

*/ public function addExpandSortField($field, $order) {} /** * (PECL solr >= 0.9.2)
* Maps to facet.date * @link https://php.net/manual/en/solrquery.addfacetdatefield.php * @param string $dateField

* The name of the date field. *

* @return SolrQuery

* Returns a SolrQuery object. *

*/ public function addFacetDateField($dateField) {} /** * (PECL solr >= 0.9.2)
* Adds another facet.date.other parameter * @link https://php.net/manual/en/solrquery.addfacetdateother.php * @param string $value

* The value to use. *

* @param string $field_override

* The field name for the override. *

* @return SolrQuery

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

*/ public function addFacetDateOther($value, $field_override) {} /** * (PECL solr >= 0.9.2)
* Adds another field to the facet * @link https://php.net/manual/en/solrquery.addfacetfield.php * @param string $field

* The name of the field *

* @return SolrQuery

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

*/ public function addFacetField($field) {} /** * (PECL solr >= 0.9.2)
* Adds a facet query * @link https://php.net/manual/en/solrquery.addfacetquery.php * @param string $facetQuery

* The facet query *

* @return SolrQuery

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

*/ public function addFacetQuery($facetQuery) {} /** * (PECL solr >= 0.9.2)
* Specifies which fields to return in the result * @link https://php.net/manual/en/solrquery.addfield.php * @param string $field

* The name of the field *

* @return SolrQuery

* Returns a SolrQuery object. *

*/ public function addField($field) {} /** * (PECL solr >= 0.9.2)
* Specifies a filter query * @link https://php.net/manual/en/solrquery.addfilterquery.php * @param string $fq

* The filter query *

* @return SolrQuery

* Returns a SolrQuery object. *

*/ public function addFilterQuery($fq) {} /** * (PECL solr >= 2.2.0)
* Add a field to be used to group results. * @link https://php.net/manual/en/solrquery.addgroupfield.php * @param string $value * @return SolrQuery

* Returns a SolrQuery object. *

*/ public function addGroupField($value) {} /** * (PECL solr >= 2.2.0)
* Allows grouping results based on the unique values of a function query (group.func parameter). * @link https://php.net/manual/en/solrquery.addgroupfunction.php * @param string $value * @return SolrQuery

* Returns a SolrQuery object. *

*/ public function addGroupFunction($value) {} /** * (PECL solr >= 2.2.0)
* Allows grouping of documents that match the given query. * @link https://php.net/manual/en/solrquery.addgroupquery.php * @param string $value * @return SolrQuery

* Returns a SolrQuery object. *

*/ public function addGroupQuery($value) {} /** * (PECL solr >= 2.2.0)
* Add a group sort field (group.sort parameter). * @link https://php.net/manual/en/solrquery.addgroupsortfield.php * @param string $field

* Field name *

* @param int $order

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

* @return SolrQuery

* Returns a SolrQuery object. *

*/ public function addGroupSortField($field, $order) {} /** * (PECL solr >= 0.9.2)
* Maps to hl.fl * @link https://php.net/manual/en/solrquery.addhighlightfield.php * @param string $field

* Name of the field *

* @return SolrQuery

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

*/ public function addHighlightField($field) {} /** * (PECL solr >= 0.9.2)
* Sets a field to use for similarity * @link https://php.net/manual/en/solrquery.addmltfield.php * @param string $field

* The name of the field *

* @return SolrQuery

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

*/ public function addMltField($field) {} /** * (PECL solr >= 0.9.2)
* Maps to mlt.qf * @link https://php.net/manual/en/solrquery.addmltqueryfield.php * @param string $field

* The name of the field *

* @param float $boost

* Its boost value *

* @return SolrQuery

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

*/ public function addMltQueryField($field, $boost) {} /** * (PECL solr >= 0.9.2)
* Used to control how the results should be sorted * @link https://php.net/manual/en/solrquery.addsortfield.php * @param string $field

* The name of the field *

* @param int $order

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

* @return SolrQuery

* Returns a SolrQuery object. *

*/ public function addSortField($field, $order = SolrQuery::ORDER_DESC) {} /** * (PECL solr >= 0.9.2)
* Requests a return of sub results for values within the given facet * @link https://php.net/manual/en/solrquery.addstatsfacet.php * @param string $field

* The name of the field *

* @return SolrQuery

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

*/ public function addStatsFacet($field) {} /** * (PECL solr >= 0.9.2)
* Maps to stats.field parameter * @link https://php.net/manual/en/solrquery.addstatsfield.php * @param string $field

* The name of the field *

* @return SolrQuery

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

*/ public function addStatsField($field) {} /** * (No version information available, might only be in Git)
* Collapses the result set to a single document per group * @link https://php.net/manual/en/solrquery.collapse.php * @param SolrCollapseFunction $collapseFunction * @return SolrQuery

* Returns a SolrQuery object. *

*/ public function collapse(SolrCollapseFunction $collapseFunction) {} /** * (PECL solr >= 0.9.2)
* SolrQuery constructor. * @link https://php.net/manual/en/solrquery.construct.php * @param string $q

* Optional search query *

*/ public function __construct($q = '') {} /** * (PECL solr >= 0.9.2)
* Destructor * @link https://php.net/manual/en/solrquery.destruct.php */ public function __destruct() {} /** * (PECL solr >= 2.2.0)
* Returns true if group expanding is enabled * @link https://php.net/manual/en/solrquery.getexpand.php * @return bool

* Returns TRUE if group expanding is enabled *

*/ public function getExpand() {} /** * (PECL solr >= 2.2.0)
* Returns the expand filter queries * @link https://php.net/manual/en/solrquery.getexpandfilterqueries.php * @return array

* Returns the expand filter queries *

*/ public function getExpandFilterQueries() {} /** * (PECL solr >= 2.2.0)
* Returns the expand query expand.q parameter * @link https://php.net/manual/en/solrquery.getexpandquery.php * @return array

* Returns the expand query expand.q parameter *

*/ public function getExpandQuery() {} /** * (PECL solr >= 2.2.0)
* Returns The number of rows to display in each group (expand.rows) * @link https://php.net/manual/en/solrquery.getexpandrows.php * @return int

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

*/ public function getExpandRows() {} /** * (PECL solr >= 2.2.0)
* Returns an array of fields * @link https://php.net/manual/en/solrquery.getexpandsortfields.php * @return array

* Returns an array of fields *

*/ public function getExpandSortFields() {} /** * (PECL solr >= 0.9.2)
* Returns the value of the facet parameter * @link https://php.net/manual/en/solrquery.getfacet.php * @return bool|null

* Returns a boolean on success and NULL if not set *

*/ public function getFacet() {} /** * (PECL solr >= 0.9.2)
* Returns the value for the facet.date.end parameter * @link https://php.net/manual/en/solrquery.getfacetdateend.php * @param string $field_override [optional]

* The name of the field *

* @return string|null

* Returns a string on success and NULL if not set *

*/ public function getFacetDateEnd($field_override) {} /** * (PECL solr >= 0.9.2)
* Returns all the facet.date fields * @link https://php.net/manual/en/solrquery.getfacetdatefields.php * @return array|null

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

*/ public function getFacetDateFields() {} /** * (PECL solr >= 0.9.2)
* Returns the value of the facet.date.gap parameter * @link https://php.net/manual/en/solrquery.getfacetdategap.php * @param string $field_override [optional]

* The name of the field *

* @return string|null

* Returns a string on success and NULL if not set *

*/ public function getFacetDateGap($field_override) {} /** * (PECL solr >= 0.9.2)
* Returns the value of the facet.date.hardend parameter * @link https://php.net/manual/en/solrquery.getfacetdatehardend.php * @param string $field_override [optional]

* The name of the field *

* @return string|null

* Returns a string on success and NULL if not set *

*/ public function getFacetDateHardEnd($field_override) {} /** * (PECL solr >= 0.9.2)
* Returns the value for the facet.date.other parameter * @link https://php.net/manual/en/solrquery.getfacetdatehardend.php * @param string $field_override [optional]

* The name of the field *

* @return array|null

* Returns an array on success and NULL if not set *

*/ public function getFacetDateOther($field_override) {} /** * (PECL solr >= 0.9.2)
* Returns the lower bound for the first date range for all date faceting on this field * @link https://php.net/manual/en/solrquery.getfacetdatestart.php * @param string $field_override [optional]

* The name of the field *

* @return string|null

* Returns a string on success and NULL if not set *

*/ public function getFacetDateStart($field_override) {} /** * (PECL solr >= 0.9.2)
* Returns all the facet fields * @link https://php.net/manual/en/solrquery.getfacetfields.php * @return array|null

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

*/ public function getFacetFields() {} /** * (PECL solr >= 0.9.2)
* Returns the maximum number of constraint counts that should be returned for the facet fields * @link https://php.net/manual/en/solrquery.getfacetlimit.php * @param string $field_override [optional]

* The name of the field *

* @return int|null

* Returns an integer on success and NULL if not set *

*/ public function getFacetLimit($field_override) {} /** * (PECL solr >= 0.9.2)
* Returns the value of the facet.method parameter * @link https://php.net/manual/en/solrquery.getfacetmethod.php * @param string $field_override [optional]

* The name of the field *

* @return string|null

* Returns a string on success and NULL if not set *

*/ public function getFacetMethod($field_override) {} /** * (PECL solr >= 0.9.2)
* Returns the minimum counts for facet fields should be included in the response * @link https://php.net/manual/en/solrquery.getfacetmincount.php * @param string $field_override [optional]

* The name of the field *

* @return int|null

* Returns an integer on success and NULL if not set *

*/ public function getFacetMinCount($field_override) {} /** * (PECL solr >= 0.9.2)
* Returns the current state of the facet.missing parameter * @link https://php.net/manual/en/solrquery.getfacetmissing.php * @param string $field_override [optional]

* The name of the field *

* @return string|null

* Returns a boolean on success and NULL if not set *

*/ public function getFacetMissing($field_override) {} /** * (PECL solr >= 0.9.2)
* Returns an offset into the list of constraints to be used for pagination * @link https://php.net/manual/en/solrquery.getfacetoffset.php * @param string $field_override [optional]

* The name of the field *

* @return int|null

* Returns an integer on success and NULL if not set *

*/ public function getFacetOffset($field_override) {} /** * (PECL solr >= 0.9.2)
* Returns the facet prefix * @link https://php.net/manual/en/solrquery.getfacetprefix.php * @param string $field_override [optional]

* The name of the field *

* @return string|null

* Returns a string on success and NULL if not set *

*/ public function getFacetPrefix($field_override) {} /** * (PECL solr >= 0.9.2)
* Returns all the facet queries * @link https://php.net/manual/en/solrquery.getfacetqueries.php * @return string|null

* Returns an array on success and NULL if not set *

*/ public function getFacetQueries() {} /** * (PECL solr >= 0.9.2)
* Returns the facet sort type * @link https://php.net/manual/en/solrquery.getfacetsort.php * @param string $field_override [optional]

* The name of the field *

* @return int|null

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

*/ public function getFacetSort($field_override) {} /** * (PECL solr >= 0.9.2)
* Returns the list of fields that will be returned in the response * @link https://php.net/manual/en/solrquery.getfields.php * @return string|null

* Returns an array on success and NULL if not set *

*/ public function getFields() {} /** * (PECL solr >= 0.9.2)
* Returns an array of filter queries * @link https://php.net/manual/en/solrquery.getfilterqueries.php * @return string|null

* Returns an array on success and NULL if not set *

*/ public function getFilterQueries() {} /** * (PECL solr >= 2.2.0)
* Returns true if grouping is enabled * https://secure.php.net/manual/en/solrquery.getgroup.php * @return bool

* Returns true if grouping is enabled *

*/ public function getGroup() {} /** * (PECL solr >= 2.2.0)
* Returns group cache percent value * @link https://php.net/manual/en/solrquery.getgroupcachepercent.php * @return int

* Returns group cache percent value *

*/ public function getGroupCachePercent() {} /** * (PECL solr >= 2.2.0)
* Returns the group.facet parameter value * @link https://php.net/manual/en/solrquery.getgroupfacet.php * @return bool

* Returns the group.facet parameter value *

*/ public function getGroupFacet() {} /** * (PECL solr >= 2.2.0)
* Returns group fields (group.field parameter values) * @link https://php.net/manual/en/solrquery.getgroupfields.php * @return array

* Returns group fields (group.field parameter values) *

*/ public function getGroupFields() {} /** * (PECL solr >= 2.2.0)
* Returns the group.format value * @link https://php.net/manual/en/solrquery.getgroupformat.php * @return string

* Returns the group.format value *

*/ public function getGroupFormat() {} /** * (PECL solr >= 2.2.0)
* Returns group functions (group.func parameter values) * @link https://php.net/manual/en/solrquery.getgroupfunctions.php * @return array

* Returns group functions (group.func parameter values) *

*/ public function getGroupFunctions() {} /** * (PECL solr >= 2.2.0)
* Returns the group.limit value * @link https://php.net/manual/en/solrquery.getgrouplimit.php * @return int

* Returns the group.limit value *

*/ public function getGroupLimit() {} /** * (PECL solr >= 2.2.0)
* Returns the group.main value * @link https://php.net/manual/en/solrquery.getgroupmain.php * @return bool

* Returns the group.main value *

*/ public function getGroupMain() {} /** * (PECL solr >= 2.2.0)
* Returns the group.ngroups value * @link https://php.net/manual/en/solrquery.getgroupngroups.php * @return bool

* Returns the group.ngroups value *

*/ public function getGroupNGroups() {} /** * (PECL solr >= 2.2.0)
* Returns the group.offset value * @link https://php.net/manual/en/solrquery.getgroupoffset.php * @return bool

* Returns the group.offset value *

*/ public function getGroupOffset() {} /** * (PECL solr >= 2.2.0)
* Returns all the group.query parameter values * @link https://php.net/manual/en/solrquery.getgroupqueries.php * @return array

* Returns all the group.query parameter values *

*/ public function getGroupQueries() {} /** * (PECL solr >= 2.2.0)
* Returns the group.sort value * @link https://php.net/manual/en/solrquery.getgroupsortfields.php * @return array

* Returns all the group.sort parameter values *

*/ public function getGroupSortFields() {} /** * (PECL solr >= 2.2.0)
* Returns the group.truncate value * @link https://php.net/manual/en/solrquery.getgrouptruncate.php * @return bool

* Returns the group.truncate value *

*/ public function getGroupTruncate() {} /** * (PECL solr >= 0.9.2)
* Returns the state of the hl parameter * @link https://php.net/manual/en/solrquery.gethighlight.php * @return bool

* Returns the state of the hl parameter *

*/ public function getHighlight() {} /** * (PECL solr >= 0.9.2)
* Returns the highlight field to use as backup or default * @link https://php.net/manual/en/solrquery.gethighlightalternatefield.php * @param string $field_override [optional]

* The name of the field *

* @return string|null

* Returns a string on success and NULL if not set *

*/ public function getHighlightAlternateField($field_override) {} /** * (PECL solr >= 0.9.2)
* Returns all the fields that Solr should generate highlighted snippets for * @link https://php.net/manual/en/solrquery.gethighlightfields.php * @return array|null

* Returns an array on success and NULL if not set *

*/ public function getHighlightFields() {} /** * (PECL solr >= 0.9.2)
* Returns the formatter for the highlighted output * @link https://php.net/manual/en/solrquery.gethighlightformatter.php * @param string $field_override [optional]

* The name of the field *

* @return string|null

* Returns a string on success and NULL if not set *

*/ public function getHighlightFormatter($field_override) {} /** * (PECL solr >= 0.9.2)
* Returns the text snippet generator for highlighted text * @link https://php.net/manual/en/solrquery.gethighlightfragmenter.php * @param string $field_override [optional]

* The name of the field *

* @return string|null

* Returns a string on success and NULL if not set *

*/ public function getHighlightFragmenter($field_override) {} /** * (PECL solr >= 0.9.2)
* Returns the number of characters of fragments to consider for highlighting * @link https://php.net/manual/en/solrquery.gethighlightfragsize.php * @param string $field_override [optional]

* The name of the field *

* @return int|null

* Returns an integer on success and NULL if not set *

*/ public function getHighlightFragsize($field_override) {} /** * (PECL solr >= 0.9.2)
* Returns whether or not to enable highlighting for range/wildcard/fuzzy/prefix queries * @link https://php.net/manual/en/solrquery.gethighlighthighlightmultiterm.php * @return bool|null

* Returns a boolean on success and NULL if not set *

*/ public function getHighlightHighlightMultiTerm() {} /** * (PECL solr >= 0.9.2)
* Returns the maximum number of characters of the field to return * @link https://php.net/manual/en/solrquery.gethighlightmaxalternatefieldlength.php * @param string $field_override [optional]

* The name of the field *

* @return int|null

* Returns an integer on success and NULL if not set *

*/ public function getHighlightMaxAlternateFieldLength($field_override) {} /** * (PECL solr >= 0.9.2)
* Returns the maximum number of characters into a document to look for suitable snippets * @link https://php.net/manual/en/solrquery.gethighlightmaxanalyzedchars.php * @return int|null

* Returns an integer on success and NULL if not set *

*/ public function getHighlightMaxAnalyzedChars() {} /** * (PECL solr >= 0.9.2)
* Returns whether or not the collapse contiguous fragments into a single fragment * @link https://php.net/manual/en/solrquery.gethighlightmergecontiguous.php * @param string $field_override [optional]

* The name of the field *

* @return bool|null

* Returns a boolean on success and NULL if not set *

*/ public function getHighlightMergeContiguous($field_override) {} /** * (PECL solr >= 0.9.2)
* Returns the maximum number of characters from a field when using the regex fragmenter * @link https://php.net/manual/en/solrquery.gethighlightregexmaxanalyzedchars.php * @return int|null

* Returns an integer on success and NULL if not set *

*/ public function getHighlightRegexMaxAnalyzedChars() {} /** * (PECL solr >= 0.9.2)
* Returns the regular expression for fragmenting * @link https://php.net/manual/en/solrquery.gethighlightregexpattern.php * @return string

* Returns a string on success and NULL if not set *

*/ public function getHighlightRegexPattern() {} /** * (PECL solr >= 0.9.2)
* Returns the deviation factor from the ideal fragment size * @link https://php.net/manual/en/solrquery.gethighlightregexslop.php * @return float|null

* Returns a double on success and NULL if not set. *

*/ public function getHighlightRegexSlop() {} /** * (PECL solr >= 0.9.2)
* Returns if a field will only be highlighted if the query matched in this particular field * @link https://php.net/manual/en/solrquery.gethighlightrequirefieldmatch.php * @return bool|null

* Returns a boolean on success and NULL if not set *

*/ public function getHighlightRequireFieldMatch() {} /** * (PECL solr >= 0.9.2)
* Returns the text which appears after a highlighted term * @link https://php.net/manual/en/solrquery.gethighlightsimplepost.php * @param string $field_override [optional]

* The name of the field *

* @return string|null

* Returns a string on success and NULL if not set *

*/ public function getHighlightSimplePost($field_override) {} /** * (PECL solr >= 0.9.2)
* Returns the text which appears before a highlighted term * @link https://php.net/manual/en/solrquery.gethighlightsimplepre.php * @param string $field_override [optional]

* The name of the field *

* @return string|null

* Returns a string on success and NULL if not set *

*/ public function getHighlightSimplePre($field_override) {} /** * (PECL solr >= 0.9.2)
* Returns the maximum number of highlighted snippets to generate per field * @link https://php.net/manual/en/solrquery.gethighlightsnippets.php * @param string $field_override [optional]

* The name of the field *

* @return int|null

* Returns an integer on success and NULL if not set *

*/ public function getHighlightSnippets($field_override) {} /** * (PECL solr >= 0.9.2)
* Returns the state of the hl.usePhraseHighlighter parameter * @link https://php.net/manual/en/solrquery.gethighlightusephrasehighlighter.php * @return bool|null

* Returns a boolean on success and NULL if not set *

*/ public function getHighlightUsePhraseHighlighter() {} /** * (PECL solr >= 0.9.2)
* Returns whether or not MoreLikeThis results should be enabled * @link https://php.net/manual/en/solrquery.getmlt.php * @return bool|null

* Returns a boolean on success and NULL if not set *

*/ public function getMlt() {} /** * (PECL solr >= 0.9.2)
* Returns whether or not the query will be boosted by the interesting term relevance * @link https://php.net/manual/en/solrquery.getmltboost.php * @return bool|null

* Returns a boolean on success and NULL if not set *

*/ public function getMltBoost() {} /** * (PECL solr >= 0.9.2)
* Returns the number of similar documents to return for each result * @link https://php.net/manual/en/solrquery.getmltcount.php * @return int|null

* Returns an integer on success and NULL if not set *

*/ public function getMltCount() {} /** * (PECL solr >= 0.9.2)
* Returns all the fields to use for similarity * @link https://php.net/manual/en/solrquery.getmltfields.php * @return array

* Returns an array on success and NULL if not set *

*/ public function getMltFields() {} /** * (PECL solr >= 0.9.2)
* Returns the maximum number of query terms that will be included in any generated query * @link https://php.net/manual/en/solrquery.getmltmaxnumqueryterms.php * @return int|null

* Returns an integer on success and NULL if not set *

*/ public function getMltMaxNumQueryTerms() {} /** * (PECL solr >= 0.9.2)
* Returns the maximum number of tokens to parse in each document field that is not stored with TermVector support * @link https://php.net/manual/en/solrquery.getmltmaxnumtokens.php * @return int

* Returns an integer on success and NULL if not set *

*/ public function getMltMaxNumTokens() {} /** * (PECL solr >= 0.9.2)
* Returns the maximum word length above which words will be ignored * @link https://php.net/manual/en/solrquery.getmltmaxwordlength.php * @return int|null

* Returns an integer on success and NULL if not set *

*/ public function getMltMaxWordLength() {} /** * (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 * @link https://php.net/manual/en/solrquery.getmltmindocfrequency.php * @return int|null

* Returns an integer on success and NULL if not set *

*/ public function getMltMinDocFrequency() {} /** * (PECL solr >= 0.9.2)
* Returns the frequency below which terms will be ignored in the source document * @link https://php.net/manual/en/solrquery.getmltmintermfrequency.php * @return int|null

* Returns an integer on success and NULL if not set *

*/ public function getMltMinTermFrequency() {} /** * (PECL solr >= 0.9.2)
* Returns the minimum word length below which words will be ignored * @link https://php.net/manual/en/solrquery.getmltminwordlength.php * @return int

* Returns an integer on success and NULL if not set *

*/ public function getMltMinWordLength() {} /** * (PECL solr >= 0.9.2)
* Returns the query fields and their boosts * @link https://php.net/manual/en/solrquery.getmltqueryfields.php * @return array|null

* Returns an array on success and NULL if not set *

*/ public function getMltQueryFields() {} /** * (PECL solr >= 0.9.2)
* Returns the main query * @link https://php.net/manual/en/solrquery.getquery.php * @return string

* Returns a string on success and NULL if not set *

*/ public function getQuery() {} /** * (PECL solr >= 0.9.2)
* Returns the maximum number of documents * @link https://php.net/manual/en/solrquery.getrows.php * @return int|null

* Returns an integer on success and NULL if not set *

*/ public function getRows() {} /** * (PECL solr >= 0.9.2)
* Returns all the sort fields * @link https://php.net/manual/en/solrquery.getsortfields.php * @return array

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

*/ public function getSortFields() {} /** * (PECL solr >= 0.9.2)
* Returns the offset in the complete result set * @link https://php.net/manual/en/solrquery.getstart.php * @return int|null

* Returns an integer on success and NULL if not set *

*/ public function getStart() {} /** * (PECL solr >= 0.9.2)
* Returns whether or not stats is enabled * @link https://php.net/manual/en/solrquery.getstats.php * @return bool|null

* Returns a boolean on success and NULL if not set *

*/ public function getStats() {} /** * (PECL solr >= 0.9.2)
* Returns all the stats facets that were set * @link https://php.net/manual/en/solrquery.getstatsfacets.php * @return array|null

* Returns an array on success and NULL if not set *

*/ public function getStatsFacets() {} /** * (PECL solr >= 0.9.2)
* Returns all the statistics fields * @link https://php.net/manual/en/solrquery.getstatsfields.php * @return array|null

* Returns an array on success and NULL if not set *

*/ public function getStatsFields() {} /** * (PECL solr >= 0.9.2)
* Returns whether or not the TermsComponent is enabled * @link https://php.net/manual/en/solrquery.getterms.php * @return bool|null

* Returns a boolean on success and NULL if not set *

*/ public function getTerms() {} /** * (PECL solr >= 0.9.2)
* Returns the field from which the terms are retrieved * @link https://php.net/manual/en/solrquery.gettermsfield.php * @return string|null

* Returns a string on success and NULL if not set *

*/ public function getTermsField() {} /** * (PECL solr >= 0.9.2)
* Returns whether or not to include the lower bound in the result set * @link https://php.net/manual/en/solrquery.gettermsincludelowerbound.php * @return bool|null

* Returns a boolean on success and NULL if not set *

*/ public function getTermsIncludeLowerBound() {} /** * (PECL solr >= 0.9.2)
* Returns whether or not to include the upper bound term in the result set * @link https://php.net/manual/en/solrquery.gettermsincludeupperbound.php * @return bool|null

* Returns a boolean on success and NULL if not set *

*/ public function getTermsIncludeUpperBound() {} /** * (PECL solr >= 0.9.2)
* Returns the maximum number of terms Solr should return * @link https://php.net/manual/en/solrquery.gettermslimit.php * @return int|null

* Returns an integer on success and NULL if not set *

*/ public function getTermsLimit() {} /** * (PECL solr >= 0.9.2)
* Returns the term to start at * @link https://php.net/manual/en/solrquery.gettermslowerbound.php * @return string|null

* Returns a string on success and NULL if not set *

*/ public function getTermsLowerBound() {} /** * (PECL solr >= 0.9.2)
* Returns the maximum document frequency * @link https://php.net/manual/en/solrquery.gettermsmaxcount.php * @return int|null

* Returns an integer on success and NULL if not set *

*/ public function getTermsMaxCount() {} /** * (PECL solr >= 0.9.2)
* Returns the minimum document frequency to return in order to be included * @link https://php.net/manual/en/solrquery.gettermsmincount.php * @return int|null

* Returns an integer on success and NULL if not set *

*/ public function getTermsMinCount() {} /** * (PECL solr >= 0.9.2)
* Returns the term prefix * @link https://php.net/manual/en/solrquery.gettermsprefix.php * @return string|null

* Returns a string on success and NULL if not set *

*/ public function getTermsPrefix() {} /** * (PECL solr >= 0.9.2)
* Whether or not to return raw characters * @link https://php.net/manual/en/solrquery.gettermsreturnraw.php * @return bool|null

* Returns a boolean on success and NULL if not set *

*/ public function getTermsReturnRaw() {} /** * (PECL solr >= 0.9.2)
* Returns an integer indicating how terms are sorted * @link https://php.net/manual/en/solrquery.gettermssort.php * @return 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) *

*/ public function getTermsSort() {} /** * (PECL solr >= 0.9.2)
* Returns the term to stop at * @link https://php.net/manual/en/solrquery.gettermsupperbound.php * @return string|null

* Returns a string on success and NULL if not set *

*/ public function getTermsUpperBound() {} /** * (PECL solr >= 0.9.2)
* Returns the time in milliseconds allowed for the query to finish * @link https://php.net/manual/en/solrquery.gettimeallowed.php * @return int|null

* Returns an integer on success and NULL if not set *

*/ public function getTimeAllowed() {} /** * (PECL solr >= 2.2.0)
* Removes an expand filter query * @link https://php.net/manual/en/solrquery.removeexpandfilterquery.php * @param string $fq * @return SolrQuery

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

*/ public function removeExpandFilterQuery($fq) {} /** * (PECL solr >= 2.2.0)
* Removes an expand sort field from the expand.sort parameter. * @link https://php.net/manual/en/solrquery.removeexpandsortfield.php * @param string $field

* Field name *

* @return SolrQuery

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

*/ public function removeExpandSortField($field) {} /** * (PECL solr >= 0.9.2)
* Removes one of the facet date fields * @link https://php.net/manual/en/solrquery.removefacetdatefield.php * @param string $field

* The name of the date field to remove *

* @return SolrQuery

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

*/ public function removeFacetDateField($field) {} /** * (PECL solr >= 0.9.2)
* Removes one of the facet.date.other parameters * @link https://php.net/manual/en/solrquery.removefacetdateother.php * @param string $value

* The value *

* @param string $field_override [optional]

* The name of the field. *

* @return SolrQuery

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

*/ public function removeFacetDateOther($value, $field_override) {} /** * (PECL solr >= 0.9.2)
* Removes one of the facet.date parameters * @link https://php.net/manual/en/solrquery.removefacetfield.php * @param string $field

* The name of the field *

* @return SolrQuery

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

*/ public function removeFacetField($field) {} /** * (PECL solr >= 0.9.2)
* Removes one of the facet.query parameters * @link https://php.net/manual/en/solrquery.removefacetquery.php * @param string $value

* The value *

* @return SolrQuery

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

*/ public function removeFacetQuery($value) {} /** * (PECL solr >= 0.9.2)
* Removes a field from the list of fields * @link https://php.net/manual/en/solrquery.removefield.php * @param string $field

* The name of the field *

* @return SolrQuery

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

*/ public function removeField($field) {} /** * (PECL solr >= 0.9.2)
* Removes a filter query * @link https://php.net/manual/en/solrquery.removefilterquery.php * @param string $fq * @return SolrQuery

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

*/ public function removeFilterQuery($fq) {} /** * (PECL solr >= 0.9.2)
* Removes one of the fields used for highlighting * @link https://php.net/manual/en/solrquery.removehighlightfield.php * @param string $field

* The name of the field *

* @return SolrQuery

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

*/ public function removeHighlightField($field) {} /** * (PECL solr >= 0.9.2)
* Removes one of the moreLikeThis fields * @link https://php.net/manual/en/solrquery.removemltfield.php * @param string $field

* The name of the field *

* @return SolrQuery

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

*/ public function removeMltField($field) {} /** * (PECL solr >= 0.9.2)
* Removes one of the moreLikeThis query fields * @link https://php.net/manual/en/solrquery.removemltqueryfield.php * @param string $queryField

* The query field *

* @return SolrQuery

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

*/ public function removeMltQueryField($queryField) {} /** * (PECL solr >= 0.9.2)
* Removes one of the sort fields * @link https://php.net/manual/en/solrquery.removesortfield.php * @param string $field

* The name of the field *

* @return SolrQuery

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

*/ public function removeSortField($field) {} /** * (PECL solr >= 0.9.2)
* Removes one of the stats.facet parameters * @link https://php.net/manual/en/solrquery.removestatsfacet.php * @param string $value

* The value *

* @return SolrQuery

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

*/ public function removeStatsFacet($value) {} /** * (PECL solr >= 0.9.2)
* Removes one of the stats.field parameters * @link https://php.net/manual/en/solrquery.removestatsfield.php * @param string $field

* The name of the field *

* @return SolrQuery

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

*/ public function removeStatsField($field) {} /** * (PECL solr >= 0.9.2)
* Toggles the echoHandler parameter * @link https://php.net/manual/en/solrquery.setechohandler.php * @param bool $flag

* TRUE or FALSE *

* @return SolrQuery

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

*/ public function setEchoHandler($flag) {} /** * (PECL solr >= 0.9.2)
* Determines what kind of parameters to include in the response * @link https://php.net/manual/en/solrquery.setechoparams.php * @param string $type

* The type of parameters to include: *

* * @return SolrQuery

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

*/ public function setEchoParams($type) {} /** * (PECL solr >= 2.2.0)
* Enables/Disables the Expand Component * @link https://php.net/manual/en/solrquery.setexpand.php * @param bool $value

* Bool flag * * @return SolrQuery

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

*/ public function setExpand($value) {} /** * (PECL solr >= 2.2.0)
* Sets the expand.q parameter * @link https://php.net/manual/en/solrquery.setexpandquery.php * @param string $q * @return SolrQuery

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

*/ public function setExpandQuery($q) {} /** * (PECL solr >= 2.2.0)
* Sets the number of rows to display in each group (expand.rows). Server Default 5 * @link https://php.net/manual/en/solrquery.setexpandrows.php * @param int $value * @return SolrQuery

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

*/ public function setExpandRows($value) {} /** * (PECL solr >= 0.9.2)
* Sets the explainOther common query parameter * @link https://php.net/manual/en/solrquery.setexplainother.php * @param string $query

* The Lucene query to identify a set of documents *

* @return SolrQuery

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

*/ public function setExplainOther($query) {} /** * (PECL solr >= 0.9.2)
* Maps to the facet parameter. Enables or disables facetting * @link https://php.net/manual/en/solrquery.setfacet.php * @param bool $flag

* TRUE enables faceting and FALSE disables it. *

* @return SolrQuery

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

*/ public function setFacet($flag) {} /** * (PECL solr >= 0.9.2)
* Maps to facet.date.end * @link https://php.net/manual/en/solrquery.setfacetdateend.php * @param string $value

* See facet.date.end *

* @param string $field_override [optional]

* Name of the field *

* @return SolrQuery

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

*/ public function setFacetDateEnd($value, $field_override) {} /** * (PECL solr >= 0.9.2)
* Maps to facet.date.gap * @link https://php.net/manual/en/solrquery.setfacetdategap.php * @param string $value

* See facet.date.gap *

* @param string $field_override [optional]

* Name of the field *

* @return SolrQuery

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

*/ public function setFacetDateGap($value, $field_override) {} /** * (PECL solr >= 0.9.2)
* Maps to facet.date.hardend * @link https://php.net/manual/en/solrquery.setfacetdatehardend.php * @param bool $value

* See facet.date.hardend *

* @param string $field_override [optional]

* Name of the field *

* @return SolrQuery

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

*/ public function setFacetDateHardEnd($value, $field_override) {} /** * (PECL solr >= 0.9.2)
* Maps to facet.date.start * @link https://php.net/manual/en/solrquery.setfacetdatestart.php * @param string $value

* See facet.date.start *

* @param string $field_override [optional]

* Name of the field *

* @return SolrQuery

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

*/ public function setFacetDateStart($value, $field_override) {} /** * (PECL solr >= 0.9.2)
* Sets the minimum document frequency used for determining term count * @link https://php.net/manual/en/solrquery.setfacetenumcachemindefaultfrequency.php * @param int $frequency

* The minimum frequency *

* @param string $field_override [optional]

* Name of the field *

* @return SolrQuery

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

*/ public function setFacetEnumCacheMinDefaultFrequency($frequency, $field_override) {} /** * (PECL solr >= 0.9.2)
* Maps to facet.limit * @link https://php.net/manual/en/solrquery.setfacetlimit.php * @param int $limit

* The maximum number of constraint counts *

* @param string $field_override [optional]

* Name of the field *

* @return SolrQuery

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

*/ public function setFacetLimit($limit, $field_override) {} /** * (PECL solr >= 0.9.2)
* Specifies the type of algorithm to use when faceting a field * @link https://php.net/manual/en/solrquery.setfacetmethod.php * @param string $method

* The method to use. *

* @param string $field_override [optional]

* Name of the field *

* @return SolrQuery

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

*/ public function setFacetMethod($method, $field_override) {} /** * (PECL solr >= 0.9.2)
* Maps to facet.mincount * @link https://php.net/manual/en/solrquery.setfacetmincount.php * @param int $mincount

* The minimum count *

* @param string $field_override [optional]

* Name of the field *

* @return SolrQuery

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

*/ public function setFacetMinCount($mincount, $field_override) {} /** * (PECL solr >= 0.9.2)
* Maps to facet.missing * @link https://php.net/manual/en/solrquery.setfacetmissing.php * @param bool $flag

* TRUE turns this feature on. FALSE disables it. *

* @param string $field_override [optional]

* Name of the field *

* @return SolrQuery

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

*/ public function setFacetMissing($flag, $field_override) {} /** * (PECL solr >= 0.9.2)
* Sets the offset into the list of constraints to allow for pagination * @link https://php.net/manual/en/solrquery.setfacetoffset.php * @param int $offset

* The offset *

* @param string $field_override [optional]

* Name of the field *

* @return SolrQuery

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

*/ public function setFacetOffset($offset, $field_override) {} /** * (PECL solr >= 0.9.2)
* Specifies a string prefix with which to limits the terms on which to facet * @link https://php.net/manual/en/solrquery.setfacetprefix.php * @param string $prefix

* The prefix string *

* @param string $field_override [optional]

* Name of the field *

* @return SolrQuery

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

*/ public function setFacetPrefix($prefix, $field_override) {} /** * (PECL solr >= 0.9.2)
* Determines the ordering of the facet field constraints * @link https://php.net/manual/en/solrquery.setfacetsort.php * @param int $facetSort

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

* @param string $field_override [optional]

* Name of the field *

* @return SolrQuery

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

*/ public function setFacetSort($facetSort, $field_override) {} /** * (PECL solr >= 2.2.0)
* Enable/Disable result grouping (group parameter) * @link https://php.net/manual/en/solrquery.setgroup.php * @param bool $value * @return SolrQuery

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

*/ public function setGroup($value) {} /** * (PECL solr >= 2.2.0)
* Enables caching for result grouping * @link https://php.net/manual/en/solrquery.setgroupcachepercent.php * @param 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 SolrQuery

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

*/ public function setGroupCachePercent($percent) {} /** * (PECL solr >= 2.2.0)
* Sets group.facet parameter * @link https://php.net/manual/en/solrquery.setgroupfacet.php * @param bool $value * @return SolrQuery

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

*/ public function setGroupFacet($value) {} /** * (PECL solr >= 2.2.0)
* Sets the group format, result structure (group.format parameter). * @link https://php.net/manual/en/solrquery.setgroupformat.php * @param 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 SolrQuery

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

*/ public function setGroupFormat($value) {} /** * (PECL solr >= 2.2.0)
* Specifies the number of results to return for each group. The server default value is 1. * @link https://php.net/manual/en/solrquery.setgrouplimit.php * @param int $value * @return SolrQuery

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

*/ public function setGroupLimit($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. * @link https://php.net/manual/en/solrquery.setgroupmain.php * @param string $value * @return SolrQuery

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

*/ public function setGroupMain($value) {} /** * (PECL solr >= 2.2.0)
* If true, Solr includes the number of groups that have matched the query in the results. * @link https://php.net/manual/en/solrquery.setgroupngroups.php * @param bool $value * @return SolrQuery

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

*/ public function setGroupNGroups($value) {} /** * (PECL solr >= 2.2.0)
* Sets the group.offset parameter. * @link https://php.net/manual/en/solrquery.setgroupoffset.php * @param int $value * @return SolrQuery

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

*/ public function setGroupOffset($value) {} /** * (PECL solr >= 2.2.0)
* If true, facet counts are based on the most relevant document of each group matching the query. * @link https://php.net/manual/en/solrquery.setgrouptruncate.php * @param bool $value * @return SolrQuery

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

*/ public function setGroupTruncate($value) {} /** * (PECL solr >= 0.9.2)
* Enables or disables highlighting * @link https://php.net/manual/en/solrquery.sethighlight.php * @param bool $flag

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

* @return SolrQuery

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

*/ public function setHighlight($flag) {} /** * (PECL solr >= 0.9.2)
* Specifies the backup field to use * @link https://php.net/manual/en/solrquery.sethighlightalternatefield.php * @param string $field

* The name of the backup field *

* @param string $field_override [optional]

* Name of the field *

* @return SolrQuery

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

*/ public function setHighlightAlternateField($field, $field_override) {} /** * (PECL solr >= 0.9.2)
* Specify a formatter for the highlight output * @link https://php.net/manual/en/solrquery.sethighlightformatter.php * @param string $formatter

* Currently the only legal value is "simple" *

* @param string $field_override [optional]

* Name of the field *

* @return SolrQuery

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

*/ public function setHighlightFormatter($formatter, $field_override) {} /** * (PECL solr >= 0.9.2)
* Sets a text snippet generator for highlighted text * @link https://php.net/manual/en/solrquery.sethighlightfragmenter.php * @param string $fragmenter

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

* @param string $field_override [optional]

* Name of the field *

* @return SolrQuery

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

*/ public function setHighlightFragmenter($fragmenter, $field_override) {} /** * (PECL solr >= 0.9.2)
* The size of fragments to consider for highlighting * @link https://php.net/manual/en/solrquery.sethighlightfragsize.php * @param int $size

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

* @param string $field_override [optional]

* Name of the field *

* @return SolrQuery

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

*/ public function setHighlightFragsize($size, $field_override) {} /** * (PECL solr >= 0.9.2)
* Use SpanScorer to highlight phrase terms * @link https://php.net/manual/en/solrquery.sethighlighthighlightmultiterm.php * @param bool $flag

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

* @return SolrQuery

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

*/ public function setHighlightHighlightMultiTerm($flag) {} /** * (PECL solr >= 0.9.2)
* Sets the maximum number of characters of the field to return * @link https://php.net/manual/en/solrquery.sethighlightmaxalternatefieldlength.php * @param 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. *

* @param string $field_override [optional]

* Name of the field *

* @return SolrQuery

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

*/ public function setHighlightMaxAlternateFieldLength($fieldLength, $field_override) {} /** * (PECL solr >= 0.9.2)
* Specifies the number of characters into a document to look for suitable snippets * @link https://php.net/manual/en/solrquery.sethighlightmaxanalyzedchars.php * @param int $value

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

* @return SolrQuery

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

*/ public function setHighlightMaxAnalyzedChars($value) {} /** * (PECL solr >= 0.9.2)
* Whether or not to collapse contiguous fragments into a single fragment * @link https://php.net/manual/en/solrquery.sethighlightmergecontiguous.php * @param bool $flag

* Whether or not to collapse contiguous fragments into a single fragment *

* @param string $field_override [optional]

* Name of the field *

* @return SolrQuery

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

*/ public function setHighlightMergeContiguous($flag, $field_override) {} /** * (PECL solr >= 0.9.2)
* Specify the maximum number of characters to analyze * @link https://php.net/manual/en/solrquery.sethighlightregexmaxanalyzedchars.php * @param int $maxAnalyzedChars

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

* @return SolrQuery

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

*/ public function setHighlightRegexMaxAnalyzedChars($maxAnalyzedChars) {} /** * (PECL solr >= 0.9.2)
* Specify the regular expression for fragmenting * @link https://php.net/manual/en/solrquery.sethighlightregexpattern.php * @param string $value

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

* @return SolrQuery

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

*/ public function setHighlightRegexPattern($value) {} /** * (PECL solr >= 0.9.2)
* Sets the factor by which the regex fragmenter can stray from the ideal fragment size * @link https://php.net/manual/en/solrquery.sethighlightregexslop.php * @param 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 SolrQuery

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

*/ public function setHighlightRegexSlop($factor) {} /** * (PECL solr >= 0.9.2)
* Require field matching during highlighting * @link https://php.net/manual/en/solrquery.sethighlightrequirefieldmatch.php * @param 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 SolrQuery

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

*/ public function setHighlightRequireFieldMatch($flag) {} /** * (PECL solr >= 0.9.2)
* Sets the text which appears after a highlighted term * @link https://php.net/manual/en/solrquery.sethighlightsimplepost.php * @param string $simplePost

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

* @param string $field_override [optional]

* Name of the field *

* @return SolrQuery

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

*/ public function setHighlightSimplePost($simplePost, $field_override) {} /** * (PECL solr >= 0.9.2)
* Sets the text which appears before a highlighted term * @link https://php.net/manual/en/solrquery.sethighlightsimplepre.php * @param string $simplePre

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

* @param string $field_override [optional]

* Name of the field *

* @return SolrQuery

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

*/ public function setHighlightSimplePre($simplePre, $field_override) {} /** * (PECL solr >= 0.9.2)
* Sets the maximum number of highlighted snippets to generate per field * @link https://php.net/manual/en/solrquery.sethighlightsnippets.php * @param int $value

* The maximum number of highlighted snippets to generate per field *

* @param string $field_override [optional]

* Name of the field *

* @return SolrQuery

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

*/ public function setHighlightSnippets($value, $field_override) {} /** * (PECL solr >= 0.9.2)
* Whether to highlight phrase terms only when they appear within the query phrase * @link https://php.net/manual/en/solrquery.sethighlightusephrasehighlighter.php * @param bool $flag

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

* @return SolrQuery

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

*/ public function setHighlightUsePhraseHighlighter($flag) {} /** * (PECL solr >= 0.9.2)
* Enables or disables moreLikeThis * @link https://php.net/manual/en/solrquery.setmlt.php * @param bool $flag

* TRUE enables it and FALSE turns it off. *

* @return SolrQuery

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

*/ public function setMlt($flag) {} /** * (PECL solr >= 0.9.2)
* Set if the query will be boosted by the interesting term relevance * @link https://php.net/manual/en/solrquery.setmltboost.php * @param bool $flag

* Sets to TRUE or FALSE *

* @return SolrQuery

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

*/ public function setMltBoost($flag) {} /** * (PECL solr >= 0.9.2)
* Set the number of similar documents to return for each result * @link https://php.net/manual/en/solrquery.setmltcount.php * @param int $count

* The number of similar documents to return for each result *

* @return SolrQuery

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

*/ public function setMltCount($count) {} /** * (PECL solr >= 0.9.2)
* Sets the maximum number of query terms included * @link https://php.net/manual/en/solrquery.setmltmaxnumqueryterms.php * @param int $value

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

* @return SolrQuery

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

*/ public function setMltMaxNumQueryTerms($value) {} /** * (PECL solr >= 0.9.2)
* Specifies the maximum number of tokens to parse * @link https://php.net/manual/en/solrquery.setmltmaxnumtokens.php * @param int $value

* The maximum number of tokens to parse *

* @return SolrQuery

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

*/ public function setMltMaxNumTokens($value) {} /** * (PECL solr >= 0.9.2)
* Sets the maximum word length * @link https://php.net/manual/en/solrquery.setmltmaxwordlength.php * @param int $maxWordLength

* The maximum word length above which words will be ignored *

* @return SolrQuery

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

*/ public function setMltMaxWordLength($maxWordLength) {} /** * (PECL solr >= 0.9.2)
* Sets the mltMinDoc frequency * @link https://php.net/manual/en/solrquery.setmltmindocfrequency.php * @param int $minDocFrequency

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

* @return SolrQuery

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

*/ public function setMltMinDocFrequency($minDocFrequency) {} /** * (PECL solr >= 0.9.2)
* Sets the frequency below which terms will be ignored in the source docs * @link https://php.net/manual/en/solrquery.setmltmintermfrequency.php * @param int $minTermFrequency

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

* @return SolrQuery

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

*/ public function setMltMinTermFrequency($minTermFrequency) {} /** * (PECL solr >= 0.9.2)
* Sets the minimum word length * @link https://php.net/manual/en/solrquery.setmltminwordlength.php * @param int $minWordLength

* The minimum word length below which words will be ignored *

* @return SolrQuery

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

*/ public function setMltMinWordLength($minWordLength) {} /** * (PECL solr >= 0.9.2)
* Exclude the header from the returned results * @link https://php.net/manual/en/solrquery.setomitheader.php * @param bool $flag

* TRUE excludes the header from the result. *

* @return SolrQuery

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

*/ public function setOmitHeader($flag) {} /** * (PECL solr >= 0.9.2)
* Sets the search query * @link https://php.net/manual/en/solrquery.setquery.php * @param string $query

* The search query *

* @return SolrQuery

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

*/ public function setQuery($query) {} /** * (PECL solr >= 0.9.2)
* Specifies the maximum number of rows to return in the result * @link https://php.net/manual/en/solrquery.setrows.php * @param int $rows

* The maximum number of rows to return *

* @return SolrQuery

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

*/ public function setRows($rows) {} /** * (PECL solr >= 0.9.2)
* Flag to show debug information * @link https://php.net/manual/en/solrquery.setshowdebuginfo.php * @param bool $flag

* Whether to show debug info. TRUE or FALSE *

* @return SolrQuery

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

*/ public function setShowDebugInfo($flag) {} /** * (PECL solr >= 0.9.2)
* Specifies the number of rows to skip * @link https://php.net/manual/en/solrquery.setstart.php * @param int $start

* The number of rows to skip. *

* @return SolrQuery

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

*/ public function setStart($start) {} /** * (PECL solr >= 0.9.2)
* Enables or disables the Stats component * @link https://php.net/manual/en/solrquery.setstats.php * @param bool $flag

* TRUE turns on the stats component and FALSE disables it. *

* @return SolrQuery

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

*/ public function setStats($flag) {} /** * (PECL solr >= 0.9.2)
* Enables or disables the TermsComponent * @link https://php.net/manual/en/solrquery.setterms.php * @param bool $flag

* TRUE enables it. FALSE turns it off *

* @return SolrQuery

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

*/ public function setTerms($flag) {} /** * (PECL solr >= 0.9.2)
* Sets the name of the field to get the Terms from * @link https://php.net/manual/en/solrquery.settermsfield.php * @param string $fieldname

* The field name *

* @return SolrQuery

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

*/ public function setTermsField($fieldname) {} /** * (PECL solr >= 0.9.2)
* Include the lower bound term in the result set * @link https://php.net/manual/en/solrquery.settermsincludelowerbound.php * @param bool $flag

* Include the lower bound term in the result set *

* @return SolrQuery

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

*/ public function setTermsIncludeLowerBound($flag) {} /** * (PECL solr >= 0.9.2)
* Include the upper bound term in the result set * @link https://php.net/manual/en/solrquery.settermsincludeupperbound.php * @param bool $flag

* TRUE or FALSE *

* @return SolrQuery

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

*/ public function setTermsIncludeUpperBound($flag) {} /** * (PECL solr >= 0.9.2)
* Sets the maximum number of terms to return * @link https://php.net/manual/en/solrquery.settermslimit.php * @param int $limit

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

* @return SolrQuery

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

*/ public function setTermsLimit($limit) {} /** * (PECL solr >= 0.9.2)
* Specifies the Term to start from * @link https://php.net/manual/en/solrquery.settermslowerbound.php * @param string $lowerBound

* The lower bound Term *

* @return SolrQuery

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

*/ public function setTermsLowerBound($lowerBound) {} /** * (PECL solr >= 0.9.2)
* Sets the maximum document frequency * @link https://php.net/manual/en/solrquery.settermsmaxcount.php * @param int $frequency

* The maximum document frequency. *

* @return SolrQuery

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

*/ public function setTermsMaxCount($frequency) {} /** * (PECL solr >= 0.9.2)
* Sets the minimum document frequency * @link https://php.net/manual/en/solrquery.settermsmincount.php * @param int $frequency

* The minimum frequency *

* @return SolrQuery

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

*/ public function setTermsMinCount($frequency) {} /** * (PECL solr >= 0.9.2)
* Restrict matches to terms that start with the prefix * @link https://php.net/manual/en/solrquery.settermsprefix.php * @param string $prefix

* Restrict matches to terms that start with the prefix *

* @return SolrQuery

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

*/ public function setTermsPrefix($prefix) {} /** * (PECL solr >= 0.9.2)
* Return the raw characters of the indexed term * @link https://php.net/manual/en/solrquery.settermsreturnraw.php * @param bool $flag

* TRUE or FALSE *

* @return SolrQuery

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

*/ public function setTermsReturnRaw($flag) {} /** * (PECL solr >= 0.9.2)
* Specifies how to sort the returned terms * @link https://php.net/manual/en/solrquery.settermssort.php * @param 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 SolrQuery

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

*/ public function setTermsSort($sortType) {} /** * (PECL solr >= 0.9.2)
* Sets the term to stop at * @link https://php.net/manual/en/solrquery.settermsupperbound.php * @param string $upperBound

* The term to stop at *

* @return SolrQuery

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

*/ public function setTermsUpperBound($upperBound) {} /** * (PECL solr >= 0.9.2)
* The time allowed for search to finish * @link https://php.net/manual/en/solrquery.settimeallowed.php * @param 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 SolrQuery

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

*/ public function setTimeAllowed($timeAllowed) {} }