API Documentation

Zend/Search/Lucene/Search/Highlighter/Default.php

Show: inherited
Table of Contents

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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Search_Lucene  
Subpackage
Search  
Version
$Id: Default.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Search_Lucene_Search_Highlighter_Default

Package: Zend\Search\Lucene\Search

Implements
\Zend_Search_Lucene_Search_Highlighter_Interface
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedinteger  $_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.

Default value0Details
Type
integer
Propertyprotected\Zend_Search_Lucene_Document_Html  $_doc= ''

HTML document for highlighting

Propertyprotectedarray  $_highlightColors= 'array('#66ffff''

List of colors for text highlighting

Default valuearray('#66ffff'Details
Type
array

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

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.15.1.