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

   1 <?php\r
   2 /**\r
   3  * Zend Framework\r
   4  *\r
   5  * LICENSE\r
   6  *\r
   7  * This source file is subject to the new BSD license that is bundled\r
   8  * with this package in the file LICENSE.txt.\r
   9  * It is also available through the world-wide-web at this URL:\r
  10  * http://framework.zend.com/license/new-bsd\r
  11  * If you did not receive a copy of the license and are unable to\r
  12  * obtain it through the world-wide-web, please send an email\r
  13  * to license@zend.com so we can send you a copy immediately.\r
  14  *\r
  15  * @category   Zend\r
  16  * @package    Zend_Search_Lucene\r
  17  * @subpackage Search\r
  18  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)\r
  19  * @license    http://framework.zend.com/license/new-bsd     New BSD License\r
  20  * @version    $Id: Interface.php 16971 2009-07-22 18:05:45Z mikaelkael $\r
  21  */\r
  22 \r
  23 \r
  24 /**\r
  25  * @category   Zend\r
  26  * @package    Zend_Search_Lucene\r
  27  * @subpackage Search\r
  28  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)\r
  29  * @license    http://framework.zend.com/license/new-bsd     New BSD License\r
  30  */\r
  31 interface Zend_Search_Lucene_Search_Highlighter_Interface\r
  32 {\r
  33         /**\r
  34          * Set document for highlighting.\r
  35          *\r
  36          * @param Zend_Search_Lucene_Document_Html $document\r
  37      */\r
  38         public function setDocument(Zend_Search_Lucene_Document_Html $document);\r
  39 \r
  40     /**\r
  41      * Get document for highlighting.\r
  42      *\r
  43      * @return Zend_Search_Lucene_Document_Html $document\r
  44      */\r
  45     public function getDocument();\r
  46 \r
  47     /**\r
  48      * Highlight specified words (method is invoked once per subquery)\r
  49      *\r
  50      * @param string|array $words  Words to highlight. They could be organized using the array or string.\r
  51      */\r
  52     public function highlight($words);\r
  53 }\r