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.
HTML document.

boolean
$_excludeNoFollowLinks= 'false'
Exclud nofollow links flag
If true then links with rel='nofollow' attribute are not included into document links.
false
Details
__construct(
string $data, boolean $isFile, boolean $storeContent, string $defaultEncoding
=
''
)
:
void
Object constructor
Name | Type | Description |
---|---|---|
$data | string | HTML string (may be HTML fragment, ) |
$isFile | boolean | |
$storeContent | boolean | |
$defaultEncoding | string | HTML encoding, is used if it's not specified using Content-type HTTP-EQUIV meta tag. |

_highlightNodeRecursive(
\DOMNode $contextNode, array $wordsToHighlight, callback $callback, array $params
)
:
void
highlight words in content of the specified node
Name | Type | Description |
---|---|---|
$contextNode | \DOMNode | |
$wordsToHighlight | array | |
$callback | callback | Callback method, used to transform (highlighting) text. |
$params | array | Array of additionall callback parameters (first non-optional parameter is a text to transform) |

_highlightTextNode(
\DOMText $node, array $wordsToHighlight, callback $callback, array $params
)
:
void
Highlight text in text node
Name | Type | Description |
---|---|---|
$node | \DOMText | |
$wordsToHighlight | array | |
$callback | callback | Callback method, used to transform (highlighting) text. |
$params | array | Array of additionall callback parameters (first non-optional parameter is a text to transform) |
Exception | Description |
---|---|
\Zend_Search_Lucene_Exception |

_retrieveNodeText(
\DOMNode $node, string $text
)
:
void
Get node text
We should exclude scripts, which may be not included into comment tags, CDATA sections,
Name | Type | Description |
---|---|---|
$node | \DOMNode | |
$text | string | &$text |

getExcludeNoFollowLinks(
)
:
boolean
Get exclude nofollow links flag
Type | Description |
---|---|
boolean |

highlight(
string|array $words, string $colour
=
'#66ffff'
)
:
string
Highlight text with specified color
Name | Type | Description |
---|---|---|
$words | string|array | |
$colour | string |
Type | Description |
---|---|
string |

highlightExtended(
string|array $words, callback $callback, array $params
=
array()
)
:
string
Highlight text using specified View helper or callback function.
Name | Type | Description |
---|---|---|
$words | string|array | Words to highlight. Words could be organized using the array or string. |
$callback | callback | Callback method, used to transform (highlighting) text. |
$params | array | Array of additionall callback parameters passed through into it (first non-optional parameter is an HTML fragment for highlighting) |
Type | Description |
---|---|
string |
Exception | Description |
---|---|
\Zend_Search_Lucene_Exception |

loadHTML(
string $data, boolean $storeContent
=
false, string $defaultEncoding
=
''
)
:
\Zend_Search_Lucene_Document_Html
Load HTML document from a string
Name | Type | Description |
---|---|---|
$data | string | |
$storeContent | boolean | |
$defaultEncoding | string | HTML encoding, is used if it's not specified using Content-type HTTP-EQUIV meta tag. |
Type | Description |
---|---|
\Zend_Search_Lucene_Document_Html |

loadHTMLFile(
string $file, boolean $storeContent
=
false, string $defaultEncoding
=
''
)
:
\Zend_Search_Lucene_Document_Html
Load HTML document from a file
Name | Type | Description |
---|---|---|
$file | string | |
$storeContent | boolean | |
$defaultEncoding | string | HTML encoding, is used if it's not specified using Content-type HTTP-EQUIV meta tag. |
Type | Description |
---|---|
\Zend_Search_Lucene_Document_Html |