Search/Lucene/Document.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_Document
Package: Zend_Search_Lucene\Document
A Document is a set of fields. Each field has a name and a textual value.
- Children
- \Zend_Search_Lucene_Document_Html
- \Zend_Search_Lucene_Document_OpenXml
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
array $_fields = array()Associative array Zend_Search_Lucene_Field objects where the keys to the
array are the names of the fields.
Default value
array()Details- Type
- array
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
Methods
__get(string $offset) : stringProxy method for getFieldValue(), provides more convenient access to the string value of a field.
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $offset | string |
| Type | Description |
|---|---|
| string |
addField(\Zend_Search_Lucene_Field $field) : \Zend_Search_Lucene_DocumentAdd a field object to this document.
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $field | \Zend_Search_Lucene_Field |
| Type | Description |
|---|---|
| \Zend_Search_Lucene_Document |
getField(string $fieldName) : \Zend_Search_Lucene_FieldReturns Zend_Search_Lucene_Field object for a named field in this document.
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $fieldName | string |
| Type | Description |
|---|---|
| \Zend_Search_Lucene_Field |
getFieldNames() : arrayReturn an array with the names of the fields in this document.
Returns
| Type | Description |
|---|---|
| array |
getFieldUtf8Value( $fieldName) : stringReturns the string value of a named field in UTF-8 encoding.