Search/Lucene/Search/Query/Empty.php

Show: PublicProtectedPrivateinherited
Table of Contents
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

methodpublic__toString() : string

Print a query

Returns
TypeDescription
string
methodprotected_highlightMatches(\Zend_Search_Lucene_Search_Highlighter_Interface $highlighter) : void

Query specific matches highlighting

Parameters
NameTypeDescription
$highlighter\Zend_Search_Lucene_Search_Highlighter_Interface

Highlighter object (also contains doc for highlighting)

methodpubliccreateWeight(\Zend_Search_Lucene_Interface $reader) : \Zend_Search_Lucene_Search_Weight

Constructs an appropriate Weight implementation for this query.

Parameters
NameTypeDescription
$reader\Zend_Search_Lucene_Interface
Returns
TypeDescription
\Zend_Search_Lucene_Search_Weight
methodpublicexecute(\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

Parameters
NameTypeDescription
$reader\Zend_Search_Lucene_Interface
$docsFilter\Zend_Search_Lucene_Index_DocsFilter | null
methodpublicgetQueryTerms() : array

Return query terms

Returns
TypeDescription
array
methodpublicmatchedDocs() : array

Get document ids likely matching the query

It's an array with document ids as keys (performance considerations)
Returns
TypeDescription
array
methodpublicoptimize(\Zend_Search_Lucene_Interface $index) : \Zend_Search_Lucene_Search_Query

Optimize query in the context of specified index

Parameters
NameTypeDescription
$index\Zend_Search_Lucene_Interface
Returns
TypeDescription
\Zend_Search_Lucene_Search_Query
methodpublicrewrite(\Zend_Search_Lucene_Interface $index) : \Zend_Search_Lucene_Search_Query

Re-write query into primitive queries in the context of specified index

Parameters
NameTypeDescription
$index\Zend_Search_Lucene_Interface
Returns
TypeDescription
\Zend_Search_Lucene_Search_Query
methodpublicscore(integer $docId, \Zend_Search_Lucene_Interface $reader) : float

Score specified document

Parameters
NameTypeDescription
$docIdinteger
$reader\Zend_Search_Lucene_Interface
Returns
TypeDescription
float
Documentation was generated by phpDocumentor 2.2.0 .