<!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>Get status of specified document</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="tidy.getrelease.html">tidy::getRelease</a></div>
<div class="next" style="text-align: right; float: right;"><a href="tidy.head.html">tidy::head</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.getstatus" class="refentry">
<div class="refnamediv">
<h1 class="refname">tidy::getStatus</h1>
<h1 class="refname">tidy_get_status</h1>
<p class="verinfo">(PHP 5, PECL tidy >= 0.5.2)</p><p class="refpurpose"><span class="refname">tidy::getStatus</span> -- <span class="refname">tidy_get_status</span> — <span class="dc-title">Get status of specified document</span></p>
</div>
<div class="refsect1 description" id="refsect1-tidy.getstatus-description">
<h3 class="title">Description</h3>
<p class="para">Object oriented style</p>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><strong>tidy::getStatus</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">Procedural style</p>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><strong>tidy_get_status</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">
Returns the status for the specified tidy <em><code class="parameter">object</code></em>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-tidy.getstatus-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.getstatus-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns 0 if no error/warning was raised, 1 for warnings or accessibility
errors, or 2 for errors.
</p>
</div>
<div class="refsect1 examples" id="refsect1-tidy.getstatus-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4052">
<p><strong>Example #1 <span class="function"><strong>tidy::getStatus()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$html </span><span style="color: #007700">= </span><span style="color: #DD0000">'<p>paragraph</i>'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$tidy </span><span style="color: #007700">= new </span><span style="color: #0000BB">tidy</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$tidy</span><span style="color: #007700">-></span><span style="color: #0000BB">parseString</span><span style="color: #007700">(</span><span style="color: #0000BB">$html</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$tidy2 </span><span style="color: #007700">= new </span><span style="color: #0000BB">tidy</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$html2 </span><span style="color: #007700">= </span><span style="color: #DD0000">'<bogus>test</bogus>'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$tidy2</span><span style="color: #007700">-></span><span style="color: #0000BB">parseString</span><span style="color: #007700">(</span><span style="color: #0000BB">$html2</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #0000BB">$tidy</span><span style="color: #007700">-></span><span style="color: #0000BB">getStatus</span><span style="color: #007700">(); </span><span style="color: #FF8000">//1<br /><br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">$tidy2</span><span style="color: #007700">-></span><span style="color: #0000BB">getStatus</span><span style="color: #007700">(); </span><span style="color: #FF8000">//2<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="tidy.getrelease.html">tidy::getRelease</a></div>
<div class="next" style="text-align: right; float: right;"><a href="tidy.head.html">tidy::head</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>
