Search/Lucene/Document/Html.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Search_Lucene
subpackage: Document
version: $Id: Html.php 21946 2010-04-19 08:21:02Z alexander $
Classes: Zend_Search_Lucene_Document_Html

Description

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.

Zend_Search_Lucene_Document_Html
jump to top

Extends from: Zend_Search_Lucene_Document
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Search_Lucene
subpackage: Document
Properties: $_links; $_headerLinks; $_doc; $_excludeNoFollowLinks; $_inlineTags
Methods: __construct; setExcludeNoFollowLinks; getExcludeNoFollowLinks; _retrieveNodeText; getLinks; getHeaderLinks; loadHTML; loadHTMLFile; _highlightTextNode; _highlightNodeRecursive; applyColour; highlight; highlightExtended; getHTML; getHtmlBody

Description

HTML document.

Properties

$_doc
jump to class

DOMDocument $_doc = ''

Stored DOM representation

Details

$_doc: DOMDocument
visibility: private
default
final: false
static: false

$_excludeNoFollowLinks
jump to class

boolean $_excludeNoFollowLinks = 'false'

Exclud nofollow links flag

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

Details

$_excludeNoFollowLinks: boolean
visibility: private
default: false
final: false
static: true

$_headerLinks
jump to class

array $_headerLinks = 'array'

List of document header links

Details

$_headerLinks: array
visibility: private
default: array
final: false
static: false

$_inlineTags
jump to class

array $_inlineTags = 'array'

List of inline tags

Details

$_inlineTags: array
visibility: private
default: array
final: false
static: false

$_links
jump to class

array $_links = 'array'

List of document links

Details

$_links: array
visibility: private
default: array
final: false
static: false

Methods

__construct
jump to class

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

Object constructor

Arguments

$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.

Details

visibility: private
final: false
static: false

_highlightNodeRecursive
jump to class

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

highlight words in content of the specified node

Arguments

$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)

Details

visibility: protected
final: false
static: false

_highlightTextNode
jump to class

_highlightTextNode(
          DOMText $node, array $wordsToHighlight, callback $callback, array $params
          )
        
        :

Highlight text in text node

Arguments

$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)

Details

visibility: protected
final: false
static: false
throws

_retrieveNodeText
jump to class

_retrieveNodeText(
          DOMNode $node, string $text
          )
        
        :

Get node text

We should exclude scripts, which may be not included into comment tags, CDATA sections,

Arguments

$node: DOMNode
$text: string
&$text

Details

visibility: private
final: false
static: false

applyColour
jump to class

applyColour(
          string $stringToHighlight,  $colour
          )
        
        :
        string

Standard callback method used to highlight words.

Arguments

$stringToHighlight: string
$colour

Output

string

Details

visibility: public
final: false
static: false
internal

getExcludeNoFollowLinks
jump to class

getExcludeNoFollowLinks(
          
          )
        
        :
        boolean

Get exclude nofollow links flag

Output

boolean

Details

visibility: public
final: false
static: true

getHTML
jump to class

getHTML(
          
          )
        
        :
        string

Get HTML

Output

string

Details

visibility: public
final: false
static: false

getHeaderLinks
jump to class

getHeaderLinks(
          
          )
        
        :
        array

Get document header links

Output

array

Details

visibility: public
final: false
static: false

getHtmlBody
jump to class

getHtmlBody(
          
          )
        
        :
        string

Get HTML body

Output

string

Details

visibility: public
final: false
static: false

getLinks
jump to class

getLinks(
          
          )
        
        :
        array

Get document HREF links

Output

array

Details

visibility: public
final: false
static: false

highlight
jump to class

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

Highlight text with specified color

Arguments

$words: stringarray
$colour: string

Output

string

Details

visibility: public
final: false
static: false

highlightExtended
jump to class

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

Highlight text using specified View helper or callback function.

Arguments

$words: stringarray
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)

Output

string

Details

visibility: public
final: false
static: false
throws

loadHTML
jump to class

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

Load HTML document from a string

Arguments

$data: string
$storeContent: boolean
$defaultEncoding: string
HTML encoding, is used if it's not specified using Content-type HTTP-EQUIV meta tag.

Output

Zend_Search_Lucene_Document_Html

Details

visibility: public
final: false
static: true

loadHTMLFile
jump to class

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

Load HTML document from a file

Arguments

$file: string
$storeContent: boolean
$defaultEncoding: string
HTML encoding, is used if it's not specified using Content-type HTTP-EQUIV meta tag.

Output

Zend_Search_Lucene_Document_Html

Details

visibility: public
final: false
static: true

setExcludeNoFollowLinks
jump to class

setExcludeNoFollowLinks(
          boolean $newValue
          )
        
        :

Set exclude nofollow links flag

Arguments

$newValue: boolean

Details

visibility: public
final: false
static: true

API Documentation

Search/Lucene/Document/Html.php

Description

Zend_Search_Lucene_Document_Htmljump to top

Description

Properties

$_docjump to class

Details

$_excludeNoFollowLinksjump to class

Details

$_headerLinksjump to class

Details

$_inlineTagsjump to class

Details

$_linksjump to class

Details

Methods

__constructjump to class

Arguments

Details

_highlightNodeRecursivejump to class

Arguments

Details

_highlightTextNodejump to class

Arguments

Details

_retrieveNodeTextjump to class

Arguments

Details

applyColourjump to class

Arguments

Output

Details

getExcludeNoFollowLinksjump to class

Output

Details

getHTMLjump to class

Output

Details

getHeaderLinksjump to class

Output

Details

getHtmlBodyjump to class

Output

Details

getLinksjump to class

Output

Details

highlightjump to class

Arguments

Output

Details

highlightExtendedjump to class

Arguments

Output

Details

loadHTMLjump to class

Arguments

Output

Details

loadHTMLFilejump to class

Arguments

Output

Details

setExcludeNoFollowLinksjump to class

Arguments

Details

Zend_Search_Lucene_Document_Html
jump to top

$_doc
jump to class

$_excludeNoFollowLinks
jump to class

$_headerLinks
jump to class

$_inlineTags
jump to class

$_links
jump to class

__construct
jump to class

_highlightNodeRecursive
jump to class

_highlightTextNode
jump to class

_retrieveNodeText
jump to class

applyColour
jump to class

getExcludeNoFollowLinks
jump to class

getHTML
jump to class

getHeaderLinks
jump to class

getHtmlBody
jump to class

getLinks
jump to class

highlight
jump to class

highlightExtended
jump to class

loadHTML
jump to class

loadHTMLFile
jump to class

setExcludeNoFollowLinks
jump to class