Search/Lucene/Search/Highlighter/Default.php

Show:

inherited

Classes
- \Zend_Search_Lucene_Search_Highlighter_Default

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-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_Default
jump to top

Package: Zend_Search_Lucene\Search

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

Properties

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.

Default value0Details

Type: integer

\Zend_Search_Lucene_Document_Html $_doc

HTML document for highlighting

Details

Type: \Zend_Search_Lucene_Document_Html

array $_highlightColors = array('#66ffff', '#ff66ff', '#ffff66', '#ff8888', '#88ff88', '#8888ff', '#88dddd', '#dd88dd', '#dddd88', '#aaddff', '#aaffdd', '#ddaaff', '#ddffaa', '#ffaadd', '#ffddaa')

List of colors for text highlighting

Default value

array('#66ffff', '#ff66ff', '#ffff66', '#ff8888', '#88ff88', '#8888ff', '#88dddd', '#dd88dd', '#dddd88', '#aaddff', '#aaffdd', '#ddaaff', '#ddffaa', '#ffaadd', '#ffddaa')

Details

Type: array

Methods

getDocument() : \Zend_Search_Lucene_Document_Html

Get document for highlighting.

Returns

Type	Description
\Zend_Search_Lucene_Document_Html	$document

highlight(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.

setDocument(\Zend_Search_Lucene_Document_Html $document) : void

Set document for highlighting.

Parameters

Name	Type	Description
$document	\Zend_Search_Lucene_Document_Html

Search/Lucene/Search/Highlighter/Default.php

\Zend_Search_Lucene_Search_Highlighter_Defaultjump to top

Properties

Methods

\Zend_Search_Lucene_Search_Highlighter_Default
jump to top