Search/Lucene/Search/Query.php
- category
- Zend
- copyright
- Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- license
- http://framework.zend.com/license/new-bsd New BSD License
- package
- Zend_Search_Lucene
- subpackage
- Search
- version
- $Id: Query.php 20096 2010-01-06 02:05:09Z bkarwin $
- Classes
- Zend_Search_Lucene_Search_Query
Description
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.
Zend_Search_Lucene_Search_Query
- category
- Zend
- copyright
- Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- license
- http://framework.zend.com/license/new-bsd New BSD License
- package
- Zend_Search_Lucene
- subpackage
- Search
- Properties
- $_boost
- $_weight
- $_currentColorIndex
- Methods
- getBoost
- setBoost
- score
- matchedDocs
- execute
- createWeight
- _initWeight
- rewrite
- optimize
- reset
- __toString
- getQueryTerms
- _highlightMatches
- highlightMatches
- htmlFragmentHighlightMatches
Description
Properties
$_boost
float $_boost = '1'query boost factor
Details
- $_boost
- float
- visibility
- private
- default
- 1
- final
- false
- static
- false
$_currentColorIndex
integer $_currentColorIndex = '0'Current highlight color
Details
- $_currentColorIndex
- integer
- visibility
- private
- default
- 0
- final
- false
- static
- false
$_weight
Zend_Search_Lucene_Search_Weight $_weight = 'null'Query weight
Details
- $_weight
-
Zend_Search_Lucene_Search_Weight
- visibility
- protected
- default
- null
- final
- false
- static
- false
Methods
__toString
__toString(
)
:
stringPrint a query
Output
- string
Details
- visibility
- public
- final
- false
- static
- false
_highlightMatches
_highlightMatches(
Zend_Search_Lucene_Search_Highlighter_Interface $highlighter
)
:
Query specific matches highlighting
Arguments
- $highlighter
- Zend_Search_Lucene_Search_Highlighter_Interface
Highlighter object (also contains doc for highlighting)
Details
- visibility
- protected
- final
- false
- static
- false
_initWeight
_initWeight(
Zend_Search_Lucene_Interface $reader
)
:
Constructs an initializes a Weight for a _top-level_query_.
Arguments
- $reader
- Zend_Search_Lucene_Interface
Details
- visibility
- protected
- final
- false
- static
- false
createWeight
createWeight(
Zend_Search_Lucene_Interface $reader
)
:
Zend_Search_Lucene_Search_WeightConstructs an appropriate Weight implementation for this query.
Arguments
- $reader
- Zend_Search_Lucene_Interface
Details
- visibility
- public
- final
- false
- static
- false
execute
execute(
Zend_Search_Lucene_Interface $reader, Zend_Search_Lucene_Index_DocsFilter|null $docsFilter
=
null
)
:
Execute query in context of index reader It also initializes necessary internal structures
Query specific implementation
Arguments
- $reader
- Zend_Search_Lucene_Interface
- $docsFilter
- Zend_Search_Lucene_Index_DocsFilternull
Details
- visibility
- public
- final
- false
- static
- false
getBoost
getBoost(
)
:
floatGets 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.
Output
- float
Details
- visibility
- public
- final
- false
- static
- false
getQueryTerms
getQueryTerms(
)
:
arrayReturn query terms
Output
- array
Details
- visibility
- public
- final
- false
- static
- false
highlightMatches
highlightMatches(
string $inputHTML, string $defaultEncoding, Zend_Search_Lucene_Search_Highlighter_Interface|null $highlighter
=
null
)
:
stringHighlight matches in $inputHTML
Arguments
- $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_Interfacenull
Output
- string
Details
- visibility
- public
- final
- false
- static
- false
htmlFragmentHighlightMatches
htmlFragmentHighlightMatches(
string $inputHtmlFragment, string $encoding
=
UTF-8, Zend_Search_Lucene_Search_Highlighter_Interface|null $highlighter
=
null
)
:
stringHighlight matches in $inputHtmlFragment and return it (without HTML header and body tag)
Arguments
- $inputHtmlFragment
- string
- $encoding
- string
Input HTML string encoding - $highlighter
- Zend_Search_Lucene_Search_Highlighter_Interfacenull
Output
- string
Details
- visibility
- public
- final
- false
- static
- false
matchedDocs
matchedDocs(
)
:
arrayGet document ids likely matching the query
It's an array with document ids as keys (performance considerations)
Output
- array
Details
- visibility
- public
- final
- false
- static
- false
optimize
optimize(
Zend_Search_Lucene_Interface $index
)
:
Zend_Search_Lucene_Search_QueryOptimize query in the context of specified index
Arguments
- $index
- Zend_Search_Lucene_Interface
Details
- visibility
- public
- final
- false
- static
- false
reset
reset(
)
:
Reset query, so it can be reused within other queries or with other indeces
Details
- visibility
- public
- final
- false
- static
- false
rewrite
rewrite(
Zend_Search_Lucene_Interface $index
)
:
Zend_Search_Lucene_Search_QueryRe-write query into primitive queries in the context of specified index
Arguments
- $index
- Zend_Search_Lucene_Interface
Details
- visibility
- public
- final
- false
- static
- false
score
score(
integer $docId, Zend_Search_Lucene_Interface $reader
)
:
floatScore specified document
Arguments
- $docId
- integer
- $reader
- Zend_Search_Lucene_Interface
Output
- float
Details
- visibility
- public
- final
- false
- static
- false
setBoost
setBoost(
float $boost
)
:
Sets the boost for this query clause to $boost.
Arguments
- $boost
- float
Details
- visibility
- public
- final
- false
- static
- false