Class Zend_Search_Lucene_Document_Html

Description
Description | Vars | Methods (details)

HTML document.

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

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

Zend_Search_Lucene_Document
   |
   --Zend_Search_Lucene_Document_Html
Method Summary
Description | Vars | Methods (details)
static boolean getExcludeNoFollowLinks ()
static Zend_Search_Lucene_Document_Html loadHTML (string $data, [boolean $storeContent = false], [string $defaultEncoding = ''])
static Zend_Search_Lucene_Document_Html loadHTMLFile (string $file, [boolean $storeContent = false], [string $defaultEncoding = ''])
static void setExcludeNoFollowLinks (boolean $newValue)
string applyColour (string $stringToHighlight,  $colour)
array getHeaderLinks ()
string getHTML ()
string getHtmlBody ()
array getLinks ()
string highlight (string|array $words, [string $colour = '#66ffff'])
string highlightExtended (string|array $words, callback $callback, [array $params = array()])
void _highlightNodeRecursive ( $contextNode, array $wordsToHighlight, callback $callback, array $params)
void _highlightTextNode ( $node, array $wordsToHighlight, callback $callback, array $params)
Variables
Description | Vars (details) | Methods (details)

Inherited Variables

Inherited from Zend_Search_Lucene_Document

Zend_Search_Lucene_Document::$boost
 Zend_Search_Lucene_Document::$_fields
Methods
Description | Vars Methods (details)
static getExcludeNoFollowLinks (line 203)

Get exclude nofollow links flag

  • access: public
static boolean getExcludeNoFollowLinks ()
static loadHTML (line 258)

Load HTML document from a string

  • access: public
static Zend_Search_Lucene_Document_Html loadHTML (string $data, [boolean $storeContent = false], [string $defaultEncoding = ''])
  • string $data
  • boolean $storeContent
  • string $defaultEncoding: HTML encoding, is used if it's not specified using Content-type HTTP-EQUIV meta tag.
static loadHTMLFile (line 271)

Load HTML document from a file

  • access: public
static Zend_Search_Lucene_Document_Html loadHTMLFile (string $file, [boolean $storeContent = false], [string $defaultEncoding = ''])
  • string $file
  • boolean $storeContent
  • string $defaultEncoding: HTML encoding, is used if it's not specified using Content-type HTTP-EQUIV meta tag.
static setExcludeNoFollowLinks (line 193)

Set exclude nofollow links flag

  • access: public
static void setExcludeNoFollowLinks (boolean $newValue)
  • boolean $newValue
applyColour (line 385)

Standard callback method used to highlight words.

  • access: public
string applyColour (string $stringToHighlight,  $colour)
  • string $stringToHighlight
  • $colour
getHeaderLinks (line 245)

Get document header links

  • access: public
array getHeaderLinks ()
getHTML (line 458)

Get HTML

  • access: public
string getHTML ()
getHtmlBody (line 468)

Get HTML body

  • access: public
string getHtmlBody ()
getLinks (line 235)

Get document HREF links

  • access: public
array getLinks ()
highlight (line 397)

Highlight text with specified color

  • access: public
string highlight (string|array $words, [string $colour = '#66ffff'])
  • string|array $words
  • string $colour
highlightExtended (line 414)

Highlight text using specified View helper or callback function.

  • throws: Zend_Search_Lucene_Exception
  • access: public
string highlightExtended (string|array $words, callback $callback, [array $params = array()])
  • string|array $words: Words to highlight. Words could be organized using the array or string.
  • callback $callback: Callback method, used to transform (highlighting) text.
  • array $params: Array of additionall callback parameters passed through into it (first non-optional parameter is an HTML fragment for highlighting)
_highlightNodeRecursive (line 353)

highlight words in content of the specified node

  • access: protected
void _highlightNodeRecursive ( $contextNode, array $wordsToHighlight, callback $callback, array $params)
  • DOMNode $contextNode
  • array $wordsToHighlight
  • callback $callback: Callback method, used to transform (highlighting) text.
  • array $params: Array of additionall callback parameters (first non-optional parameter is a text to transform)
_highlightTextNode (line 286)

Highlight text in text node

  • throws: Zend_Search_Lucene_Exception
  • access: protected
void _highlightTextNode ( $node, array $wordsToHighlight, callback $callback, array $params)
  • DOMText $node
  • array $wordsToHighlight
  • callback $callback: Callback method, used to transform (highlighting) text.
  • array $params: Array of additionall callback parameters (first non-optional parameter is a text to transform)

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 Mon, 21 Jun 2010 15:27:07 -0400 by phpDocumentor 1.4.3