Search/Lucene/Search/Highlighter/Interface.php
Show:
inherited
inheritedZend 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 [email protected] so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Search_Lucene
- Subpackage
- Search
- Version
- $Id$
\Zend_Search_Lucene_Search_Highlighter_Interface
Package: Zend_Search_Lucene\Search
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Methods
getDocument() : \Zend_Search_Lucene_Document_HtmlGet document for highlighting.
Returns
| Type | Description |
|---|---|
| \Zend_Search_Lucene_Document_Html | $document |
highlight(string | array $words) : voidHighlight 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. |
setDocument(\Zend_Search_Lucene_Document_Html $document) : voidSet document for highlighting.
Parameters
| Name | Type | Description |
|---|---|---|
| $document | \Zend_Search_Lucene_Document_Html |