QueryHit
in package
Tags
Table of Contents
Properties
- $document_id : int
- Number of the document in the index
- $id : int
- Unique hit id
- $score : float
- Score of the hit
- $_document : Document
- Object handle of the document associated with this hit
- $_index : SearchIndexInterface
- Object handle of the index
Methods
- __construct() : mixed
- Constructor - pass object handle of Zend_Search_Lucene_Interface index that produced the hit so the document can be retrieved easily from the hit.
- __get() : string
- Convenience function for getting fields from the document associated with this hit.
- __isset() : bool
- Magic method for checking the existence of a field
- getDocument() : Document
- Return the document object for this hit
- getIndex() : SearchIndexInterface
- Return the index object for this hit
Properties
$document_id
Number of the document in the index
public
int
$document_id
$id
Unique hit id
public
int
$id
$score
Score of the hit
public
float
$score
$_document
Object handle of the document associated with this hit
protected
Document
$_document
= null
$_index
Object handle of the index
protected
SearchIndexInterface
$_index
= null
Methods
__construct()
Constructor - pass object handle of Zend_Search_Lucene_Interface index that produced the hit so the document can be retrieved easily from the hit.
public
__construct(SearchIndexInterface $index) : mixed
Parameters
- $index : SearchIndexInterface
__get()
Convenience function for getting fields from the document associated with this hit.
public
__get(string $offset) : string
Parameters
- $offset : string
Return values
string__isset()
Magic method for checking the existence of a field
public
__isset(string $offset) : bool
Parameters
- $offset : string
Return values
bool —TRUE if the field exists else FALSE
getDocument()
Return the document object for this hit
public
getDocument() : Document
Return values
DocumentgetIndex()
Return the index object for this hit
public
getIndex() : SearchIndexInterface