API Documentation

Search/Lucene/Document.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Search_Lucene
subpackage
Document
version
$Id: Document.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Search_Lucene_Document

Description

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.

Zend_Search_Lucene_Document
jump to top

category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Search_Lucene
subpackage
Document
Properties
$_fields
$boost
Methods
__get
addField
getFieldNames
getField
getFieldValue
getFieldUtf8Value

Description

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

Properties

$_fields
jump to class

array $_fields = 'array'

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

Details

$_fields
array
visibility
protected
default
array
final
false
static
false

$boost
jump to class

float $boost = '1.0'

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

Details

$boost
float
visibility
public
default
1.0
final
false
static
false

Methods

__get
jump to class

__get(  $offset ) : string

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

Arguments
$offset
Output
string
Details
visibility
public
final
false
static
false

addField
jump to class

addField( Zend_Search_Lucene_Field $field ) : Zend_Search_Lucene_Document

Add a field object to this document.

Arguments
$field
Zend_Search_Lucene_Field
Output
Zend_Search_Lucene_Document
Details
visibility
public
final
false
static
false

getField
jump to class

getField( string $fieldName ) : Zend_Search_Lucene_Field

Returns Zend_Search_Lucene_Field object for a named field in this document.

Arguments
$fieldName
string
Output
Zend_Search_Lucene_Field
Details
visibility
public
final
false
static
false

getFieldNames
jump to class

getFieldNames( ) : array

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

Output
array
Details
visibility
public
final
false
static
false

getFieldUtf8Value
jump to class

getFieldUtf8Value(  $fieldName ) : string

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

Arguments
$fieldName
Output
string
Details
visibility
public
final
false
static
false
see
__get()

getFieldValue
jump to class

getFieldValue(  $fieldName ) : string

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

Arguments
$fieldName
Output
string
Details
visibility
public
final
false
static
false
see
__get()
Documentation was generated by DocBlox.