API Documentation

Search/Lucene/Search/Query/Preprocessing/Term.php

Includes Classes 
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: Term.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Search_Lucene_Search_Query_Preprocessing_Term

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_Term

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
$_word
$_encoding
$_field
Methods
__construct
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

$_encoding

string $_encoding = ''

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

Details

$_encoding
string
visibility
private
default
final
false
static
false

$_field

string $_field = ''

Field name.

Details

$_field
string
visibility
private
default
final
false
static
false

$_word

string $_word = ''

word (query parser lexeme) to find.

Details

$_word
string
visibility
private
default
final
false
static
false

Methods

__construct

__construct( string $word, string $encoding, string $fieldName ) :

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

Arguments
$word
string
Non-tokenized word (query parser lexeme) to search.
$encoding
string
Word encoding.
$fieldName
string
Field name.
Details
visibility
public
final
false
static
false

__toString

__toString( ) : string

Print a query

Output
string
Details
visibility
public
final
false
static
false

_highlightMatches

_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

rewrite

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
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.