Search/Lucene/Field.php
Show:
inherited
inherited
Classes
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-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Search_Lucene
- Subpackage
- Document
- Version
- $Id$
\Zend_Search_Lucene_Field
Package: Zend_Search_Lucene\Document
A field is a section of a Document. Each field has two parts,
a name and a value. Values may be free text or they may be atomic
keywords, which are not further processed. Such keywords may
be used to represent dates, urls, etc. Fields are optionally
stored in the index, so that they may be returned with hits
on the document.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
float $boost = 1.0Field boost factor
It's not stored directly in the index, but affects on normalization factor
Default value
1.0Details- Type
- float
string $encodingField value encoding.
Details
- Type
- string
boolean $isBinary = falseField is stored as binary.
Default value
falseDetails- Type
- boolean
boolean $isIndexed = trueField is to be indexed, so that it may be searched on.
Default value
trueDetails- Type
- boolean
boolean $isStored = falseField is to be stored in the index for return with search hits.
Default value
falseDetails- Type
- boolean
boolean $isTokenized = trueField should be tokenized as text prior to indexing.
Default value
trueDetails- Type
- boolean
string $nameField name
Details
- Type
- string
boolean $storeTermVector = falseField are stored as a term vector
Default value
falseDetails- Type
- boolean
boolean $valueField value
Details
- Type
- boolean
Methods
__construct(string $name, string $value, string $encoding, boolean $isStored, boolean $isIndexed, boolean $isTokenized, boolean $isBinary = false) : voidObject constructor
Parameters
| Name | Type | Description |
|---|---|---|
| $name | string | |
| $value | string | |
| $encoding | string | |
| $isStored | boolean | |
| $isIndexed | boolean | |
| $isTokenized | boolean | |
| $isBinary | boolean |
binary(string $name, string $value) : \Zend_Search_Lucene_Fieldstatic
Constructs a Binary String valued Field that is not tokenized nor indexed, but is stored in the index, for return with hits.
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $name | string | |
| $value | string |
| Type | Description |
|---|---|
| \Zend_Search_Lucene_Field |
getUtf8Value() : stringGet field value in UTF-8 encoding
Returns
| Type | Description |
|---|---|
| string |
keyword(string $name, string $value, string $encoding = '') : \Zend_Search_Lucene_Fieldstatic
Constructs a String-valued Field that is not tokenized, but is indexed and stored. Useful for non-text fields, e.g. date or url.
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $name | string | |
| $value | string | |
| $encoding | string |
| Type | Description |
|---|---|
| \Zend_Search_Lucene_Field |
text(string $name, string $value, string $encoding = '') : \Zend_Search_Lucene_Fieldstatic
Constructs a String-valued Field that is tokenized and indexed, and is stored in the index, for return with hits. Useful for short text fields, like "title" or "subject". Term vector will not be stored for this field.
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $name | string | |
| $value | string | |
| $encoding | string |
| Type | Description |
|---|---|
| \Zend_Search_Lucene_Field |
unIndexed(string $name, string $value, string $encoding = '') : \Zend_Search_Lucene_Fieldstatic
Constructs a String-valued Field that is not tokenized nor indexed, but is stored in the index, for return with hits.
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $name | string | |
| $value | string | |
| $encoding | string |
| Type | Description |
|---|---|
| \Zend_Search_Lucene_Field |
unStored(string $name, string $value, string $encoding = '') : \Zend_Search_Lucene_Fieldstatic
Constructs a String-valued Field that is tokenized and indexed, but that is not stored in the index.
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $name | string | |
| $value | string | |
| $encoding | string |
| Type | Description |
|---|---|
| \Zend_Search_Lucene_Field |