API Documentation

Search/Lucene/Search/Highlighter/Interface.php

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.

category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Search_Lucene  
subpackage
Search  
version
$Id: Interface.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Search_Lucene_Search_Highlighter_Interface

category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Search_Lucene  
subpackage
Search  

Methods

methodpublicgetDocument( ) : \Zend_Search_Lucene_Document_Html

Get document for highlighting.

Returns
Type Description
\Zend_Search_Lucene_Document_Html $document
methodpublichighlight( string|array $words ) : void

Highlight specified words (method is invoked once per subquery)

Parameters
Name Type Description
$words string|array Words to highlight. They could be organized using the array or string.
methodpublicsetDocument( \Zend_Search_Lucene_Document_Html $document ) : void

Set document for highlighting.

Parameters
Name Type Description
$document \Zend_Search_Lucene_Document_Html
Documentation was generated by DocBlox 0.13.3.