Search/Lucene/Document/Html.php

Show:

inherited

Classes
- \Zend_Search_Lucene_Document_Html

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: Document
Version: $Id: Html.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Search_Lucene_Document_Html
jump to top

Package: Zend\Search\Lucene\Document

HTML document.

Each field has a name and a textual value.

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

Properties

\DOMDocument $_doc

Stored DOM representation

Details

Type: \DOMDocument

boolean $_excludeNoFollowLinks = false

static

Exclud nofollow links flag

If true then links with rel='nofollow' attribute are not included into document links.

Default valuefalseDetails

Type: boolean

array $_fields = array()

inherited

Associative array Zend_Search_Lucene_Field objects where the keys to the array are the names of the fields.

Inherited from: \Zend_Search_Lucene_Document::$$_fields

Default valuearray()Details

Type: array
Inherited_from: \Zend_Search_Lucene_Document::$$_fields

array $_headerLinks = array()

List of document header links

Default valuearray()Details

Type: array

array $_inlineTags = array('a', 'abbr', 'acronym', 'dfn', 'em', 'strong', 'code', 'samp', 'kbd', 'var', 'b', 'i', 'big', 'small', 'strike', 'tt', 'u', 'font', 'span', 'bdo', 'cite', 'del', 'ins', 'q', 'sub', 'sup')

List of inline tags

Default value

array('a', 'abbr', 'acronym', 'dfn', 'em', 'strong', 'code', 'samp', 'kbd', 'var', 'b', 'i', 'big', 'small', 'strike', 'tt', 'u', 'font', 'span', 'bdo', 'cite', 'del', 'ins', 'q', 'sub', 'sup')

Details

Type: array

array $_links = array()

List of document links

Default valuearray()Details

Type: array

float $boost = 1.0

inherited

Field boost factor It's not stored directly in the index, but affects on normalization factor

Inherited from: \Zend_Search_Lucene_Document::$$boost

Default value1.0Details

Type: float
Inherited_from: \Zend_Search_Lucene_Document::$$boost

Methods

__construct(string $data, boolean $isFile, boolean $storeContent, string $defaultEncoding = '') : void

Object constructor

Parameters

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.

__get(string $offset) : string

inherited

Proxy method for getFieldValue(), provides more convenient access to the string value of a field.

Inherited from: \Zend_Search_Lucene_Document::__get()

Parameters

Name	Type	Description
$offset	string

Returns

Type	Description
string

_highlightNodeRecursive(\DOMNode $contextNode, array $wordsToHighlight, callback $callback, array $params) : void

highlight words in content of the specified node

Parameters

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

Parameters

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)

Throws

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,

Parameters

Name	Type	Description
$node	\DOMNode
$text	string	&$text

addField(\Zend_Search_Lucene_Field $field) : \Zend_Search_Lucene_Document

inherited

Add a field object to this document.

Inherited from: \Zend_Search_Lucene_Document::addField()

Parameters

Name	Type	Description
$field	\Zend_Search_Lucene_Field

Returns

Type	Description
\Zend_Search_Lucene_Document

getExcludeNoFollowLinks() : boolean

static

Get exclude nofollow links flag

Returns

Type	Description
boolean

getField(string $fieldName) : \Zend_Search_Lucene_Field

inherited

Returns Zend_Search_Lucene_Field object for a named field in this document.

Inherited from: \Zend_Search_Lucene_Document::getField()

Parameters

Name	Type	Description
$fieldName	string

Returns

Type	Description
\Zend_Search_Lucene_Field

getFieldNames() : array

inherited

Return an array with the names of the fields in this document.

Inherited from: \Zend_Search_Lucene_Document::getFieldNames()

Returns

Type	Description
array

getFieldUtf8Value( $fieldName) : string

inherited

Returns the string value of a named field in UTF-8 encoding.

Inherited from: \Zend_Search_Lucene_Document::getFieldUtf8Value()

Parameters

Name	Type	Description
$fieldName

Returns

Type	Description
string

Details

See: \__get()

getFieldValue( $fieldName) : string

inherited

Returns the string value of a named field in this document.

Inherited from: \Zend_Search_Lucene_Document::getFieldValue()

Parameters

Name	Type	Description
$fieldName

Returns

Type	Description
string

Details

See: \__get()

getHTML() : string

Get HTML

Returns

Type	Description
string

getHeaderLinks() : array

Get document header links

Returns

Type	Description
array

getHtmlBody() : string

Get HTML body

Returns

Type	Description
string

getLinks() : array

Get document HREF links

Returns

Type	Description
array

highlight(string | array $words, string $colour = '#66ffff') : string

Highlight text with specified color

Parameters

Name	Type	Description
$words	string \| array
$colour	string

Returns

Type	Description
string

highlightExtended(string | array $words, callback $callback, array $params = array()) : string

Highlight text using specified View helper or callback function.

Parameters

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)

Returns

Type	Description
string

Throws

Exception	Description
\Zend_Search_Lucene_Exception

loadHTML(string $data, boolean $storeContent = false, string $defaultEncoding = '') : \Zend_Search_Lucene_Document_Html

static

Load HTML document from a string

Parameters

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.

Returns

Type	Description
\Zend_Search_Lucene_Document_Html

loadHTMLFile(string $file, boolean $storeContent = false, string $defaultEncoding = '') : \Zend_Search_Lucene_Document_Html

static

Load HTML document from a file

Parameters

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.

Returns

Type	Description
\Zend_Search_Lucene_Document_Html

setExcludeNoFollowLinks(boolean $newValue) : void

static

Set exclude nofollow links flag

Parameters

Name	Type	Description
$newValue	boolean

Search/Lucene/Document/Html.php

\Zend_Search_Lucene_Document_Htmljump to top

Properties

Methods

\Zend_Search_Lucene_Document_Html
jump to top