Search/Lucene/Search/Highlighter/Interface.php
- category
- Zend
- copyright
- Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- license
- http://framework.zend.com/license/new-bsd New BSD License
- package
- Zend_Search_Lucene
- subpackage
- Search
- version
- $Id: Interface.php 20096 2010-01-06 02:05:09Z bkarwin $
- Interfaces
- Zend_Search_Lucene_Search_Highlighter_Interface
Description
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.
Zend_Search_Lucene_Search_Highlighter_Interface
- category
- Zend
- copyright
- Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- license
- http://framework.zend.com/license/new-bsd New BSD License
- package
- Zend_Search_Lucene
- subpackage
- Search
- Methods
- setDocument
- getDocument
- highlight
Description
Methods
getDocument
getDocument(
)
:
Zend_Search_Lucene_Document_HtmlGet document for highlighting.
Output
- Zend_Search_Lucene_Document_Html
- $document
Details
- visibility
- public
- final
- false
- static
- false
highlight
highlight(
string|array $words
)
:
Highlight specified words (method is invoked once per subquery)
Arguments
- $words
- stringarray
Words to highlight. They could be organized using the array or string.
Details
- visibility
- public
- final
- false
- static
- false
setDocument
setDocument(
Zend_Search_Lucene_Document_Html $document
)
:
Set document for highlighting.
Arguments
- $document
- Zend_Search_Lucene_Document_Html
Details
- visibility
- public
- final
- false
- static
- false