Location: PHPKode > projects > FOOWD > foowd/apidocs/Foowd/foowd_debug.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html>
<head>

<title>Foowd_debug</title>

<link rel="stylesheet" type="text/css" href="../stylesheet.css" />
<link rel="start" href="overview-summary.html" />

</head>

<body>

<table width="100%" cellpadding="0" class="header">
<tr><td class="header">
<a href="../overview-summary.html">Overview</a>
<a href="package-summary.html">Package</a>
<a href="package-tree.html">Tree</a></td><td class="short_title">
FOOWD</td></tr>
</table>

<table width="100%" cellpadding="0" class="small_links">
<tr>
<td><a href="../index.html" target="_top">FRAMES</a> <a href="foowd_debug.html" target="_top">NO FRAMES</a></td>
</tr>
<tr>
<td>SUMMARY: <a href="#summary_field">FIELD</a> <a href="#summary_method">METHOD</a></td>
<td>DETAIL: <a href="#detail_field">FIELD</a> <a href="#detail_method">METHOD</a></td>
</tr>
</table>

<hr />

<h1>Class foowd_debug</h1>

<pre><strong>foowd_debug</strong><br /></pre>


<hr />

<p>
class <strong>foowd_debug</strong><br />
</p>

<p>The Foowd debugging class. </p><p>Handles tracking of program execution. </p><dl><dt>Author:</dt><dd>Paul James </dd></dl>
<hr />
<br />

<a name="summary_field"></a>
<table width="100%" cellspacing="0" class="title">
<tr><th colspan="2" class="title">Field Summary</th></tr>
</table>

<table width="100%" cellspacing="0" class="body"><tr><td class="type">public str</td><td class="description"><a href="#$trackString">$trackString</a><br />Function execution tracking data string. </td></tr><tr><td class="type">public int</td><td class="description"><a href="#$trackDepth">$trackDepth</a><br />Depth of the function execution tracking. </td></tr><tr><td class="type">public int</td><td class="description"><a href="#$DBAccessNumber">$DBAccessNumber</a><br />Number of database accesses. </td></tr><tr><td class="type">public int</td><td class="description"><a href="#$startTime">$startTime</a><br />Time execution started. </td></tr></table>
<br />
<a name="summary_method"></a>
<table width="100%" cellspacing="0" class="title">
<tr><th colspan="2" class="title">Method Summary</th></tr>
</table>

<table width="100%" cellspacing="0" class="body"><tr><td class="type">public void</td><td class="description"><a href="#foowd_debug">foowd_debug</a><br />Constructs a new debug object. </td></tr><tr><td class="type">public void</td><td class="description"><a href="#display">display</a><br />Display the debugging information. </td></tr><tr><td class="type">public void</td><td class="description"><a href="#track">track</a><br />Function execution tracking. </td></tr><tr><td class="type">public void</td><td class="description"><a href="#msg">msg</a><br />Add message to debugging output. </td></tr><tr><td class="type">public void</td><td class="description"><a href="#sql">sql</a><br />Add SQL string to debugging output and increment database access count. </td></tr><tr><td class="type">private str</td><td class="description"><a href="#makeVarViewable">makeVarViewable</a><br />Convert constants, objects and arrays into strings ready for displaying. </td></tr><tr><td class="type">private str</td><td class="description"><a href="#flattenArray">flattenArray</a><br />Convert an array into a comma separated string. </td></tr><tr><td class="type">private int</td><td class="description"><a href="#getTime">getTime</a><br />Get the current time. </td></tr><tr><td class="type">private int</td><td class="description"><a href="#executionTime">executionTime</a><br />Calculate the current execution time. </td></tr></table>
<br />
<hr />
<br />


<a name="detail_field"></a>
<table width="100%" cellspacing="0" class="title">
<tr><th class="title">Field Detail</th></tr>
</table>

<a name="$trackString"></a><h2>trackString</h2> <code>public str <strong>$trackString</strong></code><br /><p>Function execution tracking data string. </p><p></p><hr /><a name="$trackDepth"></a><h2>trackDepth</h2> <code>public int <strong>$trackDepth</strong></code><br /><p>Depth of the function execution tracking. </p><p></p><hr /><a name="$DBAccessNumber"></a><h2>DBAccessNumber</h2> <code>public int <strong>$DBAccessNumber</strong></code><br /><p>Number of database accesses. </p><p></p><hr /><a name="$startTime"></a><h2>startTime</h2> <code>public int <strong>$startTime</strong></code><br /><p>Time execution started. </p><p></p><hr />
<a name="detail_method"></a>
<table width="100%" cellspacing="0" class="title">
<tr><th class="title">Method Detail</th></tr>
</table>

<a name="foowd_debug"></a><h2>foowd_debug()</h2> <code>public void <strong>foowd_debug</strong>()</code><br /><p>Constructs a new debug object. </p><p></p><hr /><a name="display"></a><h2>display()</h2> <code>public void <strong>display</strong>()</code><br /><p>Display the debugging information. </p><p></p><hr /><a name="track"></a><h2>track()</h2> <code>public void <strong>track</strong>(str function, array args)</code><br /><p>Function execution tracking. </p><p></p><dl><dt>Parameters:</dt><dd><code>function</code> - The name of the function execution is entering. </dd><dd><code>args</code> - List of arguments passed to the function. </dd></dl><hr /><a name="msg"></a><h2>msg()</h2> <code>public void <strong>msg</strong>(str string)</code><br /><p>Add message to debugging output. </p><p></p><dl><dt>Parameters:</dt><dd><code>string</code> - The message to add. </dd></dl><hr /><a name="sql"></a><h2>sql()</h2> <code>public void <strong>sql</strong>(str SQLString)</code><br /><p>Add SQL string to debugging output and increment database access count. </p><p></p><dl><dt>Parameters:</dt><dd><code>SQLString</code> - The SQL string to add. </dd></dl><hr /><a name="makeVarViewable"></a><h2>makeVarViewable()</h2> <code>private str <strong>makeVarViewable</strong>(mixed arg)</code><br /><p>Convert constants, objects and arrays into strings ready for displaying. </p><p></p><dl><dt>Parameters:</dt><dd><code>arg</code> - The variable to output. </dd></dl><dl><dt>Returns:</dt><dd>Converted variable. </dd></dl><hr /><a name="flattenArray"></a><h2>flattenArray()</h2> <code>private str <strong>flattenArray</strong>(array array)</code><br /><p>Convert an array into a comma separated string. </p><p></p><dl><dt>Parameters:</dt><dd><code>array</code> - The array to convert. </dd></dl><dl><dt>Returns:</dt><dd>Converted array. </dd></dl><hr /><a name="getTime"></a><h2>getTime()</h2> <code>private int <strong>getTime</strong>()</code><br /><p>Get the current time. </p><p></p><dl><dt>Returns:</dt><dd>The time in microseconds. </dd></dl><hr /><a name="executionTime"></a><h2>executionTime()</h2> <code>private int <strong>executionTime</strong>()</code><br /><p>Calculate the current execution time. </p><p></p><dl><dt>Returns:</dt><dd>The time in microseconds. </dd></dl><hr />
<table width="100%" cellpadding="0" class="header">
<tr><td class="header">
<a href="../overview-summary.html">Overview</a>
<a href="package-summary.html">Package</a>
<a href="package-tree.html">Tree</a></td><td class="short_title">
FOOWD</td></tr>
</table>

<table width="100%" cellpadding="0" class="small_links">
<tr>
<td><a href="../index.html" target="_top">FRAMES</a> <a href="foowd_debug.html" target="_top">NO FRAMES</a></td>
</tr>
<tr>
<td>SUMMARY: <a href="#summary_field">FIELD</a> <a href="#summary_method">METHOD</a></td>
<td>DETAIL: <a href="#detail_field">FIELD</a> <a href="#detail_method">METHOD</a></td>
</tr>
</table>

<hr />

<p class="footer">This document was generated by <a href="http://phpdoctor.sourceforge.net/">PHPDoctor: The PHP Documentation Creator</a>.</p>
</body>
</html>
Return current item: FOOWD