Search/Lucene/Search/QueryHit.php

Show: PublicProtectedPrivateinherited
Table of Contents
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

>VPropertyprotected\Zend_Search_Lucene_Document $_document = null
Object handle of the document associated with this hit
Default valuenullDetails
Type
\Zend_Search_Lucene_Document
>VPropertyprotected\Zend_Search_Lucene_Interface $_index = null
Object handle of the index
Default valuenullDetails
Type
\Zend_Search_Lucene_Interface
>VPropertypublicinteger $id
Number of the document in the index
Details
Type
integer
>VPropertypublicfloat $score
Score of the hit
Details
Type
float

Methods

methodpublic__construct(\Zend_Search_Lucene_Interface $index) : void

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

Parameters
NameTypeDescription
$index\Zend_Search_Lucene_Interface
methodpublic__get(string $offset) : string

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

Parameters
NameTypeDescription
$offsetstring
Returns
TypeDescription
string
methodpublicgetDocument() : \Zend_Search_Lucene_Document

Return the document object for this hit

Returns
TypeDescription
\Zend_Search_Lucene_Document
methodpublicgetIndex() : \Zend_Search_Lucene_Interface

Return the index object for this hit

Returns
TypeDescription
\Zend_Search_Lucene_Interface
Documentation was generated by phpDocumentor 2.2.0 .