Current File : /home/graphicd/public_html/vebto/vendor/jetbrains/phpstorm-stubs/solr/Queries/SolrQuery.php
<?php
/**
* Helper autocomplete for php solr extension.
*
* @author Pierre-Julien Mazenot <pj.mazenot@gmail.com>
* @link https://github.com/pjmazenot/phpsolr-phpdoc
*/
/**
* (PECL solr >= 0.9.2)<br/>
* Class SolrQuery<br/>
* 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 */
const ORDER_ASC = 0;
/** @var int Used to specify that the sorting should be in descending order */
const ORDER_DESC = 1;
/** @var int Used to specify that the facet should sort by index */
const FACET_SORT_INDEX = 0;
/** @var int Used to specify that the facet should sort by count */
const FACET_SORT_COUNT = 1;
/** @var int Used in the TermsComponent */
const TERMS_SORT_INDEX = 0;
/** @var int Used in the TermsComponent */
const TERMS_SORT_COUNT = 1;
/**
* (PECL solr >= 2.2.0)<br/>
* 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 <p>
* Returns a SolrQuery object.
* </p>
*/
public function addExpandFilterQuery($fq) {}
/**
* (PECL solr >= 2.2.0)<br/>
* Orders the documents within the expanded groups (expand.sort parameter).
* @link https://php.net/manual/en/solrquery.addexpandsortfield.php
* @param string $field <p>
* Field name
* </p>
* @param string $order [optional] <p>
* Order ASC/DESC, utilizes SolrQuery::ORDER_* constants.
* </p>
* <p>
* Default: SolrQuery::ORDER_DESC
* </p>
* @return SolrQuery <p>
* Returns a SolrQuery object.
* </p>
*/
public function addExpandSortField($field, $order) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Maps to facet.date
* @link https://php.net/manual/en/solrquery.addfacetdatefield.php
* @param string $dateField <p>
* The name of the date field.
* </p>
* @return SolrQuery <p>
* Returns a SolrQuery object.
* </p>
*/
public function addFacetDateField($dateField) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Adds another facet.date.other parameter
* @link https://php.net/manual/en/solrquery.addfacetdateother.php
* @param string $value <p>
* The value to use.
* </p>
* @param string $field_override <p>
* The field name for the override.
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function addFacetDateOther($value, $field_override) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Adds another field to the facet
* @link https://php.net/manual/en/solrquery.addfacetfield.php
* @param string $field <p>
* The name of the field
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function addFacetField($field) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Adds a facet query
* @link https://php.net/manual/en/solrquery.addfacetquery.php
* @param string $facetQuery <p>
* The facet query
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function addFacetQuery($facetQuery) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Specifies which fields to return in the result
* @link https://php.net/manual/en/solrquery.addfield.php
* @param string $field <p>
* The name of the field
* </p>
* @return SolrQuery <p>
* Returns a SolrQuery object.
* </p>
*/
public function addField($field) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Specifies a filter query
* @link https://php.net/manual/en/solrquery.addfilterquery.php
* @param string $fq <p>
* The filter query
* </p>
* @return SolrQuery <p>
* Returns a SolrQuery object.
* </p>
*/
public function addFilterQuery($fq) {}
/**
* (PECL solr >= 2.2.0)<br/>
* Add a field to be used to group results.
* @link https://php.net/manual/en/solrquery.addgroupfield.php
* @param string $value
* @return SolrQuery <p>
* Returns a SolrQuery object.
* </p>
*/
public function addGroupField($value) {}
/**
* (PECL solr >= 2.2.0)<br/>
* 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 <p>
* Returns a SolrQuery object.
* </p>
*/
public function addGroupFunction($value) {}
/**
* (PECL solr >= 2.2.0)<br/>
* Allows grouping of documents that match the given query.
* @link https://php.net/manual/en/solrquery.addgroupquery.php
* @param string $value
* @return SolrQuery <p>
* Returns a SolrQuery object.
* </p>
*/
public function addGroupQuery($value) {}
/**
* (PECL solr >= 2.2.0)<br/>
* Add a group sort field (group.sort parameter).
* @link https://php.net/manual/en/solrquery.addgroupsortfield.php
* @param string $field <p>
* Field name
* </p>
* @param int $order <p>
* Order ASC/DESC, utilizes SolrQuery::ORDER_* constants
* </p>
* @return SolrQuery <p>
* Returns a SolrQuery object.
* </p>
*/
public function addGroupSortField($field, $order) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Maps to hl.fl
* @link https://php.net/manual/en/solrquery.addhighlightfield.php
* @param string $field <p>
* Name of the field
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function addHighlightField($field) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Sets a field to use for similarity
* @link https://php.net/manual/en/solrquery.addmltfield.php
* @param string $field <p>
* The name of the field
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function addMltField($field) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Maps to mlt.qf
* @link https://php.net/manual/en/solrquery.addmltqueryfield.php
* @param string $field <p>
* The name of the field
* </p>
* @param float $boost <p>
* Its boost value
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function addMltQueryField($field, $boost) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Used to control how the results should be sorted
* @link https://php.net/manual/en/solrquery.addsortfield.php
* @param string $field <p>
* The name of the field
* </p>
* @param int $order <p>
* The sort direction. This should be either SolrQuery::ORDER_ASC or SolrQuery::ORDER_DESC.
* </p>
* @return SolrQuery <p>
* Returns a SolrQuery object.
* </p>
*/
public function addSortField($field, $order = SolrQuery::ORDER_DESC) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Requests a return of sub results for values within the given facet
* @link https://php.net/manual/en/solrquery.addstatsfacet.php
* @param string $field <p>
* The name of the field
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function addStatsFacet($field) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Maps to stats.field parameter
* @link https://php.net/manual/en/solrquery.addstatsfield.php
* @param string $field <p>
* The name of the field
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function addStatsField($field) {}
/**
* (No version information available, might only be in Git)<br/>
* Collapses the result set to a single document per group
* @link https://php.net/manual/en/solrquery.collapse.php
* @param SolrCollapseFunction $collapseFunction
* @return SolrQuery <p>
* Returns a SolrQuery object.
* </p>
*/
public function collapse(SolrCollapseFunction $collapseFunction) {}
/**
* (PECL solr >= 0.9.2)<br/>
* SolrQuery constructor.
* @link https://php.net/manual/en/solrquery.construct.php
* @param string $q <p>
* Optional search query
* </p>
*/
public function __construct($q = '') {}
/**
* (PECL solr >= 0.9.2)<br/>
* Destructor
* @link https://php.net/manual/en/solrquery.destruct.php
*/
public function __destruct() {}
/**
* (PECL solr >= 2.2.0)<br/>
* Returns true if group expanding is enabled
* @link https://php.net/manual/en/solrquery.getexpand.php
* @return bool <p>
* Returns <b>TRUE</b> if group expanding is enabled
* </p>
*/
public function getExpand() {}
/**
* (PECL solr >= 2.2.0)<br/>
* Returns the expand filter queries
* @link https://php.net/manual/en/solrquery.getexpandfilterqueries.php
* @return array <p>
* Returns the expand filter queries
* </p>
*/
public function getExpandFilterQueries() {}
/**
* (PECL solr >= 2.2.0)<br/>
* Returns the expand query expand.q parameter
* @link https://php.net/manual/en/solrquery.getexpandquery.php
* @return array <p>
* Returns the expand query expand.q parameter
* </p>
*/
public function getExpandQuery() {}
/**
* (PECL solr >= 2.2.0)<br/>
* Returns The number of rows to display in each group (expand.rows)
* @link https://php.net/manual/en/solrquery.getexpandrows.php
* @return int <p>
* Returns The number of rows to display in each group (expand.rows)
* </p>
*/
public function getExpandRows() {}
/**
* (PECL solr >= 2.2.0)<br/>
* Returns an array of fields
* @link https://php.net/manual/en/solrquery.getexpandsortfields.php
* @return array <p>
* Returns an array of fields
* </p>
*/
public function getExpandSortFields() {}
/**
* (PECL solr >= 0.9.2)<br/>
* Returns the value of the facet parameter
* @link https://php.net/manual/en/solrquery.getfacet.php
* @return bool|null <p>
* Returns a boolean on success and <b>NULL</b> if not set
* </p>
*/
public function getFacet() {}
/**
* (PECL solr >= 0.9.2)<br/>
* Returns the value for the facet.date.end parameter
* @link https://php.net/manual/en/solrquery.getfacetdateend.php
* @param string $field_override [optional] <p>
* The name of the field
* </p>
* @return string|null <p>
* Returns a string on success and <b>NULL</b> if not set
* </p>
*/
public function getFacetDateEnd($field_override) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Returns all the facet.date fields
* @link https://php.net/manual/en/solrquery.getfacetdatefields.php
* @return array|null <p>
* Returns all the facet.date fields as an array or <b>NULL</b> if none was set
* </p>
*/
public function getFacetDateFields() {}
/**
* (PECL solr >= 0.9.2)<br/>
* Returns the value of the facet.date.gap parameter
* @link https://php.net/manual/en/solrquery.getfacetdategap.php
* @param string $field_override [optional] <p>
* The name of the field
* </p>
* @return string|null <p>
* Returns a string on success and <b>NULL</b> if not set
* </p>
*/
public function getFacetDateGap($field_override) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Returns the value of the facet.date.hardend parameter
* @link https://php.net/manual/en/solrquery.getfacetdatehardend.php
* @param string $field_override [optional] <p>
* The name of the field
* </p>
* @return string|null <p>
* Returns a string on success and <b>NULL</b> if not set
* </p>
*/
public function getFacetDateHardEnd($field_override) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Returns the value for the facet.date.other parameter
* @link https://php.net/manual/en/solrquery.getfacetdatehardend.php
* @param string $field_override [optional] <p>
* The name of the field
* </p>
* @return array|null <p>
* Returns an array on success and <b>NULL</b> if not set
* </p>
*/
public function getFacetDateOther($field_override) {}
/**
* (PECL solr >= 0.9.2)<br/>
* 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] <p>
* The name of the field
* </p>
* @return string|null <p>
* Returns a string on success and <b>NULL</b> if not set
* </p>
*/
public function getFacetDateStart($field_override) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Returns all the facet fields
* @link https://php.net/manual/en/solrquery.getfacetfields.php
* @return array|null <p>
* Returns an array of all the fields and <b>NULL</b> if none was set
* </p>
*/
public function getFacetFields() {}
/**
* (PECL solr >= 0.9.2)<br/>
* 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] <p>
* The name of the field
* </p>
* @return int|null <p>
* Returns an integer on success and <b>NULL</b> if not set
* </p>
*/
public function getFacetLimit($field_override) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Returns the value of the facet.method parameter
* @link https://php.net/manual/en/solrquery.getfacetmethod.php
* @param string $field_override [optional] <p>
* The name of the field
* </p>
* @return string|null <p>
* Returns a string on success and <b>NULL</b> if not set
* </p>
*/
public function getFacetMethod($field_override) {}
/**
* (PECL solr >= 0.9.2)<br/>
* 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] <p>
* The name of the field
* </p>
* @return int|null <p>
* Returns an integer on success and <b>NULL</b> if not set
* </p>
*/
public function getFacetMinCount($field_override) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Returns the current state of the facet.missing parameter
* @link https://php.net/manual/en/solrquery.getfacetmissing.php
* @param string $field_override [optional] <p>
* The name of the field
* </p>
* @return string|null <p>
* Returns a boolean on success and <b>NULL</b> if not set
* </p>
*/
public function getFacetMissing($field_override) {}
/**
* (PECL solr >= 0.9.2)<br/>
* 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] <p>
* The name of the field
* </p>
* @return int|null <p>
* Returns an integer on success and <b>NULL</b> if not set
* </p>
*/
public function getFacetOffset($field_override) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Returns the facet prefix
* @link https://php.net/manual/en/solrquery.getfacetprefix.php
* @param string $field_override [optional] <p>
* The name of the field
* </p>
* @return string|null <p>
* Returns a string on success and <b>NULL</b> if not set
* </p>
*/
public function getFacetPrefix($field_override) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Returns all the facet queries
* @link https://php.net/manual/en/solrquery.getfacetqueries.php
* @return string|null <p>
* Returns an array on success and <b>NULL</b> if not set
* </p>
*/
public function getFacetQueries() {}
/**
* (PECL solr >= 0.9.2)<br/>
* Returns the facet sort type
* @link https://php.net/manual/en/solrquery.getfacetsort.php
* @param string $field_override [optional] <p>
* The name of the field
* </p>
* @return int|null <p>
* Returns an integer (SolrQuery::FACET_SORT_INDEX or SolrQuery::FACET_SORT_COUNT) on success or <b>NULL</b> if not
* set.
* </p>
*/
public function getFacetSort($field_override) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Returns the list of fields that will be returned in the response
* @link https://php.net/manual/en/solrquery.getfields.php
* @return string|null <p>
* Returns an array on success and <b>NULL</b> if not set
* </p>
*/
public function getFields() {}
/**
* (PECL solr >= 0.9.2)<br/>
* Returns an array of filter queries
* @link https://php.net/manual/en/solrquery.getfilterqueries.php
* @return string|null <p>
* Returns an array on success and <b>NULL</b> if not set
* </p>
*/
public function getFilterQueries() {}
/**
* (PECL solr >= 2.2.0)<br/>
* Returns true if grouping is enabled
* https://secure.php.net/manual/en/solrquery.getgroup.php
* @return bool <p>
* Returns true if grouping is enabled
* </p>
*/
public function getGroup() {}
/**
* (PECL solr >= 2.2.0)<br/>
* Returns group cache percent value
* @link https://php.net/manual/en/solrquery.getgroupcachepercent.php
* @return int <p>
* Returns group cache percent value
* </p>
*/
public function getGroupCachePercent() {}
/**
* (PECL solr >= 2.2.0)<br/>
* Returns the group.facet parameter value
* @link https://php.net/manual/en/solrquery.getgroupfacet.php
* @return bool <p>
* Returns the group.facet parameter value
* </p>
*/
public function getGroupFacet() {}
/**
* (PECL solr >= 2.2.0)<br/>
* Returns group fields (group.field parameter values)
* @link https://php.net/manual/en/solrquery.getgroupfields.php
* @return array <p>
* Returns group fields (group.field parameter values)
* </p>
*/
public function getGroupFields() {}
/**
* (PECL solr >= 2.2.0)<br/>
* Returns the group.format value
* @link https://php.net/manual/en/solrquery.getgroupformat.php
* @return string <p>
* Returns the group.format value
* </p>
*/
public function getGroupFormat() {}
/**
* (PECL solr >= 2.2.0)<br/>
* Returns group functions (group.func parameter values)
* @link https://php.net/manual/en/solrquery.getgroupfunctions.php
* @return array <p>
* Returns group functions (group.func parameter values)
* </p>
*/
public function getGroupFunctions() {}
/**
* (PECL solr >= 2.2.0)<br/>
* Returns the group.limit value
* @link https://php.net/manual/en/solrquery.getgrouplimit.php
* @return int <p>
* Returns the group.limit value
* </p>
*/
public function getGroupLimit() {}
/**
* (PECL solr >= 2.2.0)<br/>
* Returns the group.main value
* @link https://php.net/manual/en/solrquery.getgroupmain.php
* @return bool <p>
* Returns the group.main value
* </p>
*/
public function getGroupMain() {}
/**
* (PECL solr >= 2.2.0)<br/>
* Returns the group.ngroups value
* @link https://php.net/manual/en/solrquery.getgroupngroups.php
* @return bool <p>
* Returns the group.ngroups value
* </p>
*/
public function getGroupNGroups() {}
/**
* (PECL solr >= 2.2.0)<br/>
* Returns the group.offset value
* @link https://php.net/manual/en/solrquery.getgroupoffset.php
* @return bool <p>
* Returns the group.offset value
* </p>
*/
public function getGroupOffset() {}
/**
* (PECL solr >= 2.2.0)<br/>
* Returns all the group.query parameter values
* @link https://php.net/manual/en/solrquery.getgroupqueries.php
* @return array <p>
* Returns all the group.query parameter values
* </p>
*/
public function getGroupQueries() {}
/**
* (PECL solr >= 2.2.0)<br/>
* Returns the group.sort value
* @link https://php.net/manual/en/solrquery.getgroupsortfields.php
* @return array <p>
* Returns all the group.sort parameter values
* </p>
*/
public function getGroupSortFields() {}
/**
* (PECL solr >= 2.2.0)<br/>
* Returns the group.truncate value
* @link https://php.net/manual/en/solrquery.getgrouptruncate.php
* @return bool <p>
* Returns the group.truncate value
* </p>
*/
public function getGroupTruncate() {}
/**
* (PECL solr >= 0.9.2)<br/>
* Returns the state of the hl parameter
* @link https://php.net/manual/en/solrquery.gethighlight.php
* @return bool <p>
* Returns the state of the hl parameter
* </p>
*/
public function getHighlight() {}
/**
* (PECL solr >= 0.9.2)<br/>
* Returns the highlight field to use as backup or default
* @link https://php.net/manual/en/solrquery.gethighlightalternatefield.php
* @param string $field_override [optional] <p>
* The name of the field
* </p>
* @return string|null <p>
* Returns a string on success and <b>NULL</b> if not set
* </p>
*/
public function getHighlightAlternateField($field_override) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Returns all the fields that Solr should generate highlighted snippets for
* @link https://php.net/manual/en/solrquery.gethighlightfields.php
* @return array|null <p>
* Returns an array on success and <b>NULL</b> if not set
* </p>
*/
public function getHighlightFields() {}
/**
* (PECL solr >= 0.9.2)<br/>
* Returns the formatter for the highlighted output
* @link https://php.net/manual/en/solrquery.gethighlightformatter.php
* @param string $field_override [optional] <p>
* The name of the field
* </p>
* @return string|null <p>
* Returns a string on success and <b>NULL</b> if not set
* </p>
*/
public function getHighlightFormatter($field_override) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Returns the text snippet generator for highlighted text
* @link https://php.net/manual/en/solrquery.gethighlightfragmenter.php
* @param string $field_override [optional] <p>
* The name of the field
* </p>
* @return string|null <p>
* Returns a string on success and <b>NULL</b> if not set
* </p>
*/
public function getHighlightFragmenter($field_override) {}
/**
* (PECL solr >= 0.9.2)<br/>
* 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] <p>
* The name of the field
* </p>
* @return int|null <p>
* Returns an integer on success and <b>NULL</b> if not set
* </p>
*/
public function getHighlightFragsize($field_override) {}
/**
* (PECL solr >= 0.9.2)<br/>
* 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 <p>
* Returns a boolean on success and <b>NULL</b> if not set
* </p>
*/
public function getHighlightHighlightMultiTerm() {}
/**
* (PECL solr >= 0.9.2)<br/>
* 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] <p>
* The name of the field
* </p>
* @return int|null <p>
* Returns an integer on success and <b>NULL</b> if not set
* </p>
*/
public function getHighlightMaxAlternateFieldLength($field_override) {}
/**
* (PECL solr >= 0.9.2)<br/>
* 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 <p>
* Returns an integer on success and <b>NULL</b> if not set
* </p>
*/
public function getHighlightMaxAnalyzedChars() {}
/**
* (PECL solr >= 0.9.2)<br/>
* 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] <p>
* The name of the field
* </p>
* @return bool|null <p>
* Returns a boolean on success and <b>NULL</b> if not set
* </p>
*/
public function getHighlightMergeContiguous($field_override) {}
/**
* (PECL solr >= 0.9.2)<br/>
* 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 <p>
* Returns an integer on success and <b>NULL</b> if not set
* </p>
*/
public function getHighlightRegexMaxAnalyzedChars() {}
/**
* (PECL solr >= 0.9.2)<br/>
* Returns the regular expression for fragmenting
* @link https://php.net/manual/en/solrquery.gethighlightregexpattern.php
* @return string <p>
* Returns a string on success and <b>NULL</b> if not set
* </p>
*/
public function getHighlightRegexPattern() {}
/**
* (PECL solr >= 0.9.2)<br/>
* Returns the deviation factor from the ideal fragment size
* @link https://php.net/manual/en/solrquery.gethighlightregexslop.php
* @return float|null <p>
* Returns a double on success and <b>NULL</b> if not set.
* </p>
*/
public function getHighlightRegexSlop() {}
/**
* (PECL solr >= 0.9.2)<br/>
* 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 <p>
* Returns a boolean on success and <b>NULL</b> if not set
* </p>
*/
public function getHighlightRequireFieldMatch() {}
/**
* (PECL solr >= 0.9.2)<br/>
* Returns the text which appears after a highlighted term
* @link https://php.net/manual/en/solrquery.gethighlightsimplepost.php
* @param string $field_override [optional] <p>
* The name of the field
* </p>
* @return string|null <p>
* Returns a string on success and <b>NULL</b> if not set
* </p>
*/
public function getHighlightSimplePost($field_override) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Returns the text which appears before a highlighted term
* @link https://php.net/manual/en/solrquery.gethighlightsimplepre.php
* @param string $field_override [optional] <p>
* The name of the field
* </p>
* @return string|null <p>
* Returns a string on success and <b>NULL</b> if not set
* </p>
*/
public function getHighlightSimplePre($field_override) {}
/**
* (PECL solr >= 0.9.2)<br/>
* 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] <p>
* The name of the field
* </p>
* @return int|null <p>
* Returns an integer on success and <b>NULL</b> if not set
* </p>
*/
public function getHighlightSnippets($field_override) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Returns the state of the hl.usePhraseHighlighter parameter
* @link https://php.net/manual/en/solrquery.gethighlightusephrasehighlighter.php
* @return bool|null <p>
* Returns a boolean on success and <b>NULL</b> if not set
* </p>
*/
public function getHighlightUsePhraseHighlighter() {}
/**
* (PECL solr >= 0.9.2)<br/>
* Returns whether or not MoreLikeThis results should be enabled
* @link https://php.net/manual/en/solrquery.getmlt.php
* @return bool|null <p>
* Returns a boolean on success and <b>NULL</b> if not set
* </p>
*/
public function getMlt() {}
/**
* (PECL solr >= 0.9.2)<br/>
* 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 <p>
* Returns a boolean on success and <b>NULL</b> if not set
* </p>
*/
public function getMltBoost() {}
/**
* (PECL solr >= 0.9.2)<br/>
* Returns the number of similar documents to return for each result
* @link https://php.net/manual/en/solrquery.getmltcount.php
* @return int|null <p>
* Returns an integer on success and <b>NULL</b> if not set
* </p>
*/
public function getMltCount() {}
/**
* (PECL solr >= 0.9.2)<br/>
* Returns all the fields to use for similarity
* @link https://php.net/manual/en/solrquery.getmltfields.php
* @return array <p>
* Returns an array on success and <b>NULL</b> if not set
* </p>
*/
public function getMltFields() {}
/**
* (PECL solr >= 0.9.2)<br/>
* 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 <p>
* Returns an integer on success and <b>NULL</b> if not set
* </p>
*/
public function getMltMaxNumQueryTerms() {}
/**
* (PECL solr >= 0.9.2)<br/>
* 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 <p>
* Returns an integer on success and <b>NULL</b> if not set
* </p>
*/
public function getMltMaxNumTokens() {}
/**
* (PECL solr >= 0.9.2)<br/>
* Returns the maximum word length above which words will be ignored
* @link https://php.net/manual/en/solrquery.getmltmaxwordlength.php
* @return int|null <p>
* Returns an integer on success and <b>NULL</b> if not set
* </p>
*/
public function getMltMaxWordLength() {}
/**
* (PECL solr >= 0.9.2)<br/>
* Returns the treshold 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 <p>
* Returns an integer on success and <b>NULL</b> if not set
* </p>
*/
public function getMltMinDocFrequency() {}
/**
* (PECL solr >= 0.9.2)<br/>
* 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 <p>
* Returns an integer on success and <b>NULL</b> if not set
* </p>
*/
public function getMltMinTermFrequency() {}
/**
* (PECL solr >= 0.9.2)<br/>
* Returns the minimum word length below which words will be ignored
* @link https://php.net/manual/en/solrquery.getmltminwordlength.php
* @return int <p>
* Returns an integer on success and <b>NULL</b> if not set
* </p>
*/
public function getMltMinWordLength() {}
/**
* (PECL solr >= 0.9.2)<br/>
* Returns the query fields and their boosts
* @link https://php.net/manual/en/solrquery.getmltqueryfields.php
* @return array|null <p>
* Returns an array on success and <b>NULL</b> if not set
* </p>
*/
public function getMltQueryFields() {}
/**
* (PECL solr >= 0.9.2)<br/>
* Returns the main query
* @link https://php.net/manual/en/solrquery.getquery.php
* @return string <p>
* Returns a string on success and <b>NULL</b> if not set
* </p>
*/
public function getQuery() {}
/**
* (PECL solr >= 0.9.2)<br/>
* Returns the maximum number of documents
* @link https://php.net/manual/en/solrquery.getrows.php
* @return int|null <p>
* Returns an integer on success and <b>NULL</b> if not set
* </p>
*/
public function getRows() {}
/**
* (PECL solr >= 0.9.2)<br/>
* Returns all the sort fields
* @link https://php.net/manual/en/solrquery.getsortfields.php
* @return array <p>
* Returns an array on success and <b>NULL</b> if none of the parameters was set.
* </p>
*/
public function getSortFields() {}
/**
* (PECL solr >= 0.9.2)<br/>
* Returns the offset in the complete result set
* @link https://php.net/manual/en/solrquery.getstart.php
* @return int|null <p>
* Returns an integer on success and <b>NULL</b> if not set
* </p>
*/
public function getStart() {}
/**
* (PECL solr >= 0.9.2)<br/>
* Returns whether or not stats is enabled
* @link https://php.net/manual/en/solrquery.getstats.php
* @return bool|null <p>
* Returns a boolean on success and <b>NULL</b> if not set
* </p>
*/
public function getStats() {}
/**
* (PECL solr >= 0.9.2)<br/>
* Returns all the stats facets that were set
* @link https://php.net/manual/en/solrquery.getstatsfacets.php
* @return array|null <p>
* Returns an array on success and <b>NULL</b> if not set
* </p>
*/
public function getStatsFacets() {}
/**
* (PECL solr >= 0.9.2)<br/>
* Returns all the statistics fields
* @link https://php.net/manual/en/solrquery.getstatsfields.php
* @return array|null <p>
* Returns an array on success and <b>NULL</b> if not set
* </p>
*/
public function getStatsFields() {}
/**
* (PECL solr >= 0.9.2)<br/>
* Returns whether or not the TermsComponent is enabled
* @link https://php.net/manual/en/solrquery.getterms.php
* @return bool|null <p>
* Returns a boolean on success and <b>NULL</b> if not set
* </p>
*/
public function getTerms() {}
/**
* (PECL solr >= 0.9.2)<br/>
* Returns the field from which the terms are retrieved
* @link https://php.net/manual/en/solrquery.gettermsfield.php
* @return string|null <p>
* Returns a string on success and <b>NULL</b> if not set
* </p>
*/
public function getTermsField() {}
/**
* (PECL solr >= 0.9.2)<br/>
* 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 <p>
* Returns a boolean on success and <b>NULL</b> if not set
* </p>
*/
public function getTermsIncludeLowerBound() {}
/**
* (PECL solr >= 0.9.2)<br/>
* 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 <p>
* Returns a boolean on success and <b>NULL</b> if not set
* </p>
*/
public function getTermsIncludeUpperBound() {}
/**
* (PECL solr >= 0.9.2)<br/>
* Returns the maximum number of terms Solr should return
* @link https://php.net/manual/en/solrquery.gettermslimit.php
* @return int|null <p>
* Returns an integer on success and <b>NULL</b> if not set
* </p>
*/
public function getTermsLimit() {}
/**
* (PECL solr >= 0.9.2)<br/>
* Returns the term to start at
* @link https://php.net/manual/en/solrquery.gettermslowerbound.php
* @return string|null <p>
* Returns a string on success and <b>NULL</b> if not set
* </p>
*/
public function getTermsLowerBound() {}
/**
* (PECL solr >= 0.9.2)<br/>
* Returns the maximum document frequency
* @link https://php.net/manual/en/solrquery.gettermsmaxcount.php
* @return int|null <p>
* Returns an integer on success and <b>NULL</b> if not set
* </p>
*/
public function getTermsMaxCount() {}
/**
* (PECL solr >= 0.9.2)<br/>
* Returns the minimum document frequency to return in order to be included
* @link https://php.net/manual/en/solrquery.gettermsmincount.php
* @return int|null <p>
* Returns an integer on success and <b>NULL</b> if not set
* </p>
*/
public function getTermsMinCount() {}
/**
* (PECL solr >= 0.9.2)<br/>
* Returns the term prefix
* @link https://php.net/manual/en/solrquery.gettermsprefix.php
* @return string|null <p>
* Returns a string on success and <b>NULL</b> if not set
* </p>
*/
public function getTermsPrefix() {}
/**
* (PECL solr >= 0.9.2)<br/>
* Whether or not to return raw characters
* @link https://php.net/manual/en/solrquery.gettermsreturnraw.php
* @return bool|null <p>
* Returns a boolean on success and <b>NULL</b> if not set
* </p>
*/
public function getTermsReturnRaw() {}
/**
* (PECL solr >= 0.9.2)<br/>
* Returns an integer indicating how terms are sorted
* @link https://php.net/manual/en/solrquery.gettermssort.php
* @return int|null <p>
* Returns an integer on success and <b>NULL</b> if not set<br/>
* SolrQuery::TERMS_SORT_INDEX indicates that the terms are returned by index order.<br/>
* SolrQuery::TERMS_SORT_COUNT implies that the terms are sorted by term frequency (highest count first)
* </p>
*/
public function getTermsSort() {}
/**
* (PECL solr >= 0.9.2)<br/>
* Returns the term to stop at
* @link https://php.net/manual/en/solrquery.gettermsupperbound.php
* @return string|null <p>
* Returns a string on success and <b>NULL</b> if not set
* </p>
*/
public function getTermsUpperBound() {}
/**
* (PECL solr >= 0.9.2)<br/>
* Returns the time in milliseconds allowed for the query to finish
* @link https://php.net/manual/en/solrquery.gettimeallowed.php
* @return int|null <p>
* Returns an integer on success and <b>NULL</b> if not set
* </p>
*/
public function getTimeAllowed() {}
/**
* (PECL solr >= 2.2.0)<br/>
* Removes an expand filter query
* @link https://php.net/manual/en/solrquery.removeexpandfilterquery.php
* @param string $fq
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function removeExpandFilterQuery($fq) {}
/**
* (PECL solr >= 2.2.0)<br/>
* Removes an expand sort field from the expand.sort parameter.
* @link https://php.net/manual/en/solrquery.removeexpandsortfield.php
* @param string $field <p>
* Field name
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function removeExpandSortField($field) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Removes one of the facet date fields
* @link https://php.net/manual/en/solrquery.removefacetdatefield.php
* @param string $field <p>
* The name of the date field to remove
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function removeFacetDateField($field) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Removes one of the facet.date.other parameters
* @link https://php.net/manual/en/solrquery.removefacetdateother.php
* @param string $value <p>
* The value
* </p>
* @param string $field_override [optional] <p>
* The name of the field.
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function removeFacetDateOther($value, $field_override) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Removes one of the facet.date parameters
* @link https://php.net/manual/en/solrquery.removefacetfield.php
* @param string $field <p>
* The name of the field
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function removeFacetField($field) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Removes one of the facet.query parameters
* @link https://php.net/manual/en/solrquery.removefacetquery.php
* @param string $value <p>
* The value
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function removeFacetQuery($value) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Removes a field from the list of fields
* @link https://php.net/manual/en/solrquery.removefield.php
* @param string $field <p>
* The name of the field
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function removeField($field) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Removes a filter query
* @link https://php.net/manual/en/solrquery.removefilterquery.php
* @param string $fq
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function removeFilterQuery($fq) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Removes one of the fields used for highlighting
* @link https://php.net/manual/en/solrquery.removehighlightfield.php
* @param string $field <p>
* The name of the field
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function removeHighlightField($field) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Removes one of the moreLikeThis fields
* @link https://php.net/manual/en/solrquery.removemltfield.php
* @param string $field <p>
* The name of the field
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function removeMltField($field) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Removes one of the moreLikeThis query fields
* @link https://php.net/manual/en/solrquery.removemltqueryfield.php
* @param string $queryField <p>
* The query field
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function removeMltQueryField($queryField) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Removes one of the sort fields
* @link https://php.net/manual/en/solrquery.removesortfield.php
* @param string $field <p>
* The name of the field
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function removeSortField($field) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Removes one of the stats.facet parameters
* @link https://php.net/manual/en/solrquery.removestatsfacet.php
* @param string $value <p>
* The value
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function removeStatsFacet($value) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Removes one of the stats.field parameters
* @link https://php.net/manual/en/solrquery.removestatsfield.php
* @param string $field <p>
* The name of the field
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function removeStatsField($field) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Toggles the echoHandler parameter
* @link https://php.net/manual/en/solrquery.setechohandler.php
* @param bool $flag <p>
* <b>TRUE</b> or <b>FALSE</b>
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setEchoHandler($flag) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Determines what kind of parameters to include in the response
* @link https://php.net/manual/en/solrquery.setechoparams.php
* @param string $type <p>
* The type of parameters to include:
* </p>
* <ul>
* <li><b>none</b>: don't include any request parameters for debugging</li>
* <li><b>explicit</b>: include the parameters explicitly specified by the client in the request</li>
* <li><b>all</b>: include all parameters involved in this request, either specified explicitly by the client, or
* implicit because of the request handler configuration.</li>
* </ul>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setEchoParams($type) {}
/**
* (PECL solr >= 2.2.0)<br/>
* Enables/Disables the Expand Component
* @link https://php.net/manual/en/solrquery.setexpand.php
* @param bool $value <p>
* Bool flag
* </b>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setExpand($value) {}
/**
* (PECL solr >= 2.2.0)<br/>
* Sets the expand.q parameter
* @link https://php.net/manual/en/solrquery.setexpandquery.php
* @param string $q
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setExpandQuery($q) {}
/**
* (PECL solr >= 2.2.0)<br/>
* 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 integer $value
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setExpandRows($value) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Sets the explainOther common query parameter
* @link https://php.net/manual/en/solrquery.setexplainother.php
* @param string $query <p>
* The Lucene query to identify a set of documents
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setExplainOther($query) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Maps to the facet parameter. Enables or disables facetting
* @link https://php.net/manual/en/solrquery.setfacet.php
* @param bool $flag <p>
* <b>TRUE</b> enables faceting and <b>FALSE</b> disables it.
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setFacet($flag) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Maps to facet.date.end
* @link https://php.net/manual/en/solrquery.setfacetdateend.php
* @param string $value <p>
* See facet.date.end
* </p>
* @param string $field_override [optional] <p>
* Name of the field
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setFacetDateEnd($value, $field_override) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Maps to facet.date.gap
* @link https://php.net/manual/en/solrquery.setfacetdategap.php
* @param string $value <p>
* See facet.date.gap
* </p>
* @param string $field_override [optional] <p>
* Name of the field
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setFacetDateGap($value, $field_override) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Maps to facet.date.hardend
* @link https://php.net/manual/en/solrquery.setfacetdatehardend.php
* @param string $value <p>
* See facet.date.hardend
* </p>
* @param string $field_override [optional] <p>
* Name of the field
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setFacetDateHardEnd($value, $field_override) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Maps to facet.date.start
* @link https://php.net/manual/en/solrquery.setfacetdatestart.php
* @param string $value <p>
* See facet.date.start
* </p>
* @param string $field_override [optional] <p>
* Name of the field
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setFacetDateStart($value, $field_override) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Sets the minimum document frequency used for determining term count
* @link https://php.net/manual/en/solrquery.setfacetenumcachemindefaultfrequency.php
* @param int $frequency <p>
* The minimum frequency
* </p>
* @param string $field_override [optional] <p>
* Name of the field
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setFacetEnumCacheMinDefaultFrequency($frequency, $field_override) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Maps to facet.limit
* @link https://php.net/manual/en/solrquery.setfacetlimit.php
* @param int $limit <p>
* The maximum number of constraint counts
* </p>
* @param string $field_override [optional] <p>
* Name of the field
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setFacetLimit($limit, $field_override) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Specifies the type of algorithm to use when faceting a field
* @link https://php.net/manual/en/solrquery.setfacetmethod.php
* @param string $method <p>
* The method to use.
* </p>
* @param string $field_override [optional] <p>
* Name of the field
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setFacetMethod($method, $field_override) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Maps to facet.mincount
* @link https://php.net/manual/en/solrquery.setfacetmincount.php
* @param int $mincount <p>
* The minimum count
* </p>
* @param string $field_override [optional] <p>
* Name of the field
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setFacetMinCount($mincount, $field_override) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Maps to facet.missing
* @link https://php.net/manual/en/solrquery.setfacetmissing.php
* @param bool $flag <p>
* <b>TRUE</b> turns this feature on. <b>FALSE</b> disables it.
* </p>
* @param string $field_override [optional] <p>
* Name of the field
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setFacetMissing($flag, $field_override) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Sets the offset into the list of constraints to allow for pagination
* @link https://php.net/manual/en/solrquery.setfacetoffset.php
* @param int $offset <p>
* The offset
* </p>
* @param string $field_override [optional] <p>
* Name of the field
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setFacetOffset($offset, $field_override) {}
/**
* (PECL solr >= 0.9.2)<br/>
* 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 <p>
* The prefix string
* </p>
* @param string $field_override [optional] <p>
* Name of the field
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setFacetPrefix($prefix, $field_override) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Determines the ordering of the facet field constraints
* @link https://php.net/manual/en/solrquery.setfacetsort.php
* @param int $facetSort <p>
* Use SolrQuery::FACET_SORT_INDEX for sorting by index order or SolrQuery::FACET_SORT_COUNT for sorting by count.
* </p>
* @param string $field_override [optional] <p>
* Name of the field
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setFacetSort($facetSort, $field_override) {}
/**
* (PECL solr >= 2.2.0)<br/>
* Enable/Disable result grouping (group parameter)
* @link https://php.net/manual/en/solrquery.setgroup.php
* @param bool $value
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setGroup($value) {}
/**
* (PECL solr >= 2.2.0)<br/>
* Enables caching for result grouping
* @link https://php.net/manual/en/solrquery.setgroupcachepercent.php
* @param int $percent <p>
* 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.
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setGroupCachePercent($percent) {}
/**
* (PECL solr >= 2.2.0)<br/>
* Sets group.facet parameter
* @link https://php.net/manual/en/solrquery.setgroupfacet.php
* @param bool $value
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setGroupFacet($value) {}
/**
* (PECL solr >= 2.2.0)<br/>
* Sets the group format, result structure (group.format parameter).
* @link https://php.net/manual/en/solrquery.setgroupformat.php
* @param string $value <p>
* 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.<br/>
* Accepts: grouped/simple
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setGroupFormat($value) {}
/**
* (PECL solr >= 2.2.0)<br/>
* 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 <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setGroupLimit($value) {}
/**
* (PECL solr >= 2.2.0)<br/>
* 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 <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setGroupMain($value) {}
/**
* (PECL solr >= 2.2.0)<br/>
* 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 <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setGroupNGroups($value) {}
/**
* (PECL solr >= 2.2.0)<br/>
* Sets the group.offset parameter.
* @link https://php.net/manual/en/solrquery.setgroupoffset.php
* @param int $value
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setGroupOffset($value) {}
/**
* (PECL solr >= 2.2.0)<br/>
* 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 <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setGroupTruncate($value) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Enables or disables highlighting
* @link https://php.net/manual/en/solrquery.sethighlight.php
* @param bool $flag<p>
* Setting it to <b>TRUE</b> enables highlighted snippets to be generated in the query response.<br/>
* Setting it to <b>FALSE</b> disables highlighting
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setHighlight($flag) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Specifies the backup field to use
* @link https://php.net/manual/en/solrquery.sethighlightalternatefield.php
* @param string $field <p>
* The name of the backup field
* </p>
* @param string $field_override [optional] <p>
* Name of the field
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setHighlightAlternateField($field, $field_override) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Specify a formatter for the highlight output
* @link https://php.net/manual/en/solrquery.sethighlightformatter.php
* @param string $formatter <p>
* Currently the only legal value is "simple"
* </p>
* @param string $field_override [optional] <p>
* Name of the field
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setHighlightFormatter($formatter, $field_override) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Sets a text snippet generator for highlighted text
* @link https://php.net/manual/en/solrquery.sethighlightfragmenter.php
* @param string $fragmenter <p>
* The standard fragmenter is gap. Another option is regex, which tries to create fragments that resembles a certain
* regular expression
* </p>
* @param string $field_override [optional] <p>
* Name of the field
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setHighlightFragmenter($fragmenter, $field_override) {}
/**
* (PECL solr >= 0.9.2)<br/>
* The size of fragments to consider for highlighting
* @link https://php.net/manual/en/solrquery.sethighlightfragsize.php
* @param int $size <p>
* The size, in characters, of fragments to consider for highlighting
* </p>
* @param string $field_override [optional] <p>
* Name of the field
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setHighlightFragsize($size, $field_override) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Use SpanScorer to highlight phrase terms
* @link https://php.net/manual/en/solrquery.sethighlighthighlightmultiterm.php
* @param bool $flag <p>
* Whether or not to use SpanScorer to highlight phrase terms only when they appear within the query phrase in the
* document.
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setHighlightHighlightMultiTerm($flag) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Sets the maximum number of characters of the field to return
* @link https://php.net/manual/en/solrquery.sethighlightmaxalternatefieldlength.php
* @param string $fieldLength <p>
* The length of the field
* </p>
* <p>
* If SolrQuery::setHighlightAlternateField() was passed the value <b>TRUE</b>, this parameter specifies the maximum
* number of characters of the field to return
* </p>
* <p>
* Any value less than or equal to 0 means unlimited.
* </p>
* @param string $field_override [optional] <p>
* Name of the field
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setHighlightMaxAlternateFieldLength($fieldLength, $field_override) {}
/**
* (PECL solr >= 0.9.2)<br/>
* 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 <p>
* The number of characters into a document to look for suitable snippets
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setHighlightMaxAnalyzedChars($value) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Whether or not to collapse contiguous fragments into a single fragment
* @link https://php.net/manual/en/solrquery.sethighlightmergecontiguous.php
* @param bool $flag <p>
* Whether or not to collapse contiguous fragments into a single fragment
* </p>
* @param string $field_override [optional] <p>
* Name of the field
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setHighlightMergeContiguous($flag, $field_override) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Specify the maximum number of characters to analyze
* @link https://php.net/manual/en/solrquery.sethighlightregexmaxanalyzedchars.php
* @param int $maxAnalyzedChars <p>
* The maximum number of characters to analyze from a field when using the regex fragmenter
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setHighlightRegexMaxAnalyzedChars($maxAnalyzedChars) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Specify the regular expression for fragmenting
* @link https://php.net/manual/en/solrquery.sethighlightregexpattern.php
* @param string $value <p>
* The regular expression for fragmenting. This could be used to extract sentences
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setHighlightRegexPattern($value) {}
/**
* (PECL solr >= 0.9.2)<br/>
* 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 <p>
* The factor by which the regex fragmenter can stray from the ideal fragment size (specfied by
* SolrQuery::setHighlightFragsize) to accommodate the regular expression.
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setHighlightRegexSlop($factor) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Require field matching during highlighting
* @link https://php.net/manual/en/solrquery.sethighlightrequirefieldmatch.php
* @param bool $flag <p>
* If <b>TRUE</b>, then a field will only be highlighted if the query matched in this particular field.<br/>
* This will only work if SolrQuery::setHighlightUsePhraseHighlighter() was set to <b>TRUE</b>.
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setHighlightRequireFieldMatch($flag) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Sets the text which appears after a highlighted term
* @link https://php.net/manual/en/solrquery.sethighlightsimplepost.php
* @param string $simplePost <p>
* Sets the text which appears after a highlighted term. The default is </em>
* </p>
* @param string $field_override [optional] <p>
* Name of the field
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setHighlightSimplePost($simplePost, $field_override) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Sets the text which appears before a highlighted term
* @link https://php.net/manual/en/solrquery.sethighlightsimplepre.php
* @param string $simplePre <p>
* Sets the text which appears before a highlighted term. The default is <em>
* </p>
* @param string $field_override [optional] <p>
* Name of the field
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setHighlightSimplePre($simplePre, $field_override) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Sets the maximum number of highlighted snippets to generate per field
* @link https://php.net/manual/en/solrquery.sethighlightsnippets.php
* @param int $value <p>
* The maximum number of highlighted snippets to generate per field
* </p>
* @param string $field_override [optional] <p>
* Name of the field
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setHighlightSnippets($value, $field_override) {}
/**
* (PECL solr >= 0.9.2)<br/>
* 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 <p>
* Whether or not to use SpanScorer to highlight phrase terms only when they appear within the query phrase in the
* document.
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setHighlightUsePhraseHighlighter($flag) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Enables or disables moreLikeThis
* @link https://php.net/manual/en/solrquery.setmlt.php
* @param bool $flag <p>
* <b>TRUE</b> enables it and <b>FALSE</b> turns it off.
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setMlt($flag) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Set if the query will be boosted by the interesting term relevance
* @link https://php.net/manual/en/solrquery.setmltboost.php
* @param bool $flag <p>
* Sets to <b>TRUE</b> or <b>FALSE</b>
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setMltBoost($flag) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Set the number of similar documents to return for each result
* @link https://php.net/manual/en/solrquery.setmltcount.php
* @param int $count <p>
* The number of similar documents to return for each result
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setMltCount($count) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Sets the maximum number of query terms included
* @link https://php.net/manual/en/solrquery.setmltmaxnumqueryterms.php
* @param int $value <p>
* The maximum number of query terms that will be included in any generated query
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setMltMaxNumQueryTerms($value) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Specifies the maximum number of tokens to parse
* @link https://php.net/manual/en/solrquery.setmltmaxnumtokens.php
* @param int $value <p>
* The maximum number of tokens to parse
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setMltMaxNumTokens($value) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Sets the maximum word length
* @link https://php.net/manual/en/solrquery.setmltmaxwordlength.php
* @param int $maxWordLength <p>
* The maximum word length above which words will be ignored
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setMltMaxWordLength($maxWordLength) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Sets the mltMinDoc frequency
* @link https://php.net/manual/en/solrquery.setmltmindocfrequency.php
* @param int $minDocFrequency <p>
* Sets the frequency at which words will be ignored which do not occur in at least this many docs.
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setMltMinDocFrequency($minDocFrequency) {}
/**
* (PECL solr >= 0.9.2)<br/>
* 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 <p>
* The frequency below which terms will be ignored in the source docs
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setMltMinTermFrequency($minTermFrequency) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Sets the minimum word length
* @link https://php.net/manual/en/solrquery.setmltminwordlength.php
* @param int $minWordLength <p>
* The minimum word length below which words will be ignored
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setMltMinWordLength($minWordLength) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Exclude the header from the returned results
* @link https://php.net/manual/en/solrquery.setomitheader.php
* @param bool $flag <p>
* <b>TRUE</b> excludes the header from the result.
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setOmitHeader($flag) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Sets the search query
* @link https://php.net/manual/en/solrquery.setquery.php
* @param string $query <p>
* The search query
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setQuery($query) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Specifies the maximum number of rows to return in the result
* @link https://php.net/manual/en/solrquery.setrows.php
* @param int $rows <p>
* The maximum number of rows to return
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setRows($rows) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Flag to show debug information
* @link https://php.net/manual/en/solrquery.setshowdebuginfo.php
* @param bool $flag <p>
* Whether to show debug info. <b>TRUE</b> or <b>FALSE</b>
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setShowDebugInfo($flag) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Specifies the number of rows to skip
* @link https://php.net/manual/en/solrquery.setstart.php
* @param int $start <p>
* The number of rows to skip.
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setStart($start) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Enables or disables the Stats component
* @link https://php.net/manual/en/solrquery.setstats.php
* @param bool $flag <p>
* <b>TRUE</b> turns on the stats component and <b>FALSE</b> disables it.
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setStats($flag) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Enables or disables the TermsComponent
* @link https://php.net/manual/en/solrquery.setterms.php
* @param bool $flag <p>
* <b>TRUE</b> enables it. <b>FALSE</b> turns it off
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setTerms($flag) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Sets the name of the field to get the Terms from
* @link https://php.net/manual/en/solrquery.settermsfield.php
* @param string $fieldname <p>
* The field name
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setTermsField($fieldname) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Include the lower bound term in the result set
* @link https://php.net/manual/en/solrquery.settermsincludelowerbound.php
* @param bool $flag <p>
* Include the lower bound term in the result set
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setTermsIncludeLowerBound($flag) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Include the upper bound term in the result set
* @link https://php.net/manual/en/solrquery.settermsincludeupperbound.php
* @param bool $flag <p>
* <b>TRUE</b> or <b>FALSE</b>
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setTermsIncludeUpperBound($flag) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Sets the maximum number of terms to return
* @link https://php.net/manual/en/solrquery.settermslimit.php
* @param int $limit <p>
* The maximum number of terms to return. All the terms will be returned if the limit is negative.
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setTermsLimit($limit) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Specifies the Term to start from
* @link https://php.net/manual/en/solrquery.settermslowerbound.php
* @param string $lowerBound <p>
* The lower bound Term
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setTermsLowerBound($lowerBound) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Sets the maximum document frequency
* @link https://php.net/manual/en/solrquery.settermsmaxcount.php
* @param int $frequency <p>
* The maximum document frequency.
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setTermsMaxCount($frequency) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Sets the minimum document frequency
* @link https://php.net/manual/en/solrquery.settermsmincount.php
* @param int $frequency <p>
* The minimum frequency
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setTermsMinCount($frequency) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Restrict matches to terms that start with the prefix
* @link https://php.net/manual/en/solrquery.settermsprefix.php
* @param string $prefix <p>
* Restrict matches to terms that start with the prefix
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setTermsPrefix($prefix) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Return the raw characters of the indexed term
* @link https://php.net/manual/en/solrquery.settermsreturnraw.php
* @param bool $flag <p>
* <b>TRUE</b> or <b>FALSE</b>
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setTermsReturnRaw($flag) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Specifies how to sort the returned terms
* @link https://php.net/manual/en/solrquery.settermssort.php
* @param int $sortType <p>
* If SolrQuery::TERMS_SORT_COUNT, sorts the terms by the term frequency (highest count first).<br/>
* If SolrQuery::TERMS_SORT_INDEX, returns the terms in index order
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setTermsSort($sortType) {}
/**
* (PECL solr >= 0.9.2)<br/>
* Sets the term to stop at
* @link https://php.net/manual/en/solrquery.settermsupperbound.php
* @param string $upperBound <p>
* The term to stop at
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setTermsUpperBound($upperBound) {}
/**
* (PECL solr >= 0.9.2)<br/>
* The time allowed for search to finish
* @link https://php.net/manual/en/solrquery.settimeallowed.php
* @param int $timeAllowed <p>
* 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.
* </p>
* @return SolrQuery <p>
* Returns the current SolrQuery object, if the return value is used.
* </p>
*/
public function setTimeAllowed($timeAllowed) {}
}
Mini Shell