category Zend
package Zend_Search_Lucene
subpackage Search
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License

 Methods

Constructor - pass object handle of Zend_Search_Lucene_Interface index that produced the hit so the document can be retrieved easily from the hit.

__construct(\Zend_Search_Lucene_Interface $index) 

Parameters

$index

\Zend_Search_Lucene_Interface

Convenience function for getting fields from the document associated with this hit.

__get(string $offset) : string

Parameters

$offset

string

Returns

string

Return the document object for this hit

getDocument() : \Zend_Search_Lucene_Document

Returns

\Zend_Search_Lucene_Document

Return the index object for this hit

getIndex() : \Zend_Search_Lucene_Interface

Returns

\Zend_Search_Lucene_Interface

 Properties

 

Number of the document in the index

$id : integer

Default

 

Score of the hit

$score : float

Default

 

Object handle of the document associated with this hit

$_document : \Zend_Search_Lucene_Document

Default

null
 

Object handle of the index

$_index : \Zend_Search_Lucene_Interface

Default

null