Search/Lucene/Search/Query/Preprocessing/Phrase.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-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

>VPropertyprivatestring $_field
Field name.
Details
Type
string
>VPropertyprivatestring $_phrase
Phrase to find.
Details
Type
string
>VPropertyprivatestring $_phraseEncoding
Phrase encoding (field name is always provided using UTF-8 encoding since it may be retrieved from index).
Details
Type
string
>VPropertyprivateinteger $_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.
Details
Type
integer

Methods

methodpublic__construct(string $phrase, string $phraseEncoding, string $fieldName) : void

Class constructor. Create a new preprocessing object for prase query.

Parameters
NameTypeDescription
$phrasestring

Phrase to search.

$phraseEncodingstring

Phrase encoding.

$fieldNamestring

Field name.

methodpublic__toString() : string

Print a query

Returns
TypeDescription
string
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)

methodpublicgetSlop() : integer

Get slop

Returns
TypeDescription
integer
methodpublicrewrite(\Zend_Search_Lucene_Interface $index) : \Zend_Search_Lucene_Search_Query

Re-write query into primitive queries in the context of specified index

Parameters
NameTypeDescription
$index\Zend_Search_Lucene_Interface
Returns
TypeDescription
\Zend_Search_Lucene_Search_Query
methodpublicsetSlop(integer $slop) : void

Set slop

Parameters
NameTypeDescription
$slopinteger
Documentation was generated by phpDocumentor 2.2.0 .