Search/Lucene/Search/QueryHit.php
- category
- Zend
- copyright
- Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- license
- http://framework.zend.com/license/new-bsd New BSD License
- package
- Zend_Search_Lucene
- subpackage
- Search
- version
- $Id: QueryHit.php 20096 2010-01-06 02:05:09Z bkarwin $
- Classes
- Zend_Search_Lucene_Search_QueryHit
Description
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.
Zend_Search_Lucene_Search_QueryHit
- category
- Zend
- copyright
- Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- license
- http://framework.zend.com/license/new-bsd New BSD License
- package
- Zend_Search_Lucene
- subpackage
- Search
- Properties
- $_index
- $_document
- $id
- $score
- Methods
- __construct
- __get
- getDocument
- getIndex
Description
Properties
$_document
Zend_Search_Lucene_Document $_document = 'null'Object handle of the document associated with this hit
Details
- $_document
-
Zend_Search_Lucene_Document
- visibility
- protected
- default
- null
- final
- false
- static
- false
$_index
Zend_Search_Lucene_Interface $_index = 'null'Object handle of the index
Details
- $_index
-
Zend_Search_Lucene_Interface
- visibility
- protected
- default
- null
- final
- false
- static
- false
$id
integer $id = ''Number of the document in the index
Details
- $id
- integer
- visibility
- public
- default
- final
- false
- static
- false
$score
float $score = ''Score of the hit
Details
- $score
- float
- visibility
- public
- default
- final
- false
- static
- false
Methods
__construct
__construct(
Zend_Search_Lucene_Interface $index
)
:
Constructor - pass object handle of Zend_Search_Lucene_Interface index that produced the hit so the document can be retrieved easily from the hit.
Arguments
- $index
- Zend_Search_Lucene_Interface
Details
- visibility
- public
- final
- false
- static
- false
__get
__get(
string $offset
)
:
stringConvenience function for getting fields from the document associated with this hit.
Arguments
- $offset
- string
Output
- string
Details
- visibility
- public
- final
- false
- static
- false
getDocument
getDocument(
)
:
Zend_Search_Lucene_DocumentReturn the document object for this hit
Output
Details
- visibility
- public
- final
- false
- static
- false
getIndex
getIndex(
)
:
Zend_Search_Lucene_InterfaceReturn the index object for this hit
Output
Details
- visibility
- public
- final
- false
- static
- false