Search/Lucene/Search/QueryHit.php
Show:
inherited
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 license@zend.com so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Search_Lucene
- Subpackage
- Search
- Version
- $Id$
\Zend_Search_Lucene_Search_QueryHit
Package: Zend_Search_Lucene\Search
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 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
Default value
nullDetails\Zend_Search_Lucene_Interface $_index = nullObject handle of the index
Default value
nullDetailsinteger $idNumber of the document in the index
Details
- Type
- integer
float $scoreScore of the hit
Details
- 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.
Parameters
| Name | Type | Description |
|---|---|---|
| $index | \Zend_Search_Lucene_Interface |
__get(string $offset) : stringConvenience function for getting fields from the document associated with this hit.
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $offset | string |
| Type | Description |
|---|---|
| string |
getDocument() : \Zend_Search_Lucene_DocumentReturn the document object for this hit
Returns
| Type | Description |
|---|---|
| \Zend_Search_Lucene_Document |
getIndex() : \Zend_Search_Lucene_InterfaceReturn the index object for this hit
Returns
| Type | Description |
|---|---|
| \Zend_Search_Lucene_Interface |