Search/Lucene/Search/QueryHit.php
inherited
Classes
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 [email protected] so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Search_Lucene
- Subpackage
- Search
- Version
- $Id: QueryHit.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Search_Lucene_Search_QueryHit
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
\Zend_Search_Lucene_Document $_document = nullObject handle of the document associated with this hit
nullDetails
\Zend_Search_Lucene_Interface $_index = nullObject handle of the index
nullDetails
integer $id = Number of the document in the index
- Type
- integer
float $score = Score of the hit
- Type
- float
Methods
__construct(\Zend_Search_Lucene_Interface $index) : voidConstructor - pass object handle of Zend_Search_Lucene_Interface index that produced the hit so the document can be retrieved easily from the hit.
| Name | Type | Description |
|---|---|---|
| $index | \Zend_Search_Lucene_Interface |
__get(string $offset) : stringConvenience function for getting fields from the document associated with this hit.
| Name | Type | Description |
|---|---|---|
| $offset | string |
| Type | Description |
|---|---|
| string |
getDocument() : \Zend_Search_Lucene_DocumentReturn the document object for this hit
| Type | Description |
|---|---|
| \Zend_Search_Lucene_Document |
getIndex() : \Zend_Search_Lucene_InterfaceReturn the index object for this hit
| Type | Description |
|---|---|
| \Zend_Search_Lucene_Interface |