Search/Lucene/Document.php
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
- Document
- Version
- $Id: Document.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Search_Lucene_Document
Package: Zend\Search\Lucene\DocumentA 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-2012 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 valuearray()
Details- Type
- array



float $boost = 1.0
Field boost factor
It's not stored directly in the index, but affects on normalization factor
Default value1.0
Details- Type
- float
Methods



__get(string $offset) : string
Proxy method for getFieldValue(), provides more convenient access to
the string value of a field.
ParametersName | Type | Description |
---|
$offset | string | |
---|
Returns 


getField(string $fieldName) : \Zend_Search_Lucene_Field
Returns Zend_Search_Lucene_Field object for a named field in this document.
ParametersName | Type | Description |
---|
$fieldName | string | |
---|
Returns 


getFieldUtf8Value( $fieldName) : string
Returns the string value of a named field in UTF-8 encoding.
ParametersName | Type | Description |
---|
$fieldName | | |
---|
ReturnsDetails- See
- \__get()



getFieldValue( $fieldName) : string
Returns the string value of a named field in this document.
ParametersName | Type | Description |
---|
$fieldName | | |
---|
ReturnsDetails- See
- \__get()