PHP 8.6.0 Beta 1 is available for testing

The SolrQuery class

(PECL solr >= 0.9.2)

Introduction

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

Class synopsis

class SolrQuery extends SolrModifiableParams implements Serializable {
/* Constants */
const int ORDER_ASC = 0;
const int ORDER_DESC = 1;
/* Properties */
/* Methods */
public function __construct (string $q = ?)
public function addExpandFilterQuery (string $fq): SolrQuery
public function addExpandSortField (string $field, string $order = ?): SolrQuery
public function addFacetDateField (string $dateField): SolrQuery
public function addFacetDateOther (string $value, string $field_override = ?): SolrQuery
public function addFacetField (string $field): SolrQuery
public function addFacetQuery (string $facetQuery): SolrQuery
public function addField (string $field): SolrQuery
public function addFilterQuery (string $fq): SolrQuery
public function addGroupField (string $value): SolrQuery
public function addGroupFunction (string $value): SolrQuery
public function addGroupQuery (string $value): SolrQuery
public function addGroupSortField (string $field, int $order = ?): SolrQuery
public function addHighlightField (string $field): SolrQuery
public function addMltField (string $field): SolrQuery
public function addMltQueryField (string $field, float $boost): SolrQuery
public function addSortField (string $field, int $order = SolrQuery::ORDER_DESC): SolrQuery
public function addStatsFacet (string $field): SolrQuery
public function addStatsField (string $field): SolrQuery
public function collapse (SolrCollapseFunction $collapseFunction): SolrQuery
public function getExpand (): bool
public function getExpandFilterQueries (): array
public function getExpandQuery (): array
public function getExpandRows (): int
public function getExpandSortFields (): array
public function getFacet (): bool
public function getFacetDateEnd (string $field_override = ?): string
public function getFacetDateFields (): array
public function getFacetDateGap (string $field_override = ?): string
public function getFacetDateHardEnd (string $field_override = ?): string
public function getFacetDateOther (string $field_override = ?): array
public function getFacetDateStart (string $field_override = ?): string
public function getFacetFields (): array
public function getFacetLimit (string $field_override = ?): int
public function getFacetMethod (string $field_override = ?): string
public function getFacetMinCount (string $field_override = ?): int
public function getFacetMissing (string $field_override = ?): bool
public function getFacetOffset (string $field_override = ?): int
public function getFacetPrefix (string $field_override = ?): string
public function getFacetQueries (): array
public function getFacetSort (string $field_override = ?): int
public function getFields (): array
public function getFilterQueries (): array
public function getGroup (): bool
public function getGroupCachePercent (): int
public function getGroupFacet (): bool
public function getGroupFields (): array
public function getGroupFormat (): string
public function getGroupFunctions (): array
public function getGroupLimit (): int
public function getGroupMain (): bool
public function getGroupNGroups (): bool
public function getGroupOffset (): int
public function getGroupQueries (): array
public function getGroupSortFields (): array
public function getGroupTruncate (): bool
public function getHighlight (): bool
public function getHighlightAlternateField (string $field_override = ?): string
public function getHighlightFields (): array
public function getHighlightFormatter (string $field_override = ?): string
public function getHighlightFragmenter (string $field_override = ?): string
public function getHighlightFragsize (string $field_override = ?): int
public function getHighlightMaxAlternateFieldLength (string $field_override = ?): int
public function getHighlightMaxAnalyzedChars (): int
public function getHighlightMergeContiguous (string $field_override = ?): bool
public function getHighlightQuery (): string
public function getHighlightRegexPattern (): string
public function getHighlightRegexSlop (): float
public function getHighlightRequireFieldMatch (): bool
public function getHighlightSimplePost (string $field_override = ?): string
public function getHighlightSimplePre (string $field_override = ?): string
public function getHighlightSnippets (string $field_override = ?): int
public function getMlt (): bool
public function getMltBoost (): bool
public function getMltCount (): int
public function getMltFields (): array
public function getMltMaxNumQueryTerms (): int
public function getMltMaxNumTokens (): int
public function getMltMaxWordLength (): int
public function getMltMinDocFrequency (): int
public function getMltMinTermFrequency (): int
public function getMltMinWordLength (): int
public function getMltQueryFields (): array
public function getQuery (): string
public function getRows (): int
public function getSortFields (): array
public function getStart (): int
public function getStats (): bool
public function getStatsFacets (): array
public function getStatsFields (): array
public function getTerms (): bool
public function getTermsField (): string
public function getTermsIncludeLowerBound (): bool
public function getTermsIncludeUpperBound (): bool
public function getTermsLimit (): int
public function getTermsLowerBound (): string
public function getTermsMaxCount (): int
public function getTermsMinCount (): int
public function getTermsPrefix (): string
public function getTermsReturnRaw (): bool
public function getTermsSort (): int
public function getTermsUpperBound (): string
public function getTimeAllowed (): int
public function removeExpandFilterQuery (string $fq): SolrQuery
public function removeExpandSortField (string $field): SolrQuery
public function removeFacetDateField (string $field): SolrQuery
public function removeFacetDateOther (string $value, string $field_override = ?): SolrQuery
public function removeFacetField (string $field): SolrQuery
public function removeFacetQuery (string $value): SolrQuery
public function removeField (string $field): SolrQuery
public function removeFilterQuery (string $fq): SolrQuery
public function removeHighlightField (string $field): SolrQuery
public function removeMltField (string $field): SolrQuery
public function removeMltQueryField (string $queryField): SolrQuery
public function removeSortField (string $field): SolrQuery
public function removeStatsFacet (string $value): SolrQuery
public function removeStatsField (string $field): SolrQuery
public function setEchoHandler (bool $flag): SolrQuery
public function setEchoParams (string $type): SolrQuery
public function setExpand (bool $value): SolrQuery
public function setExpandQuery (string $q): SolrQuery
public function setExpandRows (int $value): SolrQuery
public function setExplainOther (string $query): SolrQuery
public function setFacet (bool $flag): SolrQuery
public function setFacetDateEnd (string $value, string $field_override = ?): SolrQuery
public function setFacetDateGap (string $value, string $field_override = ?): SolrQuery
public function setFacetDateHardEnd (bool $value, string $field_override = ?): SolrQuery
public function setFacetDateStart (string $value, string $field_override = ?): SolrQuery
public function setFacetEnumCacheMinDefaultFrequency (int $frequency, string $field_override = ?): SolrQuery
public function setFacetLimit (int $limit, string $field_override = ?): SolrQuery
public function setFacetMethod (string $method, string $field_override = ?): SolrQuery
public function setFacetMinCount (int $mincount, string $field_override = ?): SolrQuery
public function setFacetMissing (bool $flag, string $field_override = ?): SolrQuery
public function setFacetOffset (int $offset, string $field_override = ?): SolrQuery
public function setFacetPrefix (string $prefix, string $field_override = ?): SolrQuery
public function setFacetSort (int $facetSort, string $field_override = ?): SolrQuery
public function setGroup (bool $value): SolrQuery
public function setGroupCachePercent (int $percent): SolrQuery
public function setGroupFacet (bool $value): SolrQuery
public function setGroupFormat (string $value): SolrQuery
public function setGroupLimit (int $value): SolrQuery
public function setGroupMain (string $value): SolrQuery
public function setGroupNGroups (bool $value): SolrQuery
public function setGroupOffset (int $value): SolrQuery
public function setGroupTruncate (bool $value): SolrQuery
public function setHighlight (bool $flag): SolrQuery
public function setHighlightAlternateField (string $field, string $field_override = ?): SolrQuery
public function setHighlightFormatter (string $formatter, string $field_override = ?): SolrQuery
public function setHighlightFragmenter (string $fragmenter, string $field_override = ?): SolrQuery
public function setHighlightFragsize (int $size, string $field_override = ?): SolrQuery
public function setHighlightMaxAlternateFieldLength (int $fieldLength, string $field_override = ?): SolrQuery
public function setHighlightMaxAnalyzedChars (int $value): SolrQuery
public function setHighlightMergeContiguous (bool $flag, string $field_override = ?): SolrQuery
public function setHighlightQuery (string $q): SolrQuery
public function setHighlightRegexMaxAnalyzedChars (int $maxAnalyzedChars): SolrQuery
public function setHighlightRegexPattern (string $value): SolrQuery
public function setHighlightRegexSlop (float $factor): SolrQuery
public function setHighlightRequireFieldMatch (bool $flag): SolrQuery
public function setHighlightSimplePost (string $simplePost, string $field_override = ?): SolrQuery
public function setHighlightSimplePre (string $simplePre, string $field_override = ?): SolrQuery
public function setHighlightSnippets (int $value, string $field_override = ?): SolrQuery
public function setMlt (bool $flag): SolrQuery
public function setMltBoost (bool $flag): SolrQuery
public function setMltCount (int $count): SolrQuery
public function setMltMaxNumQueryTerms (int $value): SolrQuery
public function setMltMaxNumTokens (int $value): SolrQuery
public function setMltMaxWordLength (int $maxWordLength): SolrQuery
public function setMltMinDocFrequency (int $minDocFrequency): SolrQuery
public function setMltMinTermFrequency (int $minTermFrequency): SolrQuery
public function setMltMinWordLength (int $minWordLength): SolrQuery
public function setOmitHeader (bool $flag): SolrQuery
public function setQuery (string $query): SolrQuery
public function setRows (int $rows): SolrQuery
public function setShowDebugInfo (bool $flag): SolrQuery
public function setStart (int $start): SolrQuery
public function setStats (bool $flag): SolrQuery
public function setTerms (bool $flag): SolrQuery
public function setTermsField (string $fieldname): SolrQuery
public function setTermsIncludeLowerBound (bool $flag): SolrQuery
public function setTermsIncludeUpperBound (bool $flag): SolrQuery
public function setTermsLimit (int $limit): SolrQuery
public function setTermsLowerBound (string $lowerBound): SolrQuery
public function setTermsMaxCount (int $frequency): SolrQuery
public function setTermsMinCount (int $frequency): SolrQuery
public function setTermsPrefix (string $prefix): SolrQuery
public function setTermsReturnRaw (bool $flag): SolrQuery
public function setTermsSort (int $sortType): SolrQuery
public function setTermsUpperBound (string $upperBound): SolrQuery
public function setTimeAllowed (int $timeAllowed): SolrQuery
public function __destruct ()
/* Inherited methods */
}

Predefined Constants

SolrQuery::ORDER_ASC

Used to specify that the sorting should be in acending order

SolrQuery::ORDER_DESC

Used to specify that the sorting should be in descending order

SolrQuery::FACET_SORT_INDEX

Used to specify that the facet should sort by index

SolrQuery::FACET_SORT_COUNT

Used to specify that the facet should sort by count

SolrQuery::TERMS_SORT_INDEX

Used in the TermsComponent

SolrQuery::TERMS_SORT_COUNT

Used in the TermsComponent

Table of Contents

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug
+add a note

User Contributed Notes 1 note

up
5
andy at borkedcoder dot com
14 years ago
Note - if using morelikethis, and your query is on a numeric ID, then you will not be able to access the moreLikeThis object in the results...
when q=id:3493 searching with mlt, result is:
SolrObject Object
(
...
 [moreLikeThis] => SolrObject Object
 (
 [3493] => SolrObject Object
 (
 [numFound] => 6286
 [start] => 0
 [docs] => Array
 (
....etc
the numeric object name (3493 above) is impossible to access
not by $response->moreLikeThis->{3493} nor $response->moreLikeThis->{'3493'}, nothing...
only way is to convert the moreLikeThis object into an array with:
$response_array = (array) $response->moreLikeThis;
then iterate the array as the array key is known.
+add a note

AltStyle によって変換されたページ (->オリジナル) /