Search/Lucene/Analysis/Analyzer/Common/Utf8.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
Analysis  
Version
$Id: Utf8.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Search_Lucene_Analysis_Analyzer_Common_Utf8

Package: Zend\Search\Lucene\Analysis
Common implementation of the Zend_Search_Lucene_Analysis_Analyzer interface.

There are several standard standard subclasses provided by Zend_Search_Lucene/Analysis subpackage: Zend_Search_Lucene_Analysis_Analyzer_Common_Text, ZSearchHTMLAnalyzer, ZSearchXMLAnalyzer.

Parent(s)
\Zend_Search_Lucene_Analysis_Analyzer_Common < \Zend_Search_Lucene_Analysis_Analyzer
Children
\Zend_Search_Lucene_Analysis_Analyzer_Common_Utf8_CaseInsensitive
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprivateinteger $_bytePosition
Current binary position in an UTF-8 stream
Details
Type
integer
>VPropertyprivatearray $_filters = array()
inherited
The set of Token filters applied to the Token stream.
Inherited from: \Zend_Search_Lucene_Analysis_Analyzer_Common::$$_filters

Array of Zend_Search_Lucene_Analysis_TokenFilter objects.

Default valuearray()Details
Type
array
Inherited_from
\Zend_Search_Lucene_Analysis_Analyzer_Common::$$_filters  
>VPropertyprivateinteger $_position
Current char position in an UTF-8 stream
Details
Type
integer

Methods

methodpublic__construct() : void

Object constructor

Throws
ExceptionDescription
\Zend_Search_Lucene_Exception
methodpublicaddFilter(\Zend_Search_Lucene_Analysis_TokenFilter $filter) : void
inherited

Add Token filter to the Analyzer

Inherited from: \Zend_Search_Lucene_Analysis_Analyzer_Common::addFilter()
Parameters
NameTypeDescription
$filter\Zend_Search_Lucene_Analysis_TokenFilter
methodpublicgetDefault() : \Zend_Search_Lucene_Analysis_Analyzer
staticinherited

Return the default Analyzer implementation used by indexing code.

Inherited from: \Zend_Search_Lucene_Analysis_Analyzer::getDefault()\Zend_Search_Lucene_Analysis_Analyzer_Common::getDefault()
methodpublicnextToken() : \Zend_Search_Lucene_Analysis_Token | null

Tokenization stream API Get next token Returns null at the end of stream

Tokens are returned in UTF-8 (internal Zend_Search_Lucene encoding)

Returns
TypeDescription
\Zend_Search_Lucene_Analysis_Token | null
methodpublicnormalize(\Zend_Search_Lucene_Analysis_Token $token) : \Zend_Search_Lucene_Analysis_Token
inherited

Apply filters to the token.

Inherited from: \Zend_Search_Lucene_Analysis_Analyzer_Common::normalize()

Can return null when the token was removed.

Parameters
NameTypeDescription
$token\Zend_Search_Lucene_Analysis_Token
Returns
TypeDescription
\Zend_Search_Lucene_Analysis_Token
methodpublicreset() : void

Reset token stream

methodpublicsetDefault( $analyzer) : void
staticinherited

Set the default Analyzer implementation used by indexing code.

Inherited from: \Zend_Search_Lucene_Analysis_Analyzer::setDefault()\Zend_Search_Lucene_Analysis_Analyzer_Common::setDefault()
Parameters
NameTypeDescription
$analyzer
methodpublicsetInput(string $data,  $encoding = '') : void
Parameters
NameTypeDescription
$datastring
$encoding
methodpublictokenize(string $data,  $encoding = '') : array
inherited

Tokenize text to a terms Returns array of Zend_Search_Lucene_Analysis_Token objects

Inherited from: \Zend_Search_Lucene_Analysis_Analyzer::tokenize()\Zend_Search_Lucene_Analysis_Analyzer_Common::tokenize()

Tokens are returned in UTF-8 (internal Zend_Search_Lucene encoding)

Parameters
NameTypeDescription
$datastring
$encoding
Returns
TypeDescription
array
Documentation was generated by phpDocumentor 2.0.0a12.