API Documentation

Search/Lucene/Analysis/Analyzer/Common/Utf8.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Search_Lucene  
subpackage
Analysis  
version
$Id: Utf8.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Search_Lucene_Analysis_Analyzer_Common_Utf8

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.

Extends from
\Zend_Search_Lucene_Analysis_Analyzer_Common
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Search_Lucene  
subpackage
Analysis  

Properties

Propertyprivateinteger  $_bytePosition= ''

Current binary position in an UTF-8 stream

Details
Type
integer
Propertyprivateinteger  $_position= ''

Current char position in an UTF-8 stream

Details
Type
integer

Methods

methodpublic__construct( ) : void

Object constructor

Throws
Exception Description
\Zend_Search_Lucene_Exception
methodpublicaddFilter( \Zend_Search_Lucene_Analysis_TokenFilter $filter ) : void

Add Token filter to the Analyzer

Inherited from: \Zend_Search_Lucene_Analysis_Analyzer_Common::addFilter()
Parameters
Name Type Description
$filter \Zend_Search_Lucene_Analysis_TokenFilter
methodpublicgetDefault( ) : \Zend_Search_Lucene_Analysis_Analyzer
static

Return the default Analyzer implementation used by indexing code.

Inherited from: \Zend_Search_Lucene_Analysis_Analyzer::getDefault()
Returns
Type Description
\Zend_Search_Lucene_Analysis_Analyzer
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
Type Description
\Zend_Search_Lucene_Analysis_Tokennull
methodpublicnormalize( \Zend_Search_Lucene_Analysis_Token $token ) : \Zend_Search_Lucene_Analysis_Token

Apply filters to the token. Can return null when the token was removed.

Inherited from: \Zend_Search_Lucene_Analysis_Analyzer_Common::normalize()
Parameters
Name Type Description
$token \Zend_Search_Lucene_Analysis_Token
Returns
Type Description
\Zend_Search_Lucene_Analysis_Token
methodpublicreset( ) : void

Reset token stream

methodpublicsetDefault(  $analyzer ) : void
static

Set the default Analyzer implementation used by indexing code.

Inherited from: \Zend_Search_Lucene_Analysis_Analyzer::setDefault()
Parameters
Name Type Description
$analyzer
methodpublicsetInput( string $data,  $encoding ) : void

Tokenization stream API Set input

Inherited from: \Zend_Search_Lucene_Analysis_Analyzer::setInput()
Parameters
Name Type Description
$data string
$encoding
methodpublictokenize( string $data,  $encoding ) : array

Tokenize text to a terms Returns array of Zend_Search_Lucene_Analysis_Token objects

Inherited from: \Zend_Search_Lucene_Analysis_Analyzer::tokenize()

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

Parameters
Name Type Description
$data string
$encoding
Returns
Type Description
array
Documentation was generated by DocBlox 0.13.3.