/library/Zend/Search/Lucene/Search/Highlighter/Interface.php
PHP | 53 lines | 7 code | 4 blank | 42 comment | 0 complexity | 6c3f9b2ffa81f3d25de932d5b387046d MD5 | raw file
Possible License(s): AGPL-1.0
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-2012 Zend Technologies USA Inc. (http://www.zend.com)
19 * @license http://framework.zend.com/license/new-bsd New BSD License
20 * @version $Id: Interface.php 24594 2012-01-05 21:27:01Z matthew $
21 */
22
23
24/**
25 * @category Zend
26 * @package Zend_Search_Lucene
27 * @subpackage Search
28 * @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
29 * @license http://framework.zend.com/license/new-bsd New BSD License
30 */
31interface Zend_Search_Lucene_Search_Highlighter_Interface
32{
33 /**
34 * Set document for highlighting.
35 *
36 * @param Zend_Search_Lucene_Document_Html $document
37 */
38 public function setDocument(Zend_Search_Lucene_Document_Html $document);
39
40 /**
41 * Get document for highlighting.
42 *
43 * @return Zend_Search_Lucene_Document_Html $document
44 */
45 public function getDocument();
46
47 /**
48 * Highlight specified words (method is invoked once per subquery)
49 *
50 * @param string|array $words Words to highlight. They could be organized using the array or string.
51 */
52 public function highlight($words);
53}