<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>The tidy class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="tidy.examples.basic.html">Tidy example</a></div>
<div class="next" style="text-align: right; float: right;"><a href="tidy.body.html">tidy::body</a></div>
<div class="up"><a href="book.tidy.html">Tidy</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="class.tidy" class="reference">
<h1 class="title">The <a href="class.tidy.html" class="classname">tidy</a> class</h1>
<div class="partintro"><p class="verinfo">(PHP 5, PECL tidy >= 0.5.2)</p>
<div class="section" id="tidy.intro">
<h2 class="title">Introduction</h2>
<p class="para">
An HTML node in an HTML file, as detected by tidy.
</p>
</div>
<div class="section" id="tidy.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="ooclass">
<strong class="classname">tidy</strong>
</span>
{</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Properties */</div>
<div class="fieldsynopsis"><span class="type">string</span> <var class="varname"><a href="tidy.props.errorbuffer.html">$<var class="varname">errorBuffer</var></a></var>;</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
<div class="methodsynopsis dc-description">
<span class="type">tidyNode</span> <span class="methodname"><a href="tidy.body.html" class="methodname">body</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="tidy.cleanrepair.html" class="methodname">cleanRepair</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="methodname"><a href="tidy.construct.html" class="methodname">__construct</a></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$filename</code></span>
[, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$config</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$encoding</code></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$use_include_path</code></span>
]]]] )</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="tidy.diagnose.html" class="methodname">diagnose</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><a href="tidy.getconfig.html" class="methodname">getConfig</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><a href="tidy.gethtmlver.html" class="methodname">getHtmlVer</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">mixed</span> <span class="methodname"><a href="tidy.getopt.html" class="methodname">getOpt</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$option</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><a href="tidy.getoptdoc.html" class="methodname">getOptDoc</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$optname</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><a href="tidy.getrelease.html" class="methodname">getRelease</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><a href="tidy.getstatus.html" class="methodname">getStatus</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">tidyNode</span> <span class="methodname"><a href="tidy.head.html" class="methodname">head</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">tidyNode</span> <span class="methodname"><a href="tidy.html.html" class="methodname">html</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="tidy.isxhtml.html" class="methodname">isXhtml</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="tidy.isxml.html" class="methodname">isXml</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="tidy.parsefile.html" class="methodname">parseFile</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$filename</code></span>
[, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$config</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$encoding</code></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$use_include_path</code><span class="initializer"> = false</span></span>
]]] )</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="tidy.parsestring.html" class="methodname">parseString</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$input</code></span>
[, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$config</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$encoding</code></span>
]] )</div>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><a href="tidy.repairfile.html" class="methodname">repairFile</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$filename</code></span>
[, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$config</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$encoding</code></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$use_include_path</code><span class="initializer"> = false</span></span>
]]] )</div>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><a href="tidy.repairstring.html" class="methodname">repairString</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$data</code></span>
[, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$config</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$encoding</code></span>
]] )</div>
<div class="methodsynopsis dc-description">
<span class="type">tidyNode</span> <span class="methodname"><a href="tidy.root.html" class="methodname">root</a></span>
( <span class="methodparam">void</span>
)</div>
}</div>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="tidy.body.html">tidy::body</a> — Returns a tidyNode object starting from the <body> tag of the tidy parse tree</li><li><a href="tidy.cleanrepair.html">tidy::cleanRepair</a> — Execute configured cleanup and repair operations on parsed markup</li><li><a href="tidy.construct.html">tidy::__construct</a> — Constructs a new tidy object</li><li><a href="tidy.diagnose.html">tidy::diagnose</a> — Run configured diagnostics on parsed and repaired markup</li><li><a href="tidy.props.errorbuffer.html">tidy::$errorBuffer</a> — Return warnings and errors which occurred parsing the specified document</li><li><a href="tidy.getconfig.html">tidy::getConfig</a> — Get current Tidy configuration</li><li><a href="tidy.gethtmlver.html">tidy::getHtmlVer</a> — Get the Detected HTML version for the specified document</li><li><a href="tidy.getopt.html">tidy::getOpt</a> — Returns the value of the specified configuration option for the tidy document</li><li><a href="tidy.getoptdoc.html">tidy::getOptDoc</a> — Returns the documentation for the given option name</li><li><a href="tidy.getrelease.html">tidy::getRelease</a> — Get release date (version) for Tidy library</li><li><a href="tidy.getstatus.html">tidy::getStatus</a> — Get status of specified document</li><li><a href="tidy.head.html">tidy::head</a> — Returns a tidyNode object starting from the <head> tag of the tidy parse tree</li><li><a href="tidy.html.html">tidy::html</a> — Returns a tidyNode object starting from the <html> tag of the tidy parse tree</li><li><a href="tidy.isxhtml.html">tidy::isXhtml</a> — Indicates if the document is a XHTML document</li><li><a href="tidy.isxml.html">tidy::isXml</a> — Indicates if the document is a generic (non HTML/XHTML) XML document</li><li><a href="tidy.parsefile.html">tidy::parseFile</a> — Parse markup in file or URI</li><li><a href="tidy.parsestring.html">tidy::parseString</a> — Parse a document stored in a string</li><li><a href="tidy.repairfile.html">tidy::repairFile</a> — Repair a file and return it as a string</li><li><a href="tidy.repairstring.html">tidy::repairString</a> — Repair a string using an optionally provided configuration file</li><li><a href="tidy.root.html">tidy::root</a> — Returns a tidyNode object representing the root of the tidy parse tree</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="tidy.examples.basic.html">Tidy example</a></div>
<div class="next" style="text-align: right; float: right;"><a href="tidy.body.html">tidy::body</a></div>
<div class="up"><a href="book.tidy.html">Tidy</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
