Search/Lucene/Search/Query/Preprocessing/Phrase.php
Show:
inherited
inherited
Classes
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 [email protected] so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Search_Lucene
- Subpackage
- Search
- Version
- $Id$
\Zend_Search_Lucene_Search_Query_Preprocessing_Phrase
Package: Zend_Search_Lucene\Search
It's an internal abstract class intended to finalize ase a query processing after query parsing.
This type of query is not actually involved into query execution.
- Parent(s)
- \Zend_Search_Lucene_Search_Query_Preprocessing < \Zend_Search_Lucene_Search_Query
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- Internal
- License
- New BSD License
Properties
string $_fieldField name.
Details
- Type
- string
string $_phrasePhrase to find.
Details
- Type
- string
string $_phraseEncodingPhrase encoding (field name is always provided using UTF-8 encoding since it may be retrieved from index).
Details
- Type
- string
integer $_slopSets 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.
Details- Type
- integer
Methods
__construct(string $phrase, string $phraseEncoding, string $fieldName) : voidClass constructor. Create a new preprocessing object for prase query.
Parameters
| Name | Type | Description |
|---|---|---|
| $phrase | string | Phrase to search. |
| $phraseEncoding | string | Phrase encoding. |
| $fieldName | string | Field name. |
__toString() : stringPrint a query
Returns
| Type | Description |
|---|---|
| string |
_highlightMatches(\Zend_Search_Lucene_Search_Highlighter_Interface $highlighter) : voidQuery specific matches highlighting
Parameters
| Name | Type | Description |
|---|---|---|
| $highlighter | \Zend_Search_Lucene_Search_Highlighter_Interface | Highlighter object (also contains doc for highlighting) |
getSlop() : integerGet slop
Returns
| Type | Description |
|---|---|
| integer |
rewrite(\Zend_Search_Lucene_Interface $index) : \Zend_Search_Lucene_Search_QueryRe-write query into primitive queries in the context of specified index
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $index | \Zend_Search_Lucene_Interface |
| Type | Description |
|---|---|
| \Zend_Search_Lucene_Search_Query |
setSlop(integer $slop) : voidSet slop
Parameters
| Name | Type | Description |
|---|---|---|
| $slop | integer |