7 * This source file is subject to the new BSD license that is bundled
8 * with this package in the file LICENSE.txt.
9 * It is also available through the world-wide-web at this URL:
10 * http://framework.zend.com/license/new-bsd
11 * If you did not receive a copy of the license and are unable to
12 * obtain it through the world-wide-web, please send an email
13 * to license@zend.com so we can send you a copy immediately.
16 * @package Zend_Search_Lucene
18 * @copyright Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
19 * @license http://framework.zend.com/license/new-bsd New BSD License
20 * @version $Id: QueryHit.php 16541 2009-07-07 06:59:03Z bkarwin $
26 * @package Zend_Search_Lucene
28 * @copyright Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
29 * @license http://framework.zend.com/license/new-bsd New BSD License
31 class Zend_Search_Lucene_Search_QueryHit
34 * Object handle of the index
35 * @var Zend_Search_Lucene_Interface
37 protected $_index = null;
40 * Object handle of the document associated with this hit
41 * @var Zend_Search_Lucene_Document
43 protected $_document = null;
46 * Number of the document in the index
59 * Constructor - pass object handle of Zend_Search_Lucene_Interface index that produced
60 * the hit so the document can be retrieved easily from the hit.
62 * @param Zend_Search_Lucene_Interface $index
65 public function __construct(Zend_Search_Lucene_Interface $index)
67 $this->_index = new Zend_Search_Lucene_Proxy($index);
72 * Convenience function for getting fields from the document
73 * associated with this hit.
75 * @param string $offset
78 public function __get($offset)
80 return $this->getDocument()->getFieldValue($offset);
85 * Return the document object for this hit
87 * @return Zend_Search_Lucene_Document
89 public function getDocument()
91 if (!$this->_document instanceof Zend_Search_Lucene_Document) {
92 $this->_document = $this->_index->getDocument($this->id);
95 return $this->_document;
100 * Return the index object for this hit
102 * @return Zend_Search_Lucene_Interface
104 public function getIndex()
106 return $this->_index;