Search/Lucene/Search/Query/Preprocessing/Phrase.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Search_Lucene
subpackage: Search
version: $Id: Phrase.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Search_Lucene_Search_Query_Preprocessing_Phrase

Description

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.

Zend_Search_Lucene_Search_Query_Preprocessing_Phrase
jump to top

Extends from: Zend_Search_Lucene_Search_Query_Preprocessing
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
internal
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Search_Lucene
subpackage: Search
Properties: $_phrase; $_phraseEncoding; $_field; $_slop
Methods: __construct; setSlop; getSlop; rewrite; _highlightMatches; __toString

Description

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.

Properties

$_field
jump to class

string $_field = ''

Field name.

Details

$_field: string
visibility: private
default
final: false
static: false

$_phrase
jump to class

string $_phrase = ''

Phrase to find.

Details

$_phrase: string
visibility: private
default
final: false
static: false

$_phraseEncoding
jump to class

string $_phraseEncoding = ''

Phrase encoding (field name is always provided using UTF-8 encoding since it may be retrieved from index).

Details

$_phraseEncoding: string
visibility: private
default
final: false
static: false

$_slop
jump to class

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.

Details

$_slop: integer
visibility: private
default
final: false
static: false

Methods

__construct
jump to class

__construct(
          string $phrase, string $phraseEncoding, string $fieldName
          )
        
        :

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

Arguments

$phrase: string
Phrase to search.
$phraseEncoding: string
Phrase encoding.
$fieldName: string
Field name.

Details

visibility: public
final: false
static: false

__toString
jump to class

__toString(
          
          )
        
        :
        string

Print a query

Output

string

Details

visibility: public
final: false
static: false

_highlightMatches
jump to class

_highlightMatches(
          Zend_Search_Lucene_Search_Highlighter_Interface $highlighter
          )
        
        :

Query specific matches highlighting

Arguments

$highlighter: Zend_Search_Lucene_Search_Highlighter_Interface
Highlighter object (also contains doc for highlighting)

Details

visibility: protected
final: false
static: false

getSlop
jump to class

getSlop(
          
          )
        
        :
        integer

Get slop

Output

integer

Details

visibility: public
final: false
static: false

rewrite
jump to class

rewrite(
          Zend_Search_Lucene_Interface $index
          )
        
        :
        Zend_Search_Lucene_Search_Query

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

Arguments

$index: Zend_Search_Lucene_Interface

Output

Zend_Search_Lucene_Search_Query

Details

visibility: public
final: false
static: false

setSlop
jump to class

setSlop(
          integer $slop
          )
        
        :

Set slop

Arguments

$slop: integer

Details

visibility: public
final: false
static: false

API Documentation

Search/Lucene/Search/Query/Preprocessing/Phrase.php

Description

Zend_Search_Lucene_Search_Query_Preprocessing_Phrasejump to top

Description

Properties

$_fieldjump to class

Details

$_phrasejump to class

Details

$_phraseEncodingjump to class

Details

$_slopjump to class

Details

Methods

__constructjump to class

Arguments

Details

__toStringjump to class

Output

Details

_highlightMatchesjump to class

Arguments

Details

getSlopjump to class

Output

Details

rewritejump to class

Arguments

Output

Details

setSlopjump to class

Arguments

Details

Zend_Search_Lucene_Search_Query_Preprocessing_Phrase
jump to top

$_field
jump to class

$_phrase
jump to class

$_phraseEncoding
jump to class

$_slop
jump to class

__construct
jump to class

__toString
jump to class

_highlightMatches
jump to class

getSlop
jump to class

rewrite
jump to class

setSlop
jump to class