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.

mixed
$_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
null
Details
array
$_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
array()
Details
__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
Name | Type | Description |
---|---|---|
$subqueries | array | Array of Zend_Search_Search_Query objects |
$signs | array | Array of signs. Sign is boolean|null. |

_calculateConjunctionResult(
)
:
void
Calculate result vector for Conjunction query
(like '

_calculateNonConjunctionResult(
)
:
void
Calculate result vector for non Conjunction query
(like '

_conjunctionScore(
integer $docId, \Zend_Search_Lucene_Interface $reader
)
:
float
Score calculator for conjunction queries (all subqueries are required)
Name | Type | Description |
---|---|---|
$docId | integer | |
$reader | \Zend_Search_Lucene_Interface |
Type | Description |
---|---|
float |

_highlightMatches(
\Zend_Search_Lucene_Search_Highlighter_Interface $highlighter
)
:
void
Query specific matches highlighting
Name | Type | Description |
---|---|---|
$highlighter | \Zend_Search_Lucene_Search_Highlighter_Interface | Highlighter object (also contains doc for highlighting) |

_nonConjunctionScore(
integer $docId, \Zend_Search_Lucene_Interface $reader
)
:
float
Score calculator for non conjunction queries (not all subqueries are required)
Name | Type | Description |
---|---|---|
$docId | integer | |
$reader | \Zend_Search_Lucene_Interface |
Type | Description |
---|---|
float |

addSubquery(
\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
Name | Type | Description |
---|---|---|
$subquery | \Zend_Search_Lucene_Search_Query | |
$sign | boolean|null |

createWeight(
\Zend_Search_Lucene_Interface $reader
)
:
\Zend_Search_Lucene_Search_Weight
Constructs an appropriate Weight implementation for this query.
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
)
:
void
Execute query in context of index reader It also initializes necessary internal structures
Name | Type | Description |
---|---|---|
$reader | \Zend_Search_Lucene_Interface | |
$docsFilter | \Zend_Search_Lucene_Index_DocsFilter|null |

matchedDocs(
)
:
array
Get document ids likely matching the query
It's an array with document ids as keys (performance considerations)
Type | Description |
---|---|
array |

optimize(
\Zend_Search_Lucene_Interface $index
)
:
\Zend_Search_Lucene_Search_Query
Optimize query in the context of specified index
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_Query
Re-write queries into primitive queries
Name | Type | Description |
---|---|---|
$index | \Zend_Search_Lucene_Interface |
Type | Description |
---|---|
\Zend_Search_Lucene_Search_Query |

score(
integer $docId, \Zend_Search_Lucene_Interface $reader
)
:
float
Score specified document
Name | Type | Description |
---|---|---|
$docId | integer | |
$reader | \Zend_Search_Lucene_Interface |
Type | Description |
---|---|
float |