Zend_Search_Lucene_Field Class Reference

Public Member Functions
	__construct ($name, $value, $encoding, $isStored, $isIndexed, $isTokenized, $isBinary=false)
	Object constructor.
	getUtf8Value ()
	Get field value in UTF-8 encoding.

Static Public Member Functions
static	keyword ($name, $value, $encoding= '')
	Constructs a String-valued Field that is not tokenized, but is indexed and stored.
static	unIndexed ($name, $value, $encoding= '')
	Constructs a String-valued Field that is not tokenized nor indexed, but is stored in the index, for return with hits.
static	binary ($name, $value)
	Constructs a Binary String valued Field that is not tokenized nor indexed, but is stored in the index, for return with hits.
static	text ($name, $value, $encoding= '')
	Constructs a String-valued Field that is tokenized and indexed, and is stored in the index, for return with hits.
static	unStored ($name, $value, $encoding= '')
	Constructs a String-valued Field that is tokenized and indexed, but that is not stored in the index.

Public Attributes
	$name
	$value
	$isStored = false
	$isIndexed = true
	$isTokenized = true
	$isBinary = false
	$storeTermVector = false
	$boost = 1.0
	$encoding

Constructor & Destructor Documentation

__construct	(		$name,
			$value,
			$encoding,
			$isStored,
			$isIndexed,
			$isTokenized,
			$isBinary = false
	)

Object constructor.

Parameters

string	$name
string	$value
string	$encoding
boolean	$isStored
boolean	$isIndexed
boolean	$isTokenized
boolean	$isBinary

Member Function Documentation

static binary (   $name,   $value  )

static

Constructs a Binary String valued Field that is not tokenized nor indexed, but is stored in the index, for return with hits.

Parameters

string	$name
string	$value
string	$encoding

Returns

Zend_Search_Lucene_Field

getUtf8Value

(

)

Get field value in UTF-8 encoding.

Returns

string

static keyword (   $name,   $value,   $encoding = ''  )

static

Constructs a String-valued Field that is not tokenized, but is indexed and stored.

Useful for non-text fields, e.g. date or url.

Parameters

string	$name
string	$value
string	$encoding

Returns

Zend_Search_Lucene_Field

static text (   $name,   $value,   $encoding = ''  )

static

Constructs a String-valued Field that is tokenized and indexed, and is stored in the index, for return with hits.

Useful for short text fields, like "title" or "subject". Term vector will not be stored for this field.

Parameters

string	$name
string	$value
string	$encoding

Returns

Zend_Search_Lucene_Field

static unIndexed (   $name,   $value,   $encoding = ''  )

static

Constructs a String-valued Field that is not tokenized nor indexed, but is stored in the index, for return with hits.

Parameters

string	$name
string	$value
string	$encoding

Returns

Zend_Search_Lucene_Field

static unStored (   $name,   $value,   $encoding = ''  )

static

Constructs a String-valued Field that is tokenized and indexed, but that is not stored in the index.

Parameters

string	$name
string	$value
string	$encoding

Returns

Zend_Search_Lucene_Field

Member Data Documentation

$boost = 1.0

$encoding

$isBinary = false

$isIndexed = true

$isStored = false

$isTokenized = true

$name

$storeTermVector = false

$value