API Documentation

Zend/Search/Lucene/Document.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
Document  
Version
$Id: Document.php 24594 2012-01-05 21:27:01Z matthew $  

\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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedarray  $_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
Propertypublicfloat  $boost= '1.0'

Field boost factor It's not stored directly in the index, but affects on normalization factor

Default value1.0Details
Type
float

Methods

methodpublic__get( string $offset ) : string

Proxy method for getFieldValue(), provides more convenient access to the string value of a field.

Parameters
Name Type Description
$offset string
Returns
Type Description
string
methodpublicaddField( \Zend_Search_Lucene_Field $field ) : \Zend_Search_Lucene_Document

Add a field object to this document.

Parameters
Name Type Description
$field \Zend_Search_Lucene_Field
Returns
Type Description
\Zend_Search_Lucene_Document
methodpublicgetField( string $fieldName ) : \Zend_Search_Lucene_Field

Returns Zend_Search_Lucene_Field object for a named field in this document.

Parameters
Name Type Description
$fieldName string
Returns
Type Description
\Zend_Search_Lucene_Field
methodpublicgetFieldNames( ) : array

Return an array with the names of the fields in this document.

Returns
Type Description
array
methodpublicgetFieldUtf8Value(  $fieldName ) : string

Returns the string value of a named field in UTF-8 encoding.

Parameters
Name Type Description
$fieldName
Returns
Type Description
string
Details
See
\__get()  
methodpublicgetFieldValue(  $fieldName ) : string

Returns the string value of a named field in this document.

Parameters
Name Type Description
$fieldName
Returns
Type Description
string
Details
See
\__get()  
Documentation was generated by DocBlox 0.15.1.