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 |
Methods
Zend_Search_Lucene_Search_Query_Range constructor.
__construct(\Zend_Search_Lucene_Index_Term|null $lowerTerm, \Zend_Search_Lucene_Index_Term|null $upperTerm, boolean $inclusive)
Parameters
$lowerTerm
\Zend_Search_Lucene_Index_Term
null
$upperTerm
\Zend_Search_Lucene_Index_Term
null
$inclusive
boolean
Exceptions
\Zend_Search_Lucene_Exception |
|
Print a query
__toString() : string
inherited_from |
\Zend_Search_Lucene_Search_Query::__toString() |
Returns
string
Print a query
__toString() : string
Inherited
Constructs an appropriate Weight implementation for this query.
createWeight(\Zend_Search_Lucene_Interface $reader) : \Zend_Search_Lucene_Search_Weight
inherited_from |
\Zend_Search_Lucene_Search_Query::createWeight() |
Parameters
$reader
\Zend_Search_Lucene_Interface
Exceptions
\Zend_Search_Lucene_Exception |
|
Returns
\Zend_Search_Lucene_Search_Weight
Constructs an appropriate Weight implementation for this query.
createWeight(\Zend_Search_Lucene_Interface $reader) : \Zend_Search_Lucene_Search_Weight
Inherited
Parameters
$reader
\Zend_Search_Lucene_Interface
Returns
\Zend_Search_Lucene_Search_Weight
Execute query in context of index reader
It also initializes necessary internal structures
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() |
Parameters
$reader
\Zend_Search_Lucene_Interface
$docsFilter
\Zend_Search_Lucene_Index_DocsFilter
null
Exceptions
\Zend_Search_Lucene_Exception |
|
Execute query in context of index reader
It also initializes necessary internal structures
execute(\Zend_Search_Lucene_Interface $reader, \Zend_Search_Lucene_Index_DocsFilter|null $docsFilter = null
)
Inherited
Query specific implementation
Parameters
$reader
\Zend_Search_Lucene_Interface
$docsFilter
\Zend_Search_Lucene_Index_DocsFilter
null
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.
getBoost() : float
Inherited
Get query field name
getField() : string | null
Get lower term
getLowerTerm() : \Zend_Search_Lucene_Index_Term | null
Returns
\Zend_Search_Lucene_Index_Term
null
Return query terms
getQueryTerms() : array
inherited_from |
\Zend_Search_Lucene_Search_Query::getQueryTerms() |
Exceptions
\Zend_Search_Lucene_Exception |
|
Returns
array
Return query terms
getQueryTerms() : array
Inherited
Get upper term
getUpperTerm() : \Zend_Search_Lucene_Index_Term | null
Returns
\Zend_Search_Lucene_Index_Term
null
Highlight matches in $inputHTML
highlightMatches(string $inputHTML, string $defaultEncoding = ''
, \Zend_Search_Lucene_Search_Highlighter_Interface|null $highlighter = null
) : string
Inherited
Parameters
$inputHTML
string
$defaultEncoding
string
HTML encoding, is used if it's not specified using Content-type HTTP-EQUIV meta tag.
$highlighter
\Zend_Search_Lucene_Search_Highlighter_Interface
null
Returns
string
Highlight matches in $inputHtmlFragment and return it (without HTML header and body tag)
htmlFragmentHighlightMatches(string $inputHtmlFragment, string $encoding = 'UTF-8'
, \Zend_Search_Lucene_Search_Highlighter_Interface|null $highlighter = null
) : string
Inherited
Parameters
$inputHtmlFragment
string
$encoding
string
Input HTML string encoding
$highlighter
\Zend_Search_Lucene_Search_Highlighter_Interface
null
Returns
string
Get upper term
isInclusive() : boolean
Get document ids likely matching the query
matchedDocs() : array
It's an array with document ids as keys (performance considerations)
inherited_from |
\Zend_Search_Lucene_Search_Query::matchedDocs() |
Exceptions
\Zend_Search_Lucene_Exception |
|
Returns
array
Get document ids likely matching the query
matchedDocs() : array
Inherited
It's an array with document ids as keys (performance considerations)
Returns
array
Optimize query in the context of specified index
optimize(\Zend_Search_Lucene_Interface $index) : \Zend_Search_Lucene_Search_Query
inherited_from |
\Zend_Search_Lucene_Search_Query::optimize() |
Parameters
$index
\Zend_Search_Lucene_Interface
Returns
\Zend_Search_Lucene_Search_Query
Optimize query in the context of specified index
optimize(\Zend_Search_Lucene_Interface $index) : \Zend_Search_Lucene_Search_Query
Inherited
Parameters
$index
\Zend_Search_Lucene_Interface
Returns
\Zend_Search_Lucene_Search_Query
Reset query, so it can be reused within other queries or
with other indeces
reset()
Inherited
Re-write query into primitive queries in the context of specified index
rewrite(\Zend_Search_Lucene_Interface $index) : \Zend_Search_Lucene_Search_Query
inherited_from |
\Zend_Search_Lucene_Search_Query::rewrite() |
Parameters
$index
\Zend_Search_Lucene_Interface
Returns
\Zend_Search_Lucene_Search_Query
Re-write query into primitive queries in the context of specified index
rewrite(\Zend_Search_Lucene_Interface $index) : \Zend_Search_Lucene_Search_Query
Inherited
Parameters
$index
\Zend_Search_Lucene_Interface
Returns
\Zend_Search_Lucene_Search_Query
Score specified document
score(integer $docId, \Zend_Search_Lucene_Interface $reader) : float
inherited_from |
\Zend_Search_Lucene_Search_Query::score() |
Parameters
$docId
integer
$reader
\Zend_Search_Lucene_Interface
Exceptions
\Zend_Search_Lucene_Exception |
|
Returns
float
Score specified document
score(integer $docId, \Zend_Search_Lucene_Interface $reader) : float
Inherited
Parameters
$docId
integer
$reader
\Zend_Search_Lucene_Interface
Returns
float
Sets the boost for this query clause to $boost.
setBoost(float $boost)
Inherited
Query specific matches highlighting
_highlightMatches(\Zend_Search_Lucene_Search_Highlighter_Interface $highlighter)
inherited_from |
\Zend_Search_Lucene_Search_Query::_highlightMatches() |
Parameters
$highlighter
\Zend_Search_Lucene_Search_Highlighter_Interface
Highlighter object (also contains doc for highlighting)
Query specific matches highlighting
_highlightMatches(\Zend_Search_Lucene_Search_Highlighter_Interface $highlighter)
Inherited
Parameters
$highlighter
\Zend_Search_Lucene_Search_Highlighter_Interface
Highlighter object (also contains doc for highlighting)
Constructs an initializes a Weight for a _top-level_query_.
_initWeight(\Zend_Search_Lucene_Interface $reader)
Inherited
Parameters
$reader
\Zend_Search_Lucene_Interface
Properties
Query weight
$_weight : \Zend_Search_Lucene_Search_Weight
query boost factor
$_boost : float
Current highlight color
$_currentColorIndex : integer
Search field
$_field : string
Inclusive
$_inclusive : boolean
Lower term.
$_lowerTerm : \Zend_Search_Lucene_Index_Term
Matched terms.
$_matches : array
Matched terms list.
It's filled during the search (rewrite operation) and may be used for search result
post-processing
Array of Zend_Search_Lucene_Index_Term objects
Upper term.
$_upperTerm : \Zend_Search_Lucene_Index_Term