## Zend_Search_Lucene_Document_Html

Description

HTML document.

- license: New BSD License
- copyright: Copyright (c) 2005-2007 Zend Technologies USA Inc. (http://www.zend.com)

Located in /Zend/Search/Lucene/Document/Html.php (line 36)

    Zend_Search_Lucene_Document
       |
       --Zend_Search_Lucene_Document_Html

Method Summary
static Zend_Search_Lucene_Document_Html loadHTML (string $data, [boolean $storeContent = false])
static Zend_Search_Lucene_Document_Html loadHTMLFile (string $file, [boolean $storeContent = false])
array getHeaderLinks ()
string getHTML ()
array getLinks ()
string highlight (string|array $words, [string $color = '#66ffff'])
void _highlightNode ( $contextNode, array $wordsToHighlight, string $color)
void _highlightTextNode ( $node, array $wordsToHighlight, string $color)
Variables

#### Inherited Variables

Inherited from Zend_Search_Lucene_Document

> Zend_Search_Lucene_Document::$boost
> Zend_Search_Lucene_Document::$_fields

Methods
static loadHTML (line 170)

Load HTML document from a string

- access: public

static Zend_Search_Lucene_Document_Html loadHTML (string $data, [boolean $storeContent = false])

- string $data
- boolean $storeContent

static loadHTMLFile (line 182)

Load HTML document from a file

- access: public

static Zend_Search_Lucene_Document_Html loadHTMLFile (string $file, [boolean $storeContent = false])

- string $file
- boolean $storeContent

getHeaderLinks (line 158)

Get document header links

- access: public

array getHeaderLinks ()
getHTML (line 305)

Get HTML

- access: public

string getHTML ()
getLinks (line 148)

Get document HREF links

- access: public

array getLinks ()
highlight (line 270)

Highlight text with specified color

- access: public

string highlight (string|array $words, [string $color = '#66ffff'])

- string|array $words
- string $color

_highlightNode (line 236)

highlight words in content of the specified node

- access: public

void _highlightNode ( $contextNode, array $wordsToHighlight, string $color)

- DOMNode $contextNode
- array $wordsToHighlight
- string $color

_highlightTextNode (line 195)

Highlight text in text node

- access: public

void _highlightTextNode ( $node, array $wordsToHighlight, string $color)

- DOMText $node
- array $wordsToHighlight
- string $color

#### Inherited Methods

Inherited From Zend_Search_Lucene_Document

> Zend_Search_Lucene_Document::addField()
> Zend_Search_Lucene_Document::getField()
> Zend_Search_Lucene_Document::getFieldNames()
> Zend_Search_Lucene_Document::getFieldUtf8Value()
> Zend_Search_Lucene_Document::getFieldValue()
> Zend_Search_Lucene_Document::__get()

Documentation generated on Wed, 21 Feb 2007 11:50:24 -0800 by phpDocumentor 1.3.1