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

Show:

inherited

Classes
- \Zend_Search_Lucene_Analysis_Analyzer_Common_Utf8

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-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
jump to top

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

integer $_bytePosition =

Current binary position in an UTF-8 stream

Details

Type: integer

\Zend_Search_Lucene_Analysis_Analyzer $_defaultImpl =

staticinherited

The Analyzer implementation used by default.

Inherited from: \Zend_Search_Lucene_Analysis_Analyzer::$$_defaultImpl \Zend_Search_Lucene_Analysis_Analyzer_Common::$$_defaultImpl

Details

Type: \Zend_Search_Lucene_Analysis_Analyzer
Inherited_from: \Zend_Search_Lucene_Analysis_Analyzer::$$_defaultImpl
Inherited_from: \Zend_Search_Lucene_Analysis_Analyzer_Common::$$_defaultImpl

string $_encoding = ''

inherited

Input string encoding

Inherited from: \Zend_Search_Lucene_Analysis_Analyzer::$$_encoding \Zend_Search_Lucene_Analysis_Analyzer_Common::$$_encoding

Default value''Details

Type: string
Inherited_from: \Zend_Search_Lucene_Analysis_Analyzer::$$_encoding
Inherited_from: \Zend_Search_Lucene_Analysis_Analyzer_Common::$$_encoding

array $_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

string $_input = null

inherited

Input string

Inherited from: \Zend_Search_Lucene_Analysis_Analyzer::$$_input \Zend_Search_Lucene_Analysis_Analyzer_Common::$$_input

Default valuenullDetails

Type: string
Inherited_from: \Zend_Search_Lucene_Analysis_Analyzer::$$_input
Inherited_from: \Zend_Search_Lucene_Analysis_Analyzer_Common::$$_input

integer $_position =

Current char position in an UTF-8 stream

Details

Type: integer

Methods

__construct() : void

Object constructor

Throws

Exception	Description
\Zend_Search_Lucene_Exception

addFilter(\Zend_Search_Lucene_Analysis_TokenFilter $filter) : void

inherited

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

getDefault() : \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()

Returns

Type	Description
\Zend_Search_Lucene_Analysis_Analyzer

nextToken() : \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_Token \| null

normalize(\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

Name	Type	Description
$token	\Zend_Search_Lucene_Analysis_Token

Returns

Type	Description
\Zend_Search_Lucene_Analysis_Token

reset() : void

Reset token stream

setDefault( $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

Name	Type	Description
$analyzer

setInput(string $data, $encoding = '') : void

inherited

Tokenization stream API Set input

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

Parameters

Name	Type	Description
$data	string
$encoding

tokenize(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

Name	Type	Description
$data	string
$encoding

Returns

Type	Description
array