API Documentation

Zend/Search/Lucene/Index/Term.php

Show: inherited
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
Index  
Version
$Id: Term.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Search_Lucene_Index_Term

Package: Zend\Search\Lucene\Index

A Term represents a word from text. This is the unit of search. It is composed of two elements, the text of the word, as a string, and the name of the field that the text occured in, an interned string.

Note that terms may represent more than words from text fields, but also things like dates, email addresses, urls, etc.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertypublicmixed  $field= ''

Field name or field number (depending from context)

Details
Type
mixed
Propertypublicstring  $text= ''

Term value

Details
Type
string

Methods

methodpublic__construct(  $text,  $field = null ) : void

Object constructor

Parameters
Name Type Description
$text
$field
methodpublicgetLength( string $str ) : string
static

Get UTF-8 string length

Parameters
Name Type Description
$str string
Returns
Type Description
string
methodpublicgetPrefix( string $str, integer $length ) : string
static

Get term prefix

Parameters
Name Type Description
$str string
$length integer
Returns
Type Description
string
methodpublickey( ) : string

Returns term key

Returns
Type Description
string
Documentation was generated by DocBlox 0.15.1.