Search/Lucene/Search/Query/Preprocessing/Term.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 [email protected] 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_Term

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 $_encoding
Word encoding (field name is always provided using UTF-8 encoding since it may be retrieved from index).
Details
Type
string
>VPropertyprivatestring $_field
Field name.
Details
Type
string
>VPropertyprivatestring $_word
word (query parser lexeme) to find.
Details
Type
string

Methods

methodpublic__construct(string $word, string $encoding, string $fieldName) : void

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

Parameters
NameTypeDescription
$wordstring

Non-tokenized word (query parser lexeme) to search.

$encodingstring

Word 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)

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
Documentation was generated by phpDocumentor 2.2.0 .