A Query that matches documents containing a particular sequence of terms.
category | Zend |
---|---|
package | Zend_Search_Lucene |
subpackage | Search |
copyright | Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) |
license | New BSD License |
inherited_from | \Zend_Search_Lucene_Search_Query |
__construct(array $terms= null
, array $offsets= null
, string $field= null
)
array
Terms to search Array of strings.
array
Relative term positions. Array of integers.
string
Field to search.
\Zend_Search_Lucene_Exception |
---|
__toString() : string
inherited_from | \Zend_Search_Lucene_Search_Query::__toString() |
---|
string
__toString() : string
string
_exactPhraseFreq(integer $docId) : float
integer
float
_sloppyPhraseFreq(integer $docId, \Zend_Search_Lucene_Interface $reader) : float
integer
\Zend_Search_Lucene_Interface
float
addTerm(\Zend_Search_Lucene_Index_Term $term, integer $position = null
)
The relative position of the term is specified explicitly or the one immediately after the last term added.
\Zend_Search_Lucene_Index_Term
integer
createWeight(\Zend_Search_Lucene_Interface $reader) : \Zend_Search_Lucene_Search_Weight
inherited_from | \Zend_Search_Lucene_Search_Query::createWeight() |
---|
\Zend_Search_Lucene_Interface
\Zend_Search_Lucene_Search_Weight
createWeight(\Zend_Search_Lucene_Interface $reader) : \Zend_Search_Lucene_Search_Weight
\Zend_Search_Lucene_Interface
\Zend_Search_Lucene_Search_Weight
execute(\Zend_Search_Lucene_Interface $reader, \Zend_Search_Lucene_Index_DocsFilter|null $docsFilter = null
)
Query specific implementation
inherited_from | \Zend_Search_Lucene_Search_Query::execute() |
---|
\Zend_Search_Lucene_Interface
\Zend_Search_Lucene_Index_DocsFilter
null
execute(\Zend_Search_Lucene_Interface $reader, \Zend_Search_Lucene_Index_DocsFilter|null $docsFilter = null
)
Query specific implementation
\Zend_Search_Lucene_Interface
\Zend_Search_Lucene_Index_DocsFilter
null
getBoost() : float
float
getQueryTerms() : array
inherited_from | \Zend_Search_Lucene_Search_Query::getQueryTerms() |
---|
array
getQueryTerms() : array
array
getSlop() : integer
integer
getTerms() : array
array
highlightMatches(string $inputHTML, string $defaultEncoding = ''
, \Zend_Search_Lucene_Search_Highlighter_Interface|null $highlighter = null
) : string
string
string
HTML encoding, is used if it's not specified using Content-type HTTP-EQUIV meta tag.
\Zend_Search_Lucene_Search_Highlighter_Interface
null
string
htmlFragmentHighlightMatches(string $inputHtmlFragment, string $encoding= 'UTF-8'
, \Zend_Search_Lucene_Search_Highlighter_Interface|null $highlighter= null
) : string
string
string
Input HTML string encoding
\Zend_Search_Lucene_Search_Highlighter_Interface
null
string
matchedDocs() : array
It's an array with document ids as keys (performance considerations)
inherited_from | \Zend_Search_Lucene_Search_Query::matchedDocs() |
---|
array
matchedDocs() : array
It's an array with document ids as keys (performance considerations)
array
optimize(\Zend_Search_Lucene_Interface $index) : \Zend_Search_Lucene_Search_Query
inherited_from | \Zend_Search_Lucene_Search_Query::optimize() |
---|
\Zend_Search_Lucene_Interface
\Zend_Search_Lucene_Search_Query
optimize(\Zend_Search_Lucene_Interface $index) : \Zend_Search_Lucene_Search_Query
\Zend_Search_Lucene_Interface
\Zend_Search_Lucene_Search_Query
reset()
rewrite(\Zend_Search_Lucene_Interface $index) : \Zend_Search_Lucene_Search_Query
inherited_from | \Zend_Search_Lucene_Search_Query::rewrite() |
---|
\Zend_Search_Lucene_Interface
\Zend_Search_Lucene_Search_Query
rewrite(\Zend_Search_Lucene_Interface $index) : \Zend_Search_Lucene_Search_Query
\Zend_Search_Lucene_Interface
\Zend_Search_Lucene_Search_Query
score(integer $docId, \Zend_Search_Lucene_Interface $reader) : float
inherited_from | \Zend_Search_Lucene_Search_Query::score() |
---|
integer
\Zend_Search_Lucene_Interface
float
score(integer $docId, \Zend_Search_Lucene_Interface $reader) : float
integer
\Zend_Search_Lucene_Interface
float
setBoost(float $boost)
float
setSlop(integer $slop)
integer
setWeight(integer $num, \Zend_Search_Lucene_Search_Weight_Term $weight)
integer
\Zend_Search_Lucene_Search_Weight_Term
_highlightMatches(\Zend_Search_Lucene_Search_Highlighter_Interface $highlighter)
inherited_from | \Zend_Search_Lucene_Search_Query::_highlightMatches() |
---|
\Zend_Search_Lucene_Search_Highlighter_Interface
Highlighter object (also contains doc for highlighting)
_highlightMatches(\Zend_Search_Lucene_Search_Highlighter_Interface $highlighter)
\Zend_Search_Lucene_Search_Highlighter_Interface
Highlighter object (also contains doc for highlighting)
_initWeight(\Zend_Search_Lucene_Interface $reader)
\Zend_Search_Lucene_Interface
$_weight : \Zend_Search_Lucene_Search_Weight
null
$_boost : float
1
$_currentColorIndex : integer
0
$_offsets : array
Array of integers
$_resVector : array
null
$_slop : integer
If zero, then this is an exact phrase search. For larger values this works like a WITHIN or NEAR operator.
The slop is in fact an edit-distance, where the units correspond to moves of terms in the query phrase out of position. For example, to switch the order of two words requires two moves (the first move places the words atop one another), so to permit re-orderings of phrases, the slop must be at least two. More exact matches are scored higher than sloppier matches, thus search results are sorted by exactness.
The slop is zero by default, requiring exact matches.
$_terms : array
Array of Zend_Search_Lucene_Index_Term objects.
$_termsPositions : array
array()
Array of Arrays: term1Id => (docId => array( pos1, pos2, ... ), ...) term2Id => (docId => array( pos1, pos2, ... ), ...)