Docs For Class Zend_Search_Lucene

Zend_Search_Lucene_Document

Description

A Document is a set of fields. Each field has a name and a textual value.

copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: New BSD License

Located in /Search/Lucene/Document.php (line 37)

Direct descendents

Class	Description
Zend_Search_Lucene_Document_Html	HTML document.
Zend_Search_Lucene_Document_OpenXml	OpenXML document.

Variable Summary

float $boost

array $_fields

Method Summary

Zend_Search_Lucene_Document addField (Zend_Search_Lucene_Field $field)

Zend_Search_Lucene_Field getField (string $fieldName)

array getFieldNames ()

string getFieldUtf8Value ( $fieldName)

string getFieldValue ( $fieldName)

string __get ($offset $offset)

Variables

float $boost = 1.0 (line 54)

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

access: public

array $_fields = array() (line 46)

Associative array Zend_Search_Lucene_Field objects where the keys to the array are the names of the fields.

access: protected

Methods

addField (line 75)

Add a field object to this document.

access: public

Zend_Search_Lucene_Document addField (Zend_Search_Lucene_Field $field)

Zend_Search_Lucene_Field $field

getField (line 100)

Returns Zend_Search_Lucene_Field object for a named field in this document.

access: public

Zend_Search_Lucene_Field getField (string $fieldName)

string $fieldName

getFieldNames (line 88)

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

access: public

array getFieldNames ()

getFieldUtf8Value (line 127)

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

see: Zend_Search_Lucene_Document::__get()
access: public

string getFieldUtf8Value ( $fieldName)

$fieldName

getFieldValue (line 116)

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

see: Zend_Search_Lucene_Document::__get()
access: public

string getFieldValue ( $fieldName)

$fieldName

__get (line 63)

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

access: public

string __get ($offset $offset)

$offset $offset

Documentation generated on Mon, 21 Jun 2010 15:17:34 -0400 by phpDocumentor 1.4.3