Location: PHPKode > scripts > Simple Debug > simple-debug/Debug.html
<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Transitional//EN' 'http://www.w3.org/TR/REC-html40/loose.dtd'>
<!--NewPage-->
<html>
<head>
	<!-- Generated by PhpDoc date: 'Thu, 23 Jan 2003 05:50:10 +0000' -->
	<title>Docs For Class Debug</title>
<link rel ='stylesheet' type='text/css' href='stylesheet.css' title='style'>
</head>
<body>
<table width="99%" border="0" class="pagetop" cellpadding="4">
	<tr>
		<td align="left"><a href="../classtrees_default.html">Class Trees</a></td>
	</tr>
</table>

<!-- Start of Class Data -->
<h2 class="class-heading">Class Debug</h2>

<pre class="class-tree">
Debug
</pre>

<span class="located-in">Located in: Program_Root/Debug.php</span>

<hr>

<!-- ========== Info from phpDoc block ========= -->
<b class="class-description">Debug class</b>
<pre class="class-full-description">
Class for outputting debug info.

Example:
  // enable debug to be outputted
  Debug::on();
  // set debug level to output debug message with filename and line name
  Debug::level(DEBUG_OUTPUT_FILENAME | DEBUG_OUTPUT_LINE);
  // print debug info (optional filename (__FILE__) and line number (__LINE__) can be passed)
  Debug::debug('debug text here', __FILE__, __LINE__);
  // suppress output of further debug() calls
  Debug::off();
  // no output will be produced
  Debug::debug('testing');
</pre>
<ul class="docblock">
	
	<li><b>Package</b> - <code>default</code></li>
	
	<li><b>Version</b> - <code>0.1</code></li>
	
	<li><b>Author</b> - <code>Keyvan Minoukadeh &lt;<a href="mailto:hide@address.com">hide@address.com</a>&gt;</code></li>
	
</ul>

<hr>
<h2 class="section">Classes extended from Debug:</h2>

<hr>
<!-- should have constructor at some point -->
<!-- =========== Method SUMMARY =========== -->
<a name='Method_summary'><!-- --></a>
<h2 class="section">Method Summary</h2>
<table border='1' cellpadding='3' cellspacing='0' width='100%'>

	
	<!-- =========== Summary =========== -->
	<tr class="TableRowColor">
	<td align="right" valign="top" width="1%"><font size="-1"><code>&nbsp;bool</code></font></td>
	<td align="left" valign="top" width="100%">
	<a href="Debug.html#is_on" class="method-name-summary">is_on (  )</a>
	<br />
	&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Is on - returns true if debuggin is on, false otherwise</td>
	</tr>
	
	<!-- =========== Summary =========== -->
	<tr class="TableRowColor">
	<td align="right" valign="top" width="1%"><font size="-1"><code>&nbsp;void</code></font></td>
	<td align="left" valign="top" width="100%">
	<a href="Debug.html#debug" class="method-name-summary">debug ( $text, [$file = ''], [$line = ''] )</a>
	<br />
	&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Debug - output debug info</td>
	</tr>
	
	<!-- =========== Summary =========== -->
	<tr class="TableRowColor">
	<td align="right" valign="top" width="1%"><font size="-1"><code>&nbsp;int</code></font></td>
	<td align="left" valign="top" width="100%">
	<a href="Debug.html#level" class="method-name-summary">level ( [$new_level = null] )</a>
	<br />
	&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level - set or get debug level</td>
	</tr>
	
	<!-- =========== Summary =========== -->
	<tr class="TableRowColor">
	<td align="right" valign="top" width="1%"><font size="-1"><code>&nbsp;void</code></font></td>
	<td align="left" valign="top" width="100%">
	<a href="Debug.html#off" class="method-name-summary">off (  )</a>
	<br />
	&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Off - turn debugging off</td>
	</tr>
	
	<!-- =========== Summary =========== -->
	<tr class="TableRowColor">
	<td align="right" valign="top" width="1%"><font size="-1"><code>&nbsp;void</code></font></td>
	<td align="left" valign="top" width="100%">
	<a href="Debug.html#on" class="method-name-summary">on (  )</a>
	<br />
	&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;On - turn debugging on</td>
	</tr>
	
</table>

<hr>
<!-- =========== VAR SUMMARY =========== -->
<a name='var_summary'><!-- --></a>
<h2 class="section">Class Variable Summary</h2>

<table border='1' cellpadding='3' cellspacing='0' width='100%'>

	
</table>

<hr>
<!-- =========== VAR INHERITED =========== -->
<a name='vars_inherited'><!-- --></a>
<h2 class="section">Inherited Class Variable Summary</h2>

<table border='1' cellpadding='3' cellspacing='0' width='100%'>

	
</table>

<hr>
<!-- =========== INHERITED METHOD SUMMARY =========== -->
<A NAME='functions_inherited'><!-- --></A>
<h2 class="section">Inherited Method Summary</h2>

<table border='1' cellpadding='3' cellspacing='0' width='100%'>

	
</table>

<hr>
<!-- ============ VARIABLE DETAIL =========== -->

<a name="variable_detail"></a>
<h2 class="section">Variable Detail</h2>



<hr>
<!-- ============ FUNCTION DETAIL =========== -->

<a name='function_detail'></a>
<h2 class="section">Method Detail</h2>


<a name='is_on'><!-- --></a><h3>is_on</h3>
<table>
  <tr>
    <td valign="top"><code>bool</code>&nbsp; <b>is_on (  )</b></td>
  </tr>
  <tr>
    <td><br />
	  <div class="method-detailed-block">
		
		<!-- ========== Info from phpDoc block ========= -->
<b class="function-description">Is on - returns true if debuggin is on, false otherwise</b>
<pre class="function-full-description"></pre>
<dl>
	<dt>Function Parameters:</dt>
	

	<dt>Function Info:</dt>
	
	<dd><b>Static</b> - <code></code></dd>
	
</dl>

	  </div>
    </td>
  </tr>
</table>
<hr>

<a name='debug'><!-- --></a><h3>debug</h3>
<table>
  <tr>
    <td valign="top"><code>void</code>&nbsp; <b>debug ( $text, [$file = ''], [$line = ''] )</b></td>
  </tr>
  <tr>
    <td><br />
	  <div class="method-detailed-block">
		
		<!-- ========== Info from phpDoc block ========= -->
<b class="function-description">Debug - output debug info</b>
<pre class="function-full-description"></pre>
<dl>
	<dt>Function Parameters:</dt>
	

	<dt>Function Info:</dt>
	
</dl>

	  </div>
    </td>
  </tr>
</table>
<hr>

<a name='level'><!-- --></a><h3>level</h3>
<table>
  <tr>
    <td valign="top"><code>int</code>&nbsp; <b>level ( [$new_level = null] )</b></td>
  </tr>
  <tr>
    <td><br />
	  <div class="method-detailed-block">
		
		<!-- ========== Info from phpDoc block ========= -->
<b class="function-description">Level - set or get debug level</b>
<pre class="function-full-description"></pre>
<dl>
	<dt>Function Parameters:</dt>
	
	<dd>- <code>int $new_level: </code></dd>
	

	<dt>Function Info:</dt>
	
</dl>

	  </div>
    </td>
  </tr>
</table>
<hr>

<a name='off'><!-- --></a><h3>off</h3>
<table>
  <tr>
    <td valign="top"><code>void</code>&nbsp; <b>off (  )</b></td>
  </tr>
  <tr>
    <td><br />
	  <div class="method-detailed-block">
		
		<!-- ========== Info from phpDoc block ========= -->
<b class="function-description">Off - turn debugging off</b>
<pre class="function-full-description"></pre>
<dl>
	<dt>Function Parameters:</dt>
	

	<dt>Function Info:</dt>
	
	<dd><b>Static</b> - <code></code></dd>
	
</dl>

	  </div>
    </td>
  </tr>
</table>
<hr>

<a name='on'><!-- --></a><h3>on</h3>
<table>
  <tr>
    <td valign="top"><code>void</code>&nbsp; <b>on (  )</b></td>
  </tr>
  <tr>
    <td><br />
	  <div class="method-detailed-block">
		
		<!-- ========== Info from phpDoc block ========= -->
<b class="function-description">On - turn debugging on</b>
<pre class="function-full-description"></pre>
<dl>
	<dt>Function Parameters:</dt>
	

	<dt>Function Info:</dt>
	
	<dd><b>Static</b> - <code></code></dd>
	
</dl>

	  </div>
    </td>
  </tr>
</table>
<hr>




<div align="center" class="footer">
Generated by <a href="http://phpdocu.sourceforge.net" target="_blank">phpDocumentor</a>
</div>

</body>
</html>
Return current item: Simple Debug