git.roojs.org Git - web.mtrack/blob - inc/lib/Zend/Search/Lucene/Search/QueryHit.php

   1 <?php
   2 /**
   3  * Zend Framework
   4  *
   5  * LICENSE
   6  *
   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.
  14  *
  15  * @category   Zend
  16  * @package    Zend_Search_Lucene
  17  * @subpackage Search
  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 $
  21  */
  22
  23
  24 /**
  25  * @category   Zend
  26  * @package    Zend_Search_Lucene
  27  * @subpackage Search
  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
  30  */
  31 class Zend_Search_Lucene_Search_QueryHit
  32 {
  33     /**
  34      * Object handle of the index
  35      * @var Zend_Search_Lucene_Interface
  36      */
  37     protected $_index = null;
  38
  39     /**
  40      * Object handle of the document associated with this hit
  41      * @var Zend_Search_Lucene_Document
  42      */
  43     protected $_document = null;
  44
  45     /**
  46      * Number of the document in the index
  47      * @var integer
  48      */
  49     public $id;
  50
  51     /**
  52      * Score of the hit
  53      * @var float
  54      */
  55     public $score;
  56
  57
  58     /**
  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.
  61      *
  62      * @param Zend_Search_Lucene_Interface $index
  63      */
  64
  65     public function __construct(Zend_Search_Lucene_Interface $index)
  66     {
  67         $this->_index = new Zend_Search_Lucene_Proxy($index);
  68     }
  69
  70
  71     /**
  72      * Convenience function for getting fields from the document
  73      * associated with this hit.
  74      *
  75      * @param string $offset
  76      * @return string
  77      */
  78     public function __get($offset)
  79     {
  80         return $this->getDocument()->getFieldValue($offset);
  81     }
  82
  83
  84     /**
  85      * Return the document object for this hit
  86      *
  87      * @return Zend_Search_Lucene_Document
  88      */
  89     public function getDocument()
  90     {
  91         if (!$this->_document instanceof Zend_Search_Lucene_Document) {
  92             $this->_document = $this->_index->getDocument($this->id);
  93         }
  94
  95         return $this->_document;
  96     }
  97
  98
  99     /**
 100      * Return the index object for this hit
 101      *
 102      * @return Zend_Search_Lucene_Interface
 103      */
 104     public function getIndex()
 105     {
 106         return $this->_index;
 107     }
 108 }
 109