Search/Lucene/Search/Query/Boolean.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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Search_Lucene  
Subpackage
Search  
Version
$Id: Boolean.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Search_Lucene_Search_Query_Boolean
jump to top

Package: Zend\Search\Lucene\Search
Parent(s)
\Zend_Search_Lucene_Search_Query
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprivatefloat $_boost = 1
inherited
query boost factor
Inherited from: \Zend_Search_Lucene_Search_Query::$$_boost
Default value1Details
Type
float
Inherited_from
\Zend_Search_Lucene_Search_Query::$$_boost  
>VPropertyprivatemixed $_coord = null
A score factor based on the fraction of all query subqueries that a document contains.

float for conjunction queries array of float for non conjunction queries

Default valuenullDetails
Type
mixed
>VPropertyprivateinteger $_currentColorIndex = 0
inherited
Current highlight color
Inherited from: \Zend_Search_Lucene_Search_Query::$$_currentColorIndex
Default value0Details
Type
integer
Inherited_from
\Zend_Search_Lucene_Search_Query::$$_currentColorIndex  
>VPropertyprivatearray $_resVector = null
Result vector.
Default valuenullDetails
Type
array
>VPropertyprivatearray $_signs = array()
Subqueries signs.

If true then subquery is required. If false then subquery is prohibited. If null then subquery is neither prohibited, nor required

If array is null then all subqueries are required

Default valuearray()Details
Type
array
>VPropertyprivatearray $_subqueries = array()
Subqueries Array of Zend_Search_Lucene_Search_Query
Default valuearray()Details
Type
array
>VPropertyprotected\Zend_Search_Lucene_Search_Weight $_weight = null
inherited
Query weight
Inherited from: \Zend_Search_Lucene_Search_Query::$$_weight
Default valuenullDetails
Type
\Zend_Search_Lucene_Search_Weight
Inherited_from
\Zend_Search_Lucene_Search_Query::$$_weight  

Methods

methodpublic__construct(array $subqueries = null, array $signs = null) : void

Class constructor.

Create a new Boolean query object.

if $signs array is omitted then all subqueries are required it differs from addSubquery() behavior, but should never be used

Parameters
NameTypeDescription
$subqueriesarray

Array of Zend_Search_Search_Query objects

$signsarray

Array of signs. Sign is boolean|null.

methodpublic__toString() : string

Print a query

Returns
TypeDescription
string
methodprivate_calculateConjunctionResult() : void

Calculate result vector for Conjunction query (like ' AND AND ')

methodprivate_calculateNonConjunctionResult() : void

Calculate result vector for non Conjunction query (like ' AND AND NOT OR ')

methodpublic_conjunctionScore(integer $docId, \Zend_Search_Lucene_Interface $reader) : float

Score calculator for conjunction queries (all subqueries are required)

Parameters
NameTypeDescription
$docIdinteger
$reader\Zend_Search_Lucene_Interface
Returns
TypeDescription
float
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)

methodprotected_initWeight(\Zend_Search_Lucene_Interface $reader) : void
inherited

Constructs an initializes a Weight for a _top-level_query_.

Inherited from: \Zend_Search_Lucene_Search_Query::_initWeight()
Parameters
NameTypeDescription
$reader\Zend_Search_Lucene_Interface
methodpublic_nonConjunctionScore(integer $docId, \Zend_Search_Lucene_Interface $reader) : float

Score calculator for non conjunction queries (not all subqueries are required)

Parameters
NameTypeDescription
$docIdinteger
$reader\Zend_Search_Lucene_Interface
Returns
TypeDescription
float
methodpublicaddSubquery(\Zend_Search_Lucene_Search_Query $subquery, boolean | null $sign = null) : void

Add a $subquery (Zend_Search_Lucene_Search_Query) to this query.

The sign is specified as: TRUE - subquery is required FALSE - subquery is prohibited NULL - subquery is neither prohibited, nor required

Parameters
NameTypeDescription
$subquery\Zend_Search_Lucene_Search_Query
$signboolean | null
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

Query specific implementation

Parameters
NameTypeDescription
$reader\Zend_Search_Lucene_Interface
$docsFilter\Zend_Search_Lucene_Index_DocsFilter | null
methodpublicgetBoost() : float
inherited

Gets the boost for this clause.

Inherited from: \Zend_Search_Lucene_Search_Query::getBoost()

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
TypeDescription
float
methodpublicgetQueryTerms() : array

Return query terms

Returns
TypeDescription
array
methodpublicgetSigns() : array

Return subqueries signs

Returns
TypeDescription
array
methodpublicgetSubqueries() : array

Returns subqueries

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

Highlight matches in $inputHTML

Inherited from: \Zend_Search_Lucene_Search_Query::highlightMatches()
Parameters
NameTypeDescription
$inputHTMLstring
$defaultEncodingstring

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

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

Inherited from: \Zend_Search_Lucene_Search_Query::htmlFragmentHighlightMatches()
Parameters
NameTypeDescription
$inputHtmlFragmentstring
$encodingstring

Input HTML string encoding

$highlighter\Zend_Search_Lucene_Search_Highlighter_Interface | null
Returns
TypeDescription
string
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
methodpublicreset() : void
inherited

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

Inherited from: \Zend_Search_Lucene_Search_Query::reset()
methodpublicrewrite(\Zend_Search_Lucene_Interface $index) : \Zend_Search_Lucene_Search_Query

Re-write queries into primitive queries

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
methodpublicsetBoost(float $boost) : void
inherited

Sets the boost for this query clause to $boost.

Inherited from: \Zend_Search_Lucene_Search_Query::setBoost()
Parameters
NameTypeDescription
$boostfloat
Documentation was generated by phpDocumentor 2.0.0a12.