API Documentation

Zend/Search/Lucene/Search/Query.php

Show: inherited
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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Search_Lucene  
Subpackage
Search  
Version
$Id: Query.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Search_Lucene_Search_Query

Package: Zend\Search\Lucene\Search

Children
\Zend_Search_Lucene_Search_Query_Fuzzy
\Zend_Search_Lucene_Search_Query_Insignificant
\Zend_Search_Lucene_Search_Query_Empty
\Zend_Search_Lucene_Search_Query_Phrase
\Zend_Search_Lucene_Search_Query_Term
\Zend_Search_Lucene_Search_Query_Range
\Zend_Search_Lucene_Search_Query_Wildcard
\Zend_Search_Lucene_Search_Query_MultiTerm
\Zend_Search_Lucene_Search_Query_Boolean
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprivatefloat  $_boost= '1'

query boost factor

Default value1Details
Type
float
Propertyprivateinteger  $_currentColorIndex= '0'

Current highlight color

Default value0Details
Type
integer
Propertyprotected\Zend_Search_Lucene_Search_Weight  $_weight= 'null'

Query weight

Default valuenullDetails
Type
\Zend_Search_Lucene_Search_Weight

Methods

methodpublic__toString( ) : string
abstract

Print a query

Returns
Type Description
string
methodprotected_highlightMatches( \Zend_Search_Lucene_Search_Highlighter_Interface $highlighter ) : void
abstract

Query specific matches highlighting

Parameters
Name Type Description
$highlighter \Zend_Search_Lucene_Search_Highlighter_Interface

Highlighter object (also contains doc for highlighting)

methodprotected_initWeight( \Zend_Search_Lucene_Interface $reader ) : void

Constructs an initializes a Weight for a _top-level_query_.

Parameters
Name Type Description
$reader \Zend_Search_Lucene_Interface
methodpubliccreateWeight( \Zend_Search_Lucene_Interface $reader ) : \Zend_Search_Lucene_Search_Weight
abstract

Constructs an appropriate Weight implementation for this query.

Parameters
Name Type Description
$reader \Zend_Search_Lucene_Interface
Returns
Type Description
\Zend_Search_Lucene_Search_Weight
methodpublicexecute( \Zend_Search_Lucene_Interface $reader, \Zend_Search_Lucene_Index_DocsFilter|null $docsFilter = null ) : void
abstract

Execute query in context of index reader It also initializes necessary internal structures

Query specific implementation

Parameters
Name Type Description
$reader \Zend_Search_Lucene_Interface
$docsFilter \Zend_Search_Lucene_Index_DocsFilter|null
methodpublicgetBoost( ) : float

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.

Returns
Type Description
float
methodpublicgetQueryTerms( ) : array
abstract

Return query terms

Returns
Type Description
array
methodpublichighlightMatches( string $inputHTML, string $defaultEncoding = '', \Zend_Search_Lucene_Search_Highlighter_Interface|null $highlighter = null ) : string

Highlight matches in $inputHTML

Parameters
Name Type Description
$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
Type Description
string
methodpublichtmlFragmentHighlightMatches( string $inputHtmlFragment, string $encoding = 'UTF-8', \Zend_Search_Lucene_Search_Highlighter_Interface|null $highlighter = null ) : string

Highlight matches in $inputHtmlFragment and return it (without HTML header and body tag)

Parameters
Name Type Description
$inputHtmlFragment string
$encoding string

Input HTML string encoding

$highlighter \Zend_Search_Lucene_Search_Highlighter_Interface|null
Returns
Type Description
string
methodpublicmatchedDocs( ) : array
abstract

Get document ids likely matching the query

It's an array with document ids as keys (performance considerations)

Returns
Type Description
array
methodpublicoptimize( \Zend_Search_Lucene_Interface $index ) : \Zend_Search_Lucene_Search_Query
abstract

Optimize query in the context of specified index

Parameters
Name Type Description
$index \Zend_Search_Lucene_Interface
Returns
Type Description
\Zend_Search_Lucene_Search_Query
methodpublicreset( ) : void

Reset query, so it can be reused within other queries or with other indeces

methodpublicrewrite( \Zend_Search_Lucene_Interface $index ) : \Zend_Search_Lucene_Search_Query
abstract

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

Parameters
Name Type Description
$index \Zend_Search_Lucene_Interface
Returns
Type Description
\Zend_Search_Lucene_Search_Query
methodpublicscore( integer $docId, \Zend_Search_Lucene_Interface $reader ) : float
abstract

Score specified document

Parameters
Name Type Description
$docId integer
$reader \Zend_Search_Lucene_Interface
Returns
Type Description
float
methodpublicsetBoost( float $boost ) : void

Sets the boost for this query clause to $boost.

Parameters
Name Type Description
$boost float
Documentation was generated by DocBlox 0.15.1.