AbstractQuery
in package
Tags
Table of Contents
Properties
- $_weight : AbstractWeight
- AbstractQuery weight
- $_boost : float
- query boost factor
Methods
- __toString() : string
- Print a query
- createWeight() : AbstractWeight
- Constructs an appropriate Weight implementation for this query.
- execute() : mixed
- Execute query in context of index reader It also initializes necessary internal structures
- getBoost() : float
- Gets the boost for this clause. Documents matching this clause will (in addition to the normal weightings) have their score multiplied by boost. The boost is 1.0 by default.
- getQueryTerms() : array<string|int, mixed>
- Return query terms
- highlightMatches() : string
- Highlight matches in $inputHTML
- htmlFragmentHighlightMatches() : string
- Highlight matches in $inputHTMLFragment and return it (without HTML header and body tag)
- matchedDocs() : array<string|int, mixed>
- Get document ids likely matching the query
- optimize() : AbstractQuery
- Optimize query in the context of specified index
- reset() : void
- Reset query, so it can be reused within other queries or with other indeces
- rewrite() : AbstractQuery
- Re-write query into primitive queries in the context of specified index
- score() : float
- Score specified document
- setBoost() : void
- Sets the boost for this query clause to $boost.
- _highlightMatches() : mixed
- AbstractQuery specific matches highlighting
- _initWeight() : AbstractWeight|null
- Constructs an initializes a Weight for a _top-level_query_.
Properties
$_weight
AbstractQuery weight
protected
AbstractWeight
$_weight
= null
$_boost
query boost factor
private
float
$_boost
= 1
Methods
__toString()
Print a query
public
abstract __toString() : string
Return values
stringcreateWeight()
Constructs an appropriate Weight implementation for this query.
public
abstract createWeight(SearchIndexInterface $reader) : AbstractWeight
Parameters
- $reader : SearchIndexInterface
Return values
AbstractWeightexecute()
Execute query in context of index reader It also initializes necessary internal structures
public
abstract execute(SearchIndexInterface $reader[, DocsFilter|null $docsFilter = null ]) : mixed
AbstractQuery specific implementation
Parameters
- $reader : SearchIndexInterface
- $docsFilter : DocsFilter|null = null
getBoost()
Gets the boost for this clause. Documents matching this clause will (in addition to the normal weightings) have their score multiplied by boost. The boost is 1.0 by default.
public
getBoost() : float
Return values
floatgetQueryTerms()
Return query terms
public
abstract getQueryTerms() : array<string|int, mixed>
Return values
array<string|int, mixed>highlightMatches()
Highlight matches in $inputHTML
public
highlightMatches(string $inputHTML[, string $defaultEncoding = '' ][, HighlighterInterface|null $highlighter = null ]) : string
Parameters
- $inputHTML : string
- $defaultEncoding : string = ''
-
HTML encoding, is used if it's not specified using Content-type HTTP-EQUIV meta tag.
- $highlighter : HighlighterInterface|null = null
Return values
stringhtmlFragmentHighlightMatches()
Highlight matches in $inputHTMLFragment and return it (without HTML header and body tag)
public
htmlFragmentHighlightMatches(string $inputHTMLFragment[, string $encoding = 'UTF-8' ][, HighlighterInterface|null $highlighter = null ]) : string
Parameters
- $inputHTMLFragment : string
- $encoding : string = 'UTF-8'
-
Input HTML string encoding
- $highlighter : HighlighterInterface|null = null
Return values
stringmatchedDocs()
Get document ids likely matching the query
public
abstract matchedDocs() : array<string|int, mixed>
It's an array with document ids as keys (performance considerations)
Return values
array<string|int, mixed>optimize()
Optimize query in the context of specified index
public
abstract optimize(SearchIndexInterface $index) : AbstractQuery
Parameters
- $index : SearchIndexInterface
Return values
AbstractQueryreset()
Reset query, so it can be reused within other queries or with other indeces
public
reset() : void
rewrite()
Re-write query into primitive queries in the context of specified index
public
abstract rewrite(SearchIndexInterface $index) : AbstractQuery
Parameters
- $index : SearchIndexInterface
Return values
AbstractQueryscore()
Score specified document
public
abstract score(int $docId, SearchIndexInterface $reader) : float
Parameters
- $docId : int
- $reader : SearchIndexInterface
Return values
floatsetBoost()
Sets the boost for this query clause to $boost.
public
setBoost(float $boost) : void
Parameters
- $boost : float
_highlightMatches()
AbstractQuery specific matches highlighting
protected
abstract _highlightMatches(HighlighterInterface $highlighter) : mixed
Parameters
- $highlighter : HighlighterInterface
-
Highlighter object (also contains doc for highlighting)
_initWeight()
Constructs an initializes a Weight for a _top-level_query_.
protected
_initWeight(SearchIndexInterface $reader) : AbstractWeight|null
Parameters
- $reader : SearchIndexInterface