Tidy

Table of Contents

Introduction
Installing/Configuring
Predefined Constants
Examples
- Tidy example
tidy — The tidy class
- tidy::body — Returns a tidyNode object starting from the <body> tag of the tidy parse tree
- tidy::cleanRepair — Execute configured cleanup and repair operations on parsed markup
- tidy::__construct — Constructs a new tidy object
- tidy::diagnose — Run configured diagnostics on parsed and repaired markup
- tidy::$errorBuffer — Return warnings and errors which occurred parsing the specified document
- tidy::getConfig — Get current Tidy configuration
- tidy::getHtmlVer — Get the Detected HTML version for the specified document
- tidy::getOpt — Returns the value of the specified configuration option for the tidy document
- tidy::getOptDoc — Returns the documentation for the given option name
- tidy::getRelease — Get release date (version) for Tidy library
- tidy::getStatus — Get status of specified document
- tidy::head — Returns a tidyNode object starting from the <head> tag of the tidy parse tree
- tidy::html — Returns a tidyNode object starting from the <html> tag of the tidy parse tree
- tidy::isXhtml — Indicates if the document is a XHTML document
- tidy::isXml — Indicates if the document is a generic (non HTML/XHTML) XML document
- tidy::parseFile — Parse markup in file or URI
- tidy::parseString — Parse a document stored in a string
- tidy::repairFile — Repair a file and return it as a string
- tidy::repairString — Repair a string using an optionally provided configuration file
- tidy::root — Returns a tidyNode object representing the root of the tidy parse tree
tidyNode — The tidyNode class
- tidyNode::getParent — Returns the parent node of the current node
- tidyNode::hasChildren — Checks if a node has children
- tidyNode::hasSiblings — Checks if a node has siblings
- tidyNode::isAsp — Checks if this node is ASP
- tidyNode::isComment — Checks if a node represents a comment
- tidyNode::isHtml — Checks if a node is part of a HTML document
- tidyNode::isJste — Checks if this node is JSTE
- tidyNode::isPhp — Checks if a node is PHP
- tidyNode::isText — Checks if a node represents text (no markup)
Tidy Functions
- ob_tidyhandler — ob_start callback function to repair the buffer
- tidy_access_count — Returns the Number of Tidy accessibility warnings encountered for specified document
- tidy_config_count — Returns the Number of Tidy configuration errors encountered for specified document
- tidy_error_count — Returns the Number of Tidy errors encountered for specified document
- tidy_get_output — Return a string representing the parsed tidy markup
- tidy_load_config — Load an ASCII Tidy configuration file with the specified encoding
- tidy_reset_config — Restore Tidy configuration to default values
- tidy_save_config — Save current settings to named file
- tidy_set_encoding — Set the input/output character encoding for parsing markup
- tidy_setopt — Updates the configuration settings for the specified tidy document
- tidy_warning_count — Returns the Number of Tidy warnings encountered for specified document

The tidy class

Introduction

An HTML node in an HTML file, as detected by tidy.

Class synopsis

tidy

class tidy {

/* Properties */

string$tidy->errorBuffer;

/* Methods */

tidyNode body ( void )

bool cleanRepair ( void )

__construct ([ string $filename [, mixed $config [, string $encoding [, bool $use_include_path ]]]] )

bool diagnose ( void )

array getConfig ( void )

int getHtmlVer ( void )

mixed getOpt ( string $option )

string getOptDoc ( string $optname )

string getRelease ( void )

int getStatus ( void )

tidyNode head ( void )

tidyNode html ( void )

bool isXhtml ( void )

bool isXml ( void )

bool parseFile ( string $filename [, mixed $config [, string $encoding [, bool $use_include_path = false ]]] )

bool parseString ( string $input [, mixed $config [, string $encoding ]] )

string repairFile ( string $filename [, mixed $config [, string $encoding [, bool $use_include_path = false ]]] )

string repairString ( string $data [, mixed $config [, string $encoding ]] )

tidyNode root ( void )

}

The tidyNode class

Introduction

An HTML node in an HTML file, as detected by tidy.

Class synopsis

tidyNode

class tidyNode {

/* Properties */

string$value;

string$name;

int$type;

int$line;

int$column;

bool$proprietary;

int$id;

array$attribute;

array$child;

/* Methods */

tidyNode getParent ( void )

bool hasChildren ( void )

bool hasSiblings ( void )

bool isAsp ( void )

bool isComment ( void )

bool isHtml ( void )

bool isJste ( void )

bool isPhp ( void )

bool isText ( void )

}

Properties

value: The HTML representation of the node, including the surrounding tags.
name: The name of the HTML node
type: The type of the tag (one of the constants above, e.g. TIDY_NODETYPE_PHP)
line: The line number at which the tags is located in the file
column: The column number at which the tags is located in the file
proprietary: Indicates if the node is a proprietary tag
id: The ID of the tag (one of the constants above, e.g. TIDY_TAG_FRAME)
attribute: An array of string, representing the attributes names (as keys) of the current node.
child: An array of tidyNode, representing the children of the current node.

Version	Description
5.1.0	`line`, `column` and `proprietary` were added