Search/Lucene/Search/Highlighter/Default.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: Default.php 20096 2010-01-06 02:05:09Z bkarwin $
- Classes
- Zend_Search_Lucene_Search_Highlighter_Default
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_Default
- Implements
- 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
- Properties
- $_highlightColors
- $_currentColorIndex
- $_doc
- Methods
- setDocument
- getDocument
- highlight
Description
Properties
$_currentColorIndex
integer $_currentColorIndex = '0'Index of current color for highlighting
Index is increased at each highlight() call, so terms matching different queries are highlighted using different colors.
Details
- $_currentColorIndex
- integer
- visibility
- protected
- default
- 0
- final
- false
- static
- false
$_doc
Zend_Search_Lucene_Document_Html $_doc = ''HTML document for highlighting
Details
- $_doc
-
Zend_Search_Lucene_Document_Html
- visibility
- protected
- default
- final
- false
- static
- false
$_highlightColors
array $_highlightColors = 'array'List of colors for text highlighting
Details
- $_highlightColors
- array
- visibility
- protected
- default
- array
- final
- false
- static
- false
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
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