API Documentation

Zend/Search/Lucene/Search/QueryEntry/Phrase.php

Show: inherited
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 24594 2012-01-05 21:27:01Z 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

Propertyprivatestring|null  $_field= ''

Field

Details
Type
stringnull
Propertyprivatestring  $_phrase= ''

Phrase value

Details
Type
string
Propertyprivateboolean  $_proximityQuery= 'false'

Proximity phrase query

Default valuefalseDetails
Type
boolean
Propertyprivateinteger  $_wordsDistance= '0'

Words distance, used for proximiti queries

Default value0Details
Type
integer

Methods

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

Object constractor

Parameters
Name Type Description
$phrase string
$field string
methodpublicgetQuery( string $encoding ) : \Zend_Search_Lucene_Search_Query

Transform entry to a subquery

Parameters
Name Type Description
$encoding string
Returns
Type Description
\Zend_Search_Lucene_Search_Query
Throws
Exception Description
\Zend_Search_Lucene_Search_QueryParserException
methodpublicprocessFuzzyProximityModifier( mixed $parameter = null ) : void

Process modifier ('~')

Parameters
Name Type Description
$parameter mixed
Documentation was generated by DocBlox 0.15.1.