Docs For Class HTML

Class HTML_Parser

Description

HTML Parser

All the parsing code by Michael Vogel <http://www.dabo.de/software/>

author:
Keyvan Minoukadeh (made some slight modifications)
author:
Michael Vogel <mailto:http://www.dabo.de/software/>

Located in Program_Root/HTML_Parser.php (line 11)

Variable Summary

string $buffer

object $callback_object

bool $case_sensitive

callback $character_data_handler

callback $comment_handler

callback $doctype_handler

callback $end_element_handler

bool $eof

int $ignore_level

array $ignore_tags

bool $in_handler

string $last_element

callback $process_handler

int $report_level

array $report_tags

callback $start_element_handler

Method Summary

void HTML_Parser ()

void eof ()

string get_last_element ()

bool parse (string $input, [bool $final = false])

void set_case_sensitive (bool $bool)

bool set_character_data_handler (callback $handler)

bool set_comment_handler (callback $handler)

bool set_doctype_handler (callback $handler)

void set_element_handler (callback $start_handler, callback $end_handler)

bool set_end_element_handler (callback $handler)

void set_ignore_elements (mixed $tags)

void set_ignore_tags (mixed $tags)

void set_object (object &$object)

bool set_process_handler (callback $handler)

void set_report_elements (mixed $tags)

void set_report_tags (mixed $tags)

bool set_start_element_handler (callback $handler)

void _character_data_handler (mixed $data)

void _comment_handler (mixed $data)

void _doctype_handler (mixed $data)

void _end_element_handler (mixed $element)

void _parse_attributes (mixed $attributes)

void _parse_tag (mixed $tag)

void _process_handler (mixed $data)

void _start_element_handler (mixed $element, mixed $attributes)

Variables

string $buffer (line 59)

Buffer

object $callback_object (line 17)

Callback object

bool $case_sensitive (line 77)

Case sensitive

callback $character_data_handler (line 35)

Character data handler

callback $comment_handler (line 41)

Comment handler

callback $doctype_handler (line 47)

Doctype handler

callback $end_element_handler (line 29)

End element handler

bool $eof (line 65)

End of file

int $ignore_level (line 109)

Ignore level

Used to determine if an element/cdata should be reported or not

array $ignore_tags (line 89)

Ignore tags

var:
indexed array with tag names

bool $in_handler (line 71)

In handler

string $last_element (line 83)

Last element

callback $process_handler (line 53)

Processing instruction handler

int $report_level (line 102)

Report level

Used to determine if an element/cdata should be reported or not

array $report_tags (line 95)

Report tags

var:
indexed array with tag names

callback $start_element_handler (line 23)

Start element handler

Methods

Constructor HTML_Parser (line 114)

Constructor

void HTML_Parser ()

eof (line 131)

End of file

Indicates end of file

void eof ()

get_last_element (line 248)

Get last element

Returns name of last element passed to start element handler, and before a call to end element handler (which sets the last element to null)

return:
returns string or null

string get_last_element ()

parse (line 682)

Parse

return:
returns false to indicate end of document, true otherwise

bool parse (string $input, [bool $final = false])

string $input
bool $final:
set to true if $input is the last chunk of the document.

set_case_sensitive (line 263)

Set case sensitive

By default, tagnames and attribute names are passed to callback functions as lowercase. Passing true to this method will leave them as found in the HTML source. Note: As other HTML_Parser methods rely on this option, it's important that this is set as soon as a HTML_Parser instance has been created.

void set_case_sensitive (bool $bool)

bool $bool

set_character_data_handler (line 325)

Set character data handler

Pass empty string or false to disable handler

return:
returns true on success, false on error (error will also trigger an E_USER_WARNING)

bool set_character_data_handler (callback $handler)

callback $handler

set_comment_handler (line 337)

Set comment handler

return:
returns true on success, false on error (error will also trigger an E_USER_WARNING)

bool set_comment_handler (callback $handler)

callback $handler

set_doctype_handler (line 350)

Set doctype handler

Pass empty string or false to disable handler

return:
returns true on success, false on error (error will also trigger an E_USER_WARNING)

bool set_doctype_handler (callback $handler)

callback $handler

set_element_handler (line 285)

Set element handler (start and end tags)

Pass empty string or false to disable a handler

void set_element_handler (callback $start_handler, callback $end_handler)

callback $start_handler
callback $end_handler

set_end_element_handler (line 312)

Set end element handler

Pass empty string or false to disable handler

return:
returns true on success, false on error (error will also trigger an E_USER_WARNING)

bool set_end_element_handler (callback $handler)

callback $handler

set_ignore_elements (line 202)

Set ignore elements

Any elements added and found in the HTML will not be reported (no calls to the start, end, or character data handler will be made for the ignored tag). Note: This method is affected by the set_case_sensitive() method.

void set_ignore_elements (mixed $tags)

mixed $tags:
string for a single tag name, array for multiple tag names, null to reset list

set_ignore_tags (line 153)

Set ignore tags

Any tags added and found in the HTML will not be reported (no calls to the start or end tag handler will be made for the ignored tag). Note: This method is affected by the set_case_sensitive() method.

void set_ignore_tags (mixed $tags)

mixed $tags:
string for a single tag name, array for multiple tag names, null to reset list

set_object (line 273)

Set object for callback methods

void set_object (object &$object)

object $object

set_process_handler (line 363)

Set processing instruction handler

Pass empty string or false to disable handler

return:
returns true on success, false on error (error will also trigger an E_USER_WARNING)

bool set_process_handler (callback $handler)

callback $handler

set_report_elements (line 226)

Set report elements

Only elements given here will be reported, any others will be ignored. This method overrides the set_ignore_elements() method. Note: This method is affected by the set_case_sensitive() method.

void set_report_elements (mixed $tags)

mixed $tags:
string for a single tag name, array for multiple tag names, null to reset list

set_report_tags (line 177)

Set report tags

Only tags given here will be reported, any other tags will be ignored. This method overrides the set_ignore_tags() method. Note: This method is affected by the set_case_sensitive() method.

void set_report_tags (mixed $tags)

mixed $tags:
string for a single tag name, array for multiple tag names, null to reset list

set_start_element_handler (line 299)

Set start element handler

Pass empty string or false to disable handler

return:
returns true on success, false on error (error will also trigger an E_USER_WARNING)

bool set_start_element_handler (callback $handler)

callback $handler

_character_data_handler (line 485)

void _character_data_handler (mixed $data)

_comment_handler (line 499)

void _comment_handler (mixed $data)

_doctype_handler (line 507)

void _doctype_handler (mixed $data)

_end_element_handler (line 449)

void _end_element_handler (mixed $element)

_parse_attributes (line 523)

void _parse_attributes (mixed $attributes)

_parse_tag (line 647)

void _parse_tag (mixed $tag)

_process_handler (line 515)

void _process_handler (mixed $data)

_start_element_handler (line 419)

void _start_element_handler (mixed $element, mixed $attributes)

Documention generated on Wed, 16 Jul 2003 01:03:15 +0100 by phpDocumentor 1.2.0