Search/Lucene/Search/Query/Empty.php
Show:
inherited
inherited
Classes
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.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Search_Lucene
- Subpackage
- Search
- Version
- $Id$
\Zend_Search_Lucene_Search_Query_Empty
Package: Zend_Search_Lucene\Search
- Parent(s)
- \Zend_Search_Lucene_Search_Query
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Methods
__toString() : stringPrint a query
Returns
| Type | Description |
|---|---|
| string |
_highlightMatches(\Zend_Search_Lucene_Search_Highlighter_Interface $highlighter) : voidQuery specific matches highlighting
Parameters
| 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_WeightConstructs an appropriate Weight implementation for this query.
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $reader | \Zend_Search_Lucene_Interface |
| Type | Description |
|---|---|
| \Zend_Search_Lucene_Search_Weight |
execute(\Zend_Search_Lucene_Interface $reader, \Zend_Search_Lucene_Index_DocsFilter | null $docsFilter = null) : voidExecute query in context of index reader It also initializes necessary internal structures
Parameters
| Name | Type | Description |
|---|---|---|
| $reader | \Zend_Search_Lucene_Interface | |
| $docsFilter | \Zend_Search_Lucene_Index_DocsFilter | null |
getQueryTerms() : arrayReturn query terms
Returns
| Type | Description |
|---|---|
| array |
matchedDocs() : arrayGet document ids likely matching the query
It's an array with document ids as keys (performance considerations)
Returns| Type | Description |
|---|---|
| array |
optimize(\Zend_Search_Lucene_Interface $index) : \Zend_Search_Lucene_Search_QueryOptimize query in the context of specified index
Parameters
Returns
| 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_QueryRe-write query into primitive queries in the context of specified index
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $index | \Zend_Search_Lucene_Interface |
| Type | Description |
|---|---|
| \Zend_Search_Lucene_Search_Query |
score(integer $docId, \Zend_Search_Lucene_Interface $reader) : floatScore specified document
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $docId | integer | |
| $reader | \Zend_Search_Lucene_Interface |
| Type | Description |
|---|---|
| float |