The tidy class

Introduction

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

Class synopsis

tidy

/* Properties */

public stringnull $errorBuffer = null;

public stringnull $value = null;

/* Methods */

public __construct(
    stringnull $filename = null,
    arraystringnull $config = null,
    stringnull $encoding = null,
    bool $useIncludePath = false
)

public tidyNodenull body()

public bool cleanRepair()

public bool diagnose()

public array getConfig()

public int getHtmlVer()

public stringintbool getOpt(string $option)

public stringfalse getOptDoc(string $option)

public string getRelease()

public int getStatus()

public tidyNodenull head()

public tidyNodenull html()

public bool isXhtml()

public bool isXml()

public bool parseFile(
    string $filename,
    arraystringnull $config = null,
    stringnull $encoding = null,
    bool $useIncludePath = false
)

public bool parseString(string $string, arraystringnull $config = null, stringnull $encoding = null)

public static stringfalse repairFile(
    string $filename,
    arraystringnull $config = null,
    stringnull $encoding = null,
    bool $useIncludePath = false
)

public static stringfalse repairString(string $string, arraystringnull $config = null, stringnull $encoding = null)

public tidyNodenull root()

Properties

value: The HTML representation of the node, including the surrounding tags.

Table of Contents

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