<!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>Run configured diagnostics on parsed and repaired markup</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="tidy.construct.html">tidy::__construct</a></div>
<div class="next" style="text-align: right; float: right;"><a href="tidy.props.errorbuffer.html">tidy::$errorBuffer</a></div>
<div class="up"><a href="class.tidy.html">tidy</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="tidy.diagnose" class="refentry">
<div class="refnamediv">
<h1 class="refname">tidy::diagnose</h1>
<h1 class="refname">tidy_diagnose</h1>
<p class="verinfo">(PHP 5, PECL tidy >= 0.5.2)</p><p class="refpurpose"><span class="refname">tidy::diagnose</span> -- <span class="refname">tidy_diagnose</span> — <span class="dc-title">Run configured diagnostics on parsed and repaired markup</span></p>
</div>
<div class="refsect1 description" id="refsect1-tidy.diagnose-description">
<h3 class="title">Description</h3>
<p class="para">Object oriented style</p>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>tidy::diagnose</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">Procedural style</p>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>tidy_diagnose</strong></span>
( <span class="methodparam"><span class="type"><a href="class.tidy.html" class="type tidy">tidy</a></span> <code class="parameter">$object</code></span>
)</div>
<p class="para rdfs-comment">
Runs diagnostic tests on the given tidy <em><code class="parameter">object</code></em>,
adding some more information about the document in the error buffer.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-tidy.diagnose-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">object</code></em></span>
<dd>
<p class="para">
The <a href="class.tidy.html" class="classname">Tidy</a> object.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-tidy.diagnose-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-tidy.diagnose-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4047">
<p><strong>Example #1 <span class="function"><strong>tidy::diagnose()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$html </span><span style="color: #007700">= <<< HTML<br /></span><span style="color: #DD0000"><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"<br />"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><br /><br /><p>paragraph</p><br /></span><span style="color: #007700">HTML;<br /><br /></span><span style="color: #0000BB">$tidy </span><span style="color: #007700">= </span><span style="color: #0000BB">tidy_parse_string</span><span style="color: #007700">(</span><span style="color: #0000BB">$html</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$tidy</span><span style="color: #007700">-></span><span style="color: #0000BB">cleanRepair</span><span style="color: #007700">();<br /><br /></span><span style="color: #FF8000">// note the difference between the two outputs<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">$tidy</span><span style="color: #007700">-></span><span style="color: #0000BB">errorBuffer </span><span style="color: #007700">. </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$tidy</span><span style="color: #007700">-></span><span style="color: #0000BB">diagnose</span><span style="color: #007700">();<br />echo </span><span style="color: #0000BB">$tidy</span><span style="color: #007700">-></span><span style="color: #0000BB">errorBuffer</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
line 4 column 1 - Warning: <p> isn't allowed in <head> elements
line 4 column 1 - Warning: inserting missing 'title' element
line 4 column 1 - Warning: <p> isn't allowed in <head> elements
line 4 column 1 - Warning: inserting missing 'title' element
Info: Doctype given is "-//W3C//DTD XHTML 1.0 Strict//EN"
Info: Document content looks like XHTML 1.0 Strict
2 warnings, 0 errors were found!
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-tidy.diagnose-seealso">
<h3 class="title">See Also</h3>
<ul class="simplelist">
<li class="member"> <span class="function"><strong>tidy::errorBuffer()</strong></span></li>
</ul>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="tidy.construct.html">tidy::__construct</a></div>
<div class="next" style="text-align: right; float: right;"><a href="tidy.props.errorbuffer.html">tidy::$errorBuffer</a></div>
<div class="up"><a href="class.tidy.html">tidy</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
