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

\Zend_Search_Lucene_Search_QueryEntry_Phrase

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

Properties

>VPropertyprotectedfloat $_boost = 1.0
inherited
Query entry boost factor
Inherited from: \Zend_Search_Lucene_Search_QueryEntry::$$_boost
Default value1.0Details
Type
float
Inherited_from
\Zend_Search_Lucene_Search_QueryEntry::$$_boost  
>VPropertyprivatestring|null $_field
Field
Details
Type
string | null
>VPropertyprivatestring $_phrase
Phrase value
Details
Type
string
>VPropertyprivateboolean $_proximityQuery = false
Proximity phrase query
Default valuefalseDetails
Type
boolean
>VPropertyprivateinteger $_wordsDistance = 0
Words distance, used for proximiti queries
Default value0Details
Type
integer

Methods

methodpublic__construct(string $phrase, string $field) : void

Object constractor

Parameters
NameTypeDescription
$phrasestring
$fieldstring
methodpublicboost(float $boostFactor) : void
inherited

Boost query entry

Inherited from: \Zend_Search_Lucene_Search_QueryEntry::boost()
Parameters
NameTypeDescription
$boostFactorfloat
methodpublicgetQuery(string $encoding) : \Zend_Search_Lucene_Search_Query

Transform entry to a subquery

Parameters
NameTypeDescription
$encodingstring
Returns
TypeDescription
\Zend_Search_Lucene_Search_Query
Throws
ExceptionDescription
\Zend_Search_Lucene_Search_QueryParserException
methodpublicprocessFuzzyProximityModifier(mixed $parameter = null) : void

Process modifier ('~')

Parameters
NameTypeDescription
$parametermixed
Documentation was generated by phpDocumentor 2.0.0a12.