Search/Lucene/Index/Term.php
- category
- Zend
- copyright
- Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- license
- http://framework.zend.com/license/new-bsd New BSD License
- package
- Zend_Search_Lucene
- subpackage
- Index
- version
- $Id: Term.php 20096 2010-01-06 02:05:09Z bkarwin $
- Classes
- Zend_Search_Lucene_Index_Term
Description
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.
Zend_Search_Lucene_Index_Term
- category
- Zend
- copyright
- Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- license
- http://framework.zend.com/license/new-bsd New BSD License
- package
- Zend_Search_Lucene
- subpackage
- Index
- Properties
- $field
- $text
- Methods
- __construct
- key
- getPrefix
- getLength
Description
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.
Properties
$field
mixed $field = ''Field name or field number (depending from context)
Details
- $field
- mixed
- visibility
- public
- default
- final
- false
- static
- false
$text
string $text = ''Term value
Details
- $text
- string
- visibility
- public
- default
- final
- false
- static
- false
Methods
__construct
__construct(
$text, $field
=
null
)
:
Object constructor
Arguments
- $text
- $field
Details
- visibility
- public
- final
- false
- static
- false
getLength
getLength(
string $str
)
:
stringGet UTF-8 string length
Arguments
- $str
- string
Output
- string
Details
- visibility
- public
- final
- false
- static
- true
getPrefix
getPrefix(
string $str, integer $length
)
:
stringGet term prefix
Arguments
- $str
- string
- $length
- integer
Output
- string
Details
- visibility
- public
- final
- false
- static
- true
key
key(
)
:
stringReturns term key
Output
- string
Details
- visibility
- public
- final
- false
- static
- false