Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

array
$_matches= 'null'
Matched terms.
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
null
Details
__construct(
\Zend_Search_Lucene_Index_Term|null $lowerTerm, \Zend_Search_Lucene_Index_Term|null $upperTerm, boolean $inclusive
)
:
void
Zend_Search_Lucene_Search_Query_Range constructor.
Name | Type | Description |
---|---|---|
$lowerTerm | \Zend_Search_Lucene_Index_Term|null | |
$upperTerm | \Zend_Search_Lucene_Index_Term|null | |
$inclusive | boolean |
Exception | Description |
---|---|
\Zend_Search_Lucene_Exception |

_highlightMatches(
\Zend_Search_Lucene_Search_Highlighter_Interface $highlighter
)
:
void
Query specific matches highlighting
Name | Type | Description |
---|---|---|
$highlighter | \Zend_Search_Lucene_Search_Highlighter_Interface | Highlighter object (also contains doc for highlighting) |

createWeight(
\Zend_Search_Lucene_Interface $reader
)
:
\Zend_Search_Lucene_Search_Weight
Constructs an appropriate Weight implementation for this query.
Name | Type | Description |
---|---|---|
$reader | \Zend_Search_Lucene_Interface |
Type | Description |
---|---|
\Zend_Search_Lucene_Search_Weight |
Exception | Description |
---|---|
\Zend_Search_Lucene_Exception |

execute(
\Zend_Search_Lucene_Interface $reader, \Zend_Search_Lucene_Index_DocsFilter|null $docsFilter
=
null
)
:
void
Execute query in context of index reader It also initializes necessary internal structures
Name | Type | Description |
---|---|---|
$reader | \Zend_Search_Lucene_Interface | |
$docsFilter | \Zend_Search_Lucene_Index_DocsFilter|null |
Exception | Description |
---|---|
\Zend_Search_Lucene_Exception |

getLowerTerm(
)
:
\Zend_Search_Lucene_Index_Term|null
Get lower term
Type | Description |
---|---|
\Zend_Search_Lucene_Index_Term|null |

getUpperTerm(
)
:
\Zend_Search_Lucene_Index_Term|null
Get upper term
Type | Description |
---|---|
\Zend_Search_Lucene_Index_Term|null |

matchedDocs(
)
:
array
Get document ids likely matching the query
It's an array with document ids as keys (performance considerations)
Type | Description |
---|---|
array |
Exception | Description |
---|---|
\Zend_Search_Lucene_Exception |

optimize(
\Zend_Search_Lucene_Interface $index
)
:
\Zend_Search_Lucene_Search_Query
Optimize query in the context of specified index
Name | Type | Description |
---|---|---|
$index | \Zend_Search_Lucene_Interface |
Type | Description |
---|---|
\Zend_Search_Lucene_Search_Query |

rewrite(
\Zend_Search_Lucene_Interface $index
)
:
\Zend_Search_Lucene_Search_Query
Re-write query into primitive queries in the context of specified index
Name | Type | Description |
---|---|---|
$index | \Zend_Search_Lucene_Interface |
Type | Description |
---|---|
\Zend_Search_Lucene_Search_Query |

score(
integer $docId, \Zend_Search_Lucene_Interface $reader
)
:
float
Score specified document
Name | Type | Description |
---|---|---|
$docId | integer | |
$reader | \Zend_Search_Lucene_Interface |
Type | Description |
---|---|
float |
Exception | Description |
---|---|
\Zend_Search_Lucene_Exception |