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.
A Query that matches documents containing a particular sequence of terms.

array
$_offsets= ''
Term positions (relative positions of terms within the phrase).
Array of integers

integer
$_slop= ''
Sets the number of other words permitted between words in query phrase.
If zero, then this is an exact phrase search. For larger values this works like a WITHIN or NEAR operator.
The slop is in fact an edit-distance, where the units correspond to moves of terms in the query phrase out of position. For example, to switch the order of two words requires two moves (the first move places the words atop one another), so to permit re-orderings of phrases, the slop must be at least two. More exact matches are scored higher than sloppier matches, thus search results are sorted by exactness.
The slop is zero by default, requiring exact matches.

__construct(
array $terms
=
null, array $offsets
=
null, string $field
=
null
)
:
void
Class constructor. Create a new prase query.
Name | Type | Description |
---|---|---|
$terms | array | Terms to search Array of strings. |
$offsets | array | Relative term positions. Array of integers. |
$field | string | Field to search. |
Exception | Description |
---|---|
\Zend_Search_Lucene_Exception |

_exactPhraseFreq(
integer $docId
)
:
float
Score calculator for exact phrase queries (terms sequence is fixed)
Name | Type | Description |
---|---|---|
$docId | integer |
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) |

_sloppyPhraseFreq(
integer $docId, \Zend_Search_Lucene_Interface $reader
)
:
float
Score calculator for sloppy phrase queries (terms sequence is fixed)
Name | Type | Description |
---|---|---|
$docId | integer | |
$reader | \Zend_Search_Lucene_Interface |
Type | Description |
---|---|
float |

addTerm(
\Zend_Search_Lucene_Index_Term $term, integer $position
=
null
)
:
void
Adds a term to the end of the query phrase.
The relative position of the term is specified explicitly or the one immediately after the last term added.
Name | Type | Description |
---|---|---|
$term | \Zend_Search_Lucene_Index_Term | |
$position | integer |

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 query into primitive queries in the context of specified index
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 |

setWeight(
integer $num, \Zend_Search_Lucene_Search_Weight_Term $weight
)
:
void
Set weight for specified term
Name | Type | Description |
---|---|---|
$num | integer | |
$weight | \Zend_Search_Lucene_Search_Weight_Term |