<?xml version="1.0" encoding="iso-8859-1"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <!-- template designed by Marco Von Ballmoos --> <title>Docs For Class debugHelper</title> <link rel="stylesheet" href="stylesheet.css" /> <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/> </head> <body> <div class="page-body"> <h2 class="class-name">Class debugHelper</h2> <a name="sec-description"></a> <div class="info-box"> <div class="info-box-title">Description</div> <div class="nav-bar"> <span class="disabled">Description</span> | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) </div> <div class="info-box-body"> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Class for displaying var info and taking time</p> <ul class="tags"> <li><span class="field">access:</span> public</li> <li><span class="field">version:</span> 0.6 - 2003/07/07</li> <li><span class="field">copyright:</span> Lennart Groetzbach <hide@address.com> - distributed under the LGPL</li> <li><span class="field">author:</span> Lennart Groetzbach <<a href="mailto:hide@address.com">hide@address.com</a>></li> </ul> <p class="notes"> Located in <a class="field" href="_debugHelper_php.html">Program_Root/debugHelper.php</a> (line <span class="field">74</span>) </p> <pre></pre> </div> </div> <a name="sec-var-summary"></a> <div class="info-box"> <div class="info-box-title">Variable Summary</span></div> <div class="nav-bar"> <a href="#sec-description">Description</a> | <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>) | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) </div> <div class="info-box-body"> <div class="var-summary"> <div class="var-title"> <span class="var-type">Array</span> <a href="#$options" title="details" class="var-name">$options</a> </div> <div class="var-title"> <span class="var-type">Integer</span> <a href="#$_depth" title="details" class="var-name">$_depth</a> </div> <div class="var-title"> <span class="var-type">Array</span> <a href="#$_optionsHtml" title="details" class="var-name">$_optionsHtml</a> </div> <div class="var-title"> <span class="var-type">Array</span> <a href="#$_optionsPlain" title="details" class="var-name">$_optionsPlain</a> </div> <div class="var-title"> <span class="var-type">String</span> <a href="#$_start" title="details" class="var-name">$_start</a> </div> <div class="var-title"> <span class="var-type">String</span> <a href="#$_stop" title="details" class="var-name">$_stop</a> </div> </div> </div> </div> <a name="sec-method-summary"></a> <div class="info-box"> <div class="info-box-title">Method Summary</span></div> <div class="nav-bar"> <a href="#sec-description">Description</a> | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) | <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) </div> <div class="info-box-body"> <div class="method-summary"> <div class="method-definition"> <span class="method-result">debugHelper</span> <a href="#debugHelper" title="details" class="method-name">debugHelper</a> ([<span class="var-type">Integer</span> <span class="var-name">$outputType</span> = <span class="var-default">HTML</span>], [<span class="var-type">Array</span> <span class="var-name">$options</span> = <span class="var-default">null</span>]) </div> <div class="method-definition"> <span class="method-result">void</span> <a href="#dump" title="details" class="method-name">dump</a> (<span class="var-type">mixed</span> <span class="var-name">$thing</span>, [<span class="var-type">mixed</span> <span class="var-name">$options</span> = <span class="var-default">null</span>], <span class="var-type">Integer</span> <span class="var-name">$column</span>) </div> <div class="method-definition"> <span class="method-result">void</span> <a href="#getOptions" title="details" class="method-name">getOptions</a> (<span class="var-type">Integer</span> <span class="var-name">$type</span>, [<span class="var-type">Integer</span> <span class="var-name">$additionalOptions</span> = <span class="var-default">null</span>]) </div> <div class="method-definition"> <span class="method-result">Integer</span> <a href="#getTime" title="details" class="method-name">getTime</a> ([<span class="var-type">String</span> <span class="var-name">$id</span> = <span class="var-default">'default'</span>]) </div> <div class="method-definition"> <span class="method-result">void</span> <a href="#highlightFile" title="details" class="method-name">highlightFile</a> (<span class="var-type">String</span> <span class="var-name">$file</span>, [<span class="var-type">mixed</span> <span class="var-name">$from</span> = <span class="var-default">1</span>], [<span class="var-type">mixed</span> <span class="var-name">$count</span> = <span class="var-default">EOF</span>]) </div> <div class="method-definition"> <span class="method-result">void</span> <a href="#message" title="details" class="method-name">message</a> ([<span class="var-type">mixed</span> <span class="var-name">$string</span> = <span class="var-default">'MESSAGE !!'</span>], [<span class="var-type">Integer</span> <span class="var-name">$options</span> = <span class="var-default">null</span>]) </div> <div class="method-definition"> <span class="method-result">void</span> <a href="#startTimer" title="details" class="method-name">startTimer</a> ([<span class="var-type">String</span> <span class="var-name">$id</span> = <span class="var-default">'default'</span>]) </div> <div class="method-definition"> <span class="method-result">Integer</span> <a href="#stopTimer" title="details" class="method-name">stopTimer</a> ([<span class="var-type">String</span> <span class="var-name">$id</span> = <span class="var-default">'default'</span>]) </div> <div class="method-definition"> <span class="method-result">void</span> <a href="#switchForType" title="details" class="method-name">switchForType</a> (<span class="var-type">mixed</span> <span class="var-name">$thing</span>, <span class="var-type">Array</span> <span class="var-name">$functions</span>, [<span class="var-type">Array</span> <span class="var-name">$options</span> = <span class="var-default">null</span>]) </div> <div class="method-definition"> <span class="method-result">void</span> <a href="#toTable" title="details" class="method-name">toTable</a> (<span class="var-type">Array</span> <span class="var-name">$array</span>, [<span class="var-type">header</span> <span class="var-name">$header</span> = <span class="var-default">null</span>], [<span class="var-type">Boolean</span> <span class="var-name">$horizontal</span> = <span class="var-default">true</span>], [<span class="var-type">String</span> <span class="var-name">$tagAddon</span> = <span class="var-default">'border=1'</span>]) </div> <div class="method-definition"> <span class="method-result">Integer</span> <a href="#_calculateTime" title="details" class="method-name">_calculateTime</a> (<span class="var-type">Integer</span> <span class="var-name">$time</span>, <span class="var-type">String</span> <span class="var-name">$id</span>) </div> <div class="method-definition"> <span class="method-result">void</span> <a href="#_callFunction" title="details" class="method-name">_callFunction</a> (<span class="var-type">String</span> <span class="var-name">$functionName</span>, [<span class="var-type">Boolean</span> <span class="var-name">$abortAmbiguous</span> = <span class="var-default">false</span>]) </div> <div class="method-definition"> <span class="method-result">void</span> <a href="#_dumpArray" title="details" class="method-name">_dumpArray</a> (<span class="var-type">Array</span> <span class="var-name">$array</span>, <span class="var-type">Array</span> <span class="var-name">$options</span>) </div> <div class="method-definition"> <span class="method-result">void</span> <a href="#_dumpBoolean" title="details" class="method-name">_dumpBoolean</a> (<span class="var-type">Boolean</span> <span class="var-name">$thing</span>) </div> <div class="method-definition"> <span class="method-result">void</span> <a href="#_dumpComplete" title="details" class="method-name">_dumpComplete</a> (<span class="var-type">String</span> <span class="var-name">$res</span>, <span class="var-type">Array</span> <span class="var-name">$options</span>) </div> <div class="method-definition"> <span class="method-result">void</span> <a href="#_dumpDouble" title="details" class="method-name">_dumpDouble</a> (<span class="var-type">Double</span> <span class="var-name">$thing</span>) </div> <div class="method-definition"> <span class="method-result">void</span> <a href="#_dumpFloat" title="details" class="method-name">_dumpFloat</a> (<span class="var-type">Float</span> <span class="var-name">$thing</span>) </div> <div class="method-definition"> <span class="method-result">void</span> <a href="#_dumpInteger" title="details" class="method-name">_dumpInteger</a> (<span class="var-type">Integer</span> <span class="var-name">$thing</span>) </div> <div class="method-definition"> <span class="method-result">void</span> <a href="#_dumpLong" title="details" class="method-name">_dumpLong</a> (<span class="var-type">Long</span> <span class="var-name">$thing</span>) </div> <div class="method-definition"> <span class="method-result">void</span> <a href="#_dumpNull" title="details" class="method-name">_dumpNull</a> (<span class="var-type">mixed</span> <span class="var-name">$thing</span>) </div> <div class="method-definition"> <span class="method-result">void</span> <a href="#_dumpObject" title="details" class="method-name">_dumpObject</a> (<span class="var-type">Object</span> <span class="var-name">$object</span>, <span class="var-type">Integer</span> <span class="var-name">$options</span>) </div> <div class="method-definition"> <span class="method-result">void</span> <a href="#_dumpResource" title="details" class="method-name">_dumpResource</a> (<span class="var-type">Resource</span> <span class="var-name">$thing</span>) </div> <div class="method-definition"> <span class="method-result">void</span> <a href="#_dumpString" title="details" class="method-name">_dumpString</a> (<span class="var-type">String</span> <span class="var-name">$str</span>, <span class="var-type">Array</span> <span class="var-name">$options</span>) </div> <div class="method-definition"> <span class="method-result">void</span> <a href="#_dumpUnknown" title="details" class="method-name">_dumpUnknown</a> (<span class="var-type">mixed</span> <span class="var-name">$thing</span>) </div> <div class="method-definition"> <span class="method-result">void</span> <a href="#_onedimhor" title="details" class="method-name">_onedimhor</a> (<span class="var-type">mixed</span> <span class="var-name">&$array</span>, <span class="var-type">mixed</span> <span class="var-name">&$header</span>) </div> <div class="method-definition"> <span class="method-result">void</span> <a href="#_onedimver" title="details" class="method-name">_onedimver</a> (<span class="var-type">mixed</span> <span class="var-name">&$array</span>, <span class="var-type">mixed</span> <span class="var-name">&$header</span>) </div> <div class="method-definition"> <span class="method-result">void</span> <a href="#_twodimhor" title="details" class="method-name">_twodimhor</a> (<span class="var-type">mixed</span> <span class="var-name">&$array</span>, <span class="var-type">mixed</span> <span class="var-name">&$headerArray</span>) </div> <div class="method-definition"> <span class="method-result">void</span> <a href="#_twodimver" title="details" class="method-name">_twodimver</a> (<span class="var-type">mixed</span> <span class="var-name">&$array</span>, <span class="var-type">mixed</span> <span class="var-name">&$headerArray</span>) </div> </div> </div> </div> <a name="sec-vars"></a> <div class="info-box"> <div class="info-box-title">Variables</div> <div class="nav-bar"> <a href="#sec-description">Description</a> | <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) </div> <div class="info-box-body"> <a name="var$options" id="$options"><!-- --></A> <div class="evenrow"> <div class="var-header"> <span class="var-title"> <span class="var-type">Array</span> <span class="var-name">$options</span> = <span class="var-default">null</span> (line <span class="line-number">131</span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">the option set, the debug class was created with</p> <ul class="tags"> <li><span class="field">access:</span> public</li> </ul> </div> <a name="var$_depth" id="$_depth"><!-- --></A> <div class="oddrow"> <div class="var-header"> <span class="var-title"> <span class="var-type">Integer</span> <span class="var-name">$_depth</span> (line <span class="line-number">154</span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">dump depth</p> <ul class="tags"> <li><span class="field">access:</span> private</li> </ul> </div> <a name="var$_optionsHtml" id="$_optionsHtml"><!-- --></A> <div class="evenrow"> <div class="var-header"> <span class="var-title"> <span class="var-type">Array</span> <span class="var-name">$_optionsHtml</span> = <span class="var-default">array("type" => HTML, <br /> "spacer" => "&nbsp;&nbsp;&nbsp;", <br /> "lf" => "<br>\n",<br /> "structOpen" => "<b>",<br /> "structClose" => "</b>",<br /> "specialOpen" => "<i>",<br /> "specialClose" => "</i>",<br /> "useErrorHandler" => true,<br /> "echoResult" => true,<br /> "returnResult" => false,<br /> "convertHtml" => true,<br /> "convertSpecial" => true,<br /> "dumpObjectFunctions" => true,<br /> "dumpObjectVars" => true,<br /> "dumpObjectInheritance" => true<br /> )</span> (line <span class="line-number">83</span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">options for html</p> <ul class="tags"> <li><span class="field">access:</span> private</li> </ul> </div> <a name="var$_optionsPlain" id="$_optionsPlain"><!-- --></A> <div class="oddrow"> <div class="var-header"> <span class="var-title"> <span class="var-type">Array</span> <span class="var-name">$_optionsPlain</span> = <span class="var-default">array("type" => PLAIN_TEXT, <br /> "spacer" => "", <br /> "lf" => "\n",<br /> "structOpen" => "",<br /> "structClose" => "",<br /> "specialOpen" => "",<br /> "specialClose" => "",<br /> "useErrorHandler" => false,<br /> "echoResult" => false,<br /> "returnResult" => true,<br /> "convertHtml" => true,<br /> "convertSpecial" => true,<br /> "dumpObjectFunctions" => true,<br /> "dumpObjectVars" => true,<br /> "dumpObjectInheritance" => true<br /> )</span> (line <span class="line-number">107</span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">options for plain text</p> <ul class="tags"> <li><span class="field">access:</span> private</li> </ul> </div> <a name="var$_start" id="$_start"><!-- --></A> <div class="evenrow"> <div class="var-header"> <span class="var-title"> <span class="var-type">String</span> <span class="var-name">$_start</span> (line <span class="line-number">139</span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">start time array</p> <ul class="tags"> <li><span class="field">access:</span> private</li> </ul> </div> <a name="var$_stop" id="$_stop"><!-- --></A> <div class="oddrow"> <div class="var-header"> <span class="var-title"> <span class="var-type">String</span> <span class="var-name">$_stop</span> (line <span class="line-number">146</span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">stop time array</p> <ul class="tags"> <li><span class="field">access:</span> private</li> </ul> </div> </div> </div> <a name="sec-methods"></a> <div class="info-box"> <div class="info-box-title">Methods</div> <div class="nav-bar"> <a href="#sec-description">Description</a> | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) </div> <div class="info-box-body"> <A NAME='method_detail'></A> <a name="methoddebugHelper" id="debugHelper"><!-- --></a> <div class="evenrow"> <div class="method-header"> <span class="method-title">Constructor debugHelper</span> (line <span class="line-number">187</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Constructor</p> <p class="description"><p>Defines which type of output is wanted. You can add your own options in an array</p></p> <ul class="tags"> <li><span class="field">access:</span> public</li> </ul> <div class="method-signature"> <span class="method-result">debugHelper</span> <span class="method-name"> debugHelper </span> ([<span class="var-type">Integer</span> <span class="var-name">$outputType</span> = <span class="var-default">HTML</span>], [<span class="var-type">Array</span> <span class="var-name">$options</span> = <span class="var-default">null</span>]) </div> <ul class="parameters"> <li> <span class="var-type">Integer</span> <span class="var-name">$outputType</span> </li> <li> <span class="var-type">Array</span> <span class="var-name">$options</span><span class="var-description">: <p></p><p>array( "type" => one of the constants "spacer" => spacing for one depth level "lf" => linefeed character "structOpen" => opening tags for arrays or objects "structClose" => closing tags for arrays or objects "specialOpen" => opening tags for lf, tab, newline "specialClose" => closing tags for lf, tab, newline "useErrorHandler" => true, if the internal error handler be called "echoResult" => true, if the result of dump() should be echoed "returnResult" => true, if the result of dump() should be returned "convertHtml" => true, if the special html chars should be converted "convertSpecial" => true, if the /n, /t should be converted "dumpObjectFunctions" => true, if the obj. functions should be displayed "dumpObjectVars" => true, if the obj. vars should be displayed "dumpObjectInheritance" => true, if the obj. inheritance should be displayed );</p></span> </li> </ul> </div> <a name="methoddump" id="dump"><!-- --></a> <div class="oddrow"> <div class="method-header"> <span class="method-title">dump</span> (line <span class="line-number">242</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Dumps content of a variable</p> <p class="description"><p>Is able to dump all numeric values, Strings, Arrays, Objects and Resource Types</p></p> <ul class="tags"> <li><span class="field">access:</span> public</li> </ul> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> dump </span> (<span class="var-type">mixed</span> <span class="var-name">$thing</span>, [<span class="var-type">mixed</span> <span class="var-name">$options</span> = <span class="var-default">null</span>], <span class="var-type">Integer</span> <span class="var-name">$column</span>) </div> <ul class="parameters"> <li> <span class="var-type">mixed</span> <span class="var-name">$thing</span><span class="var-description">: the variable</span> </li> <li> <span class="var-type">Integer</span> <span class="var-name">$column</span><span class="var-description">: current depth</span> </li> </ul> </div> <a name="methodgetOptions" id="getOptions"><!-- --></a> <div class="evenrow"> <div class="method-header"> <span class="method-title">getOptions</span> (line <span class="line-number">470</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Returns the options for a certain type</p> <p class="description"><p>Returns the type options plus additonal ones, you provided</p></p> <ul class="tags"> <li><span class="field">access:</span> public</li> </ul> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> getOptions </span> (<span class="var-type">Integer</span> <span class="var-name">$type</span>, [<span class="var-type">Integer</span> <span class="var-name">$additionalOptions</span> = <span class="var-default">null</span>]) </div> <ul class="parameters"> <li> <span class="var-type">Integer</span> <span class="var-name">$type</span><span class="var-description">: the option type</span> </li> <li> <span class="var-type">Integer</span> <span class="var-name">$additionalOptions</span><span class="var-description">: to override options</span> </li> </ul> </div> <a name="methodgetTime" id="getTime"><!-- --></a> <div class="oddrow"> <div class="method-header"> <span class="method-title">getTime</span> (line <span class="line-number">397</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Returns the current time</p> <p class="description"><p>Returns the current time or 0, if id does not exist.</p></p> <ul class="tags"> <li><span class="field">return:</span> current time</li> <li><span class="field">access:</span> public</li> </ul> <div class="method-signature"> <span class="method-result">Integer</span> <span class="method-name"> getTime </span> ([<span class="var-type">String</span> <span class="var-name">$id</span> = <span class="var-default">'default'</span>]) </div> <ul class="parameters"> <li> <span class="var-type">String</span> <span class="var-name">$id</span><span class="var-description">: timer id</span> </li> </ul> </div> <a name="methodhighlightFile" id="highlightFile"><!-- --></a> <div class="evenrow"> <div class="method-header"> <span class="method-title">highlightFile</span> (line <span class="line-number">419</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Highlights a file</p> <p class="description"><p>Highlights the file source and adds line numbers</p></p> <ul class="tags"> <li><span class="field">access:</span> public</li> </ul> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> highlightFile </span> (<span class="var-type">String</span> <span class="var-name">$file</span>, [<span class="var-type">mixed</span> <span class="var-name">$from</span> = <span class="var-default">1</span>], [<span class="var-type">mixed</span> <span class="var-name">$count</span> = <span class="var-default">EOF</span>]) </div> <ul class="parameters"> <li> <span class="var-type">String</span> <span class="var-name">$file</span> </li> </ul> </div> <a name="methodmessage" id="message"><!-- --></a> <div class="oddrow"> <div class="method-header"> <span class="method-title">message</span> (line <span class="line-number">221</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Echos a message</p> <p class="description"><p>Good for checking if a certain part of your source code is accessed</p></p> <ul class="tags"> <li><span class="field">access:</span> public</li> </ul> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> message </span> ([<span class="var-type">mixed</span> <span class="var-name">$string</span> = <span class="var-default">'MESSAGE !!'</span>], [<span class="var-type">Integer</span> <span class="var-name">$options</span> = <span class="var-default">null</span>]) </div> <ul class="parameters"> <li> <span class="var-type">mixed</span> <span class="var-name">$string</span><span class="var-description">: text to de echoed</span> </li> <li> <span class="var-type">Integer</span> <span class="var-name">$options</span><span class="var-description">: current options</span> </li> </ul> </div> <a name="methodstartTimer" id="startTimer"><!-- --></a> <div class="evenrow"> <div class="method-header"> <span class="method-title">startTimer</span> (line <span class="line-number">363</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Starts timing</p> <p class="description"><p>A unique id an be given for several timings.</p></p> <ul class="tags"> <li><span class="field">access:</span> public</li> </ul> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> startTimer </span> ([<span class="var-type">String</span> <span class="var-name">$id</span> = <span class="var-default">'default'</span>]) </div> <ul class="parameters"> <li> <span class="var-type">String</span> <span class="var-name">$id</span><span class="var-description">: timer id</span> </li> </ul> </div> <a name="methodstopTimer" id="stopTimer"><!-- --></a> <div class="oddrow"> <div class="method-header"> <span class="method-title">stopTimer</span> (line <span class="line-number">380</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Stops timing</p> <p class="description"><p>Stops timing and returns current value.</p></p> <ul class="tags"> <li><span class="field">return:</span> current time</li> <li><span class="field">access:</span> public</li> </ul> <div class="method-signature"> <span class="method-result">Integer</span> <span class="method-name"> stopTimer </span> ([<span class="var-type">String</span> <span class="var-name">$id</span> = <span class="var-default">'default'</span>]) </div> <ul class="parameters"> <li> <span class="var-type">String</span> <span class="var-name">$id</span><span class="var-description">: timer id</span> </li> </ul> </div> <a name="methodswitchForType" id="switchForType"><!-- --></a> <div class="evenrow"> <div class="method-header"> <span class="method-title">switchForType</span> (line <span class="line-number">312</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Calls function according to the variable type</p> <p class="description"><p>Basically works like dump() but can call user defined functions</p></p> <ul class="tags"> <li><span class="field">access:</span> public</li> </ul> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> switchForType </span> (<span class="var-type">mixed</span> <span class="var-name">$thing</span>, <span class="var-type">Array</span> <span class="var-name">$functions</span>, [<span class="var-type">Array</span> <span class="var-name">$options</span> = <span class="var-default">null</span>]) </div> <ul class="parameters"> <li> <span class="var-type">mixed</span> <span class="var-name">$thing</span><span class="var-description">: the variable</span> </li> <li> <span class="var-type">Array</span> <span class="var-name">$functions</span><span class="var-description">: <p>function array array( "object" => "_dumpObject", "array" => "_dumpArray", "integer" => "_dumpInteger", "float" => "_dumpFloat", "double" => "_dumpDouble", "long" => "_dumpLong", "string" => "_dumpString", "bool" => "_dumpBoolean", "resource" => "_dumpResource", "null" => "_dumpNull", "unknown" => "_dumpUnknown", "i_am_done" => "_dumpComplete" );</p><p></p></span> </li> <li> <span class="var-type">Array</span> <span class="var-name">$options</span><span class="var-description">: array with params</span> </li> </ul> </div> <a name="methodtoTable" id="toTable"><!-- --></a> <div class="oddrow"> <div class="method-header"> <span class="method-title">toTable</span> (line <span class="line-number">504</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Converts an array to html table data</p> <p class="description"><p>Returns html data for a given 1 or 2 dimensional array</p></p> <ul class="tags"> <li><span class="field">access:</span> public</li> </ul> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> toTable </span> (<span class="var-type">Array</span> <span class="var-name">$array</span>, [<span class="var-type">header</span> <span class="var-name">$header</span> = <span class="var-default">null</span>], [<span class="var-type">Boolean</span> <span class="var-name">$horizontal</span> = <span class="var-default">true</span>], [<span class="var-type">String</span> <span class="var-name">$tagAddon</span> = <span class="var-default">'border=1'</span>]) </div> <ul class="parameters"> <li> <span class="var-type">Array</span> <span class="var-name">$array</span><span class="var-description">: array</span> </li> <li> <span class="var-type">header</span> <span class="var-name">$header</span><span class="var-description">: optional header</span> </li> <li> <span class="var-type">Boolean</span> <span class="var-name">$horizontal</span><span class="var-description">: horizontal or vertical ordering</span> </li> <li> <span class="var-type">String</span> <span class="var-name">$tagAddon</span><span class="var-description">: additional data for the table tag</span> </li> </ul> </div> <a name="method_calculateTime" id="_calculateTime"><!-- --></a> <div class="evenrow"> <div class="method-header"> <span class="method-title">_calculateTime</span> (line <span class="line-number">540</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Calculates the time from an timer id</p> <p class="description"><p>Called by stopTimer() and getTime()</p></p> <ul class="tags"> <li><span class="field">return:</span> amount of time</li> <li><span class="field">access:</span> private</li> </ul> <div class="method-signature"> <span class="method-result">Integer</span> <span class="method-name"> _calculateTime </span> (<span class="var-type">Integer</span> <span class="var-name">$time</span>, <span class="var-type">String</span> <span class="var-name">$id</span>) </div> <ul class="parameters"> <li> <span class="var-type">Integer</span> <span class="var-name">$time</span><span class="var-description">: end time</span> </li> <li> <span class="var-type">String</span> <span class="var-name">$id</span><span class="var-description">: timer id for the start time</span> </li> </ul> </div> <a name="method_callFunction" id="_callFunction"><!-- --></a> <div class="oddrow"> <div class="method-header"> <span class="method-title">_callFunction</span> (line <span class="line-number">810</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Calls the function with given parameters</p> <p class="description"><p>Calls functions inside or outside the class</p></p> <ul class="tags"> <li><span class="field">access:</span> private</li> </ul> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> _callFunction </span> (<span class="var-type">String</span> <span class="var-name">$functionName</span>, [<span class="var-type">Boolean</span> <span class="var-name">$abortAmbiguous</span> = <span class="var-default">false</span>]) </div> <ul class="parameters"> <li> <span class="var-type">String</span> <span class="var-name">$functionName</span> </li> <li> <span class="var-type">Boolean</span> <span class="var-name">$abortAmbiguous</span> </li> </ul> </div> <a name="method_dumpArray" id="_dumpArray"><!-- --></a> <div class="evenrow"> <div class="method-header"> <span class="method-title">_dumpArray</span> (line <span class="line-number">585</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Dumps an array</p> <p class="description"><p>Is called by the dump() method.</p></p> <ul class="tags"> <li><span class="field">access:</span> private</li> </ul> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> _dumpArray </span> (<span class="var-type">Array</span> <span class="var-name">$array</span>, <span class="var-type">Array</span> <span class="var-name">$options</span>) </div> <ul class="parameters"> <li> <span class="var-type">Array</span> <span class="var-name">$array</span><span class="var-description">: the array</span> </li> <li> <span class="var-type">Array</span> <span class="var-name">$options</span><span class="var-description">: display options</span> </li> </ul> </div> <a name="method_dumpBoolean" id="_dumpBoolean"><!-- --></a> <div class="oddrow"> <div class="method-header"> <span class="method-title">_dumpBoolean</span> (line <span class="line-number">724</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Dumps a boolean</p> <p class="description"><p>Is called by the dump() method.</p></p> <ul class="tags"> <li><span class="field">access:</span> private</li> </ul> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> _dumpBoolean </span> (<span class="var-type">Boolean</span> <span class="var-name">$thing</span>) </div> <ul class="parameters"> <li> <span class="var-type">Boolean</span> <span class="var-name">$thing</span> </li> </ul> </div> <a name="method_dumpComplete" id="_dumpComplete"><!-- --></a> <div class="evenrow"> <div class="method-header"> <span class="method-title">_dumpComplete</span> (line <span class="line-number">784</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Is called when the dump is complete</p> <p class="description"><p>Is called by the dump() method.</p></p> <ul class="tags"> <li><span class="field">access:</span> private</li> </ul> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> _dumpComplete </span> (<span class="var-type">String</span> <span class="var-name">$res</span>, <span class="var-type">Array</span> <span class="var-name">$options</span>) </div> <ul class="parameters"> <li> <span class="var-type">String</span> <span class="var-name">$res</span> </li> <li> <span class="var-type">Array</span> <span class="var-name">$options</span> </li> </ul> </div> <a name="method_dumpDouble" id="_dumpDouble"><!-- --></a> <div class="oddrow"> <div class="method-header"> <span class="method-title">_dumpDouble</span> (line <span class="line-number">694</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Dumps a double</p> <p class="description"><p>Is called by the dump() method.</p></p> <ul class="tags"> <li><span class="field">access:</span> private</li> </ul> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> _dumpDouble </span> (<span class="var-type">Double</span> <span class="var-name">$thing</span>) </div> <ul class="parameters"> <li> <span class="var-type">Double</span> <span class="var-name">$thing</span> </li> </ul> </div> <a name="method_dumpFloat" id="_dumpFloat"><!-- --></a> <div class="evenrow"> <div class="method-header"> <span class="method-title">_dumpFloat</span> (line <span class="line-number">679</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Dumps a float</p> <p class="description"><p>Is called by the dump() method.</p></p> <ul class="tags"> <li><span class="field">access:</span> private</li> </ul> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> _dumpFloat </span> (<span class="var-type">Float</span> <span class="var-name">$thing</span>) </div> <ul class="parameters"> <li> <span class="var-type">Float</span> <span class="var-name">$thing</span> </li> </ul> </div> <a name="method_dumpInteger" id="_dumpInteger"><!-- --></a> <div class="oddrow"> <div class="method-header"> <span class="method-title">_dumpInteger</span> (line <span class="line-number">664</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Dumps an integer</p> <p class="description"><p>Is called by the dump() method.</p></p> <ul class="tags"> <li><span class="field">access:</span> private</li> </ul> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> _dumpInteger </span> (<span class="var-type">Integer</span> <span class="var-name">$thing</span>) </div> <ul class="parameters"> <li> <span class="var-type">Integer</span> <span class="var-name">$thing</span> </li> </ul> </div> <a name="method_dumpLong" id="_dumpLong"><!-- --></a> <div class="evenrow"> <div class="method-header"> <span class="method-title">_dumpLong</span> (line <span class="line-number">709</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Dumps a long</p> <p class="description"><p>Is called by the dump() method.</p></p> <ul class="tags"> <li><span class="field">access:</span> private</li> </ul> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> _dumpLong </span> (<span class="var-type">Long</span> <span class="var-name">$thing</span>) </div> <ul class="parameters"> <li> <span class="var-type">Long</span> <span class="var-name">$thing</span> </li> </ul> </div> <a name="method_dumpNull" id="_dumpNull"><!-- --></a> <div class="oddrow"> <div class="method-header"> <span class="method-title">_dumpNull</span> (line <span class="line-number">753</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Dumps null</p> <p class="description"><p>Is called by the dump() method.</p></p> <ul class="tags"> <li><span class="field">access:</span> private</li> </ul> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> _dumpNull </span> (<span class="var-type">mixed</span> <span class="var-name">$thing</span>) </div> <ul class="parameters"> <li> <span class="var-type">mixed</span> <span class="var-name">$thing</span> </li> </ul> </div> <a name="method_dumpObject" id="_dumpObject"><!-- --></a> <div class="evenrow"> <div class="method-header"> <span class="method-title">_dumpObject</span> (line <span class="line-number">612</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Dumps an object</p> <p class="description"><p>Is called by the dump() method.</p></p> <ul class="tags"> <li><span class="field">access:</span> private</li> </ul> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> _dumpObject </span> (<span class="var-type">Object</span> <span class="var-name">$object</span>, <span class="var-type">Integer</span> <span class="var-name">$options</span>) </div> <ul class="parameters"> <li> <span class="var-type">Object</span> <span class="var-name">$object</span><span class="var-description">: the object</span> </li> <li> <span class="var-type">Integer</span> <span class="var-name">$options</span><span class="var-description">: display options</span> </li> </ul> </div> <a name="method_dumpResource" id="_dumpResource"><!-- --></a> <div class="oddrow"> <div class="method-header"> <span class="method-title">_dumpResource</span> (line <span class="line-number">738</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Dumps an Resource</p> <p class="description"><p>Is called by the dump() method.</p></p> <ul class="tags"> <li><span class="field">access:</span> private</li> </ul> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> _dumpResource </span> (<span class="var-type">Resource</span> <span class="var-name">$thing</span>) </div> <ul class="parameters"> <li> <span class="var-type">Resource</span> <span class="var-name">$thing</span> </li> </ul> </div> <a name="method_dumpString" id="_dumpString"><!-- --></a> <div class="evenrow"> <div class="method-header"> <span class="method-title">_dumpString</span> (line <span class="line-number">558</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Dumps a string</p> <p class="description"><p>Is called by the dump() method.</p></p> <ul class="tags"> <li><span class="field">access:</span> private</li> </ul> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> _dumpString </span> (<span class="var-type">String</span> <span class="var-name">$str</span>, <span class="var-type">Array</span> <span class="var-name">$options</span>) </div> <ul class="parameters"> <li> <span class="var-type">String</span> <span class="var-name">$str</span> </li> <li> <span class="var-type">Array</span> <span class="var-name">$options</span><span class="var-description">: display options</span> </li> </ul> </div> <a name="method_dumpUnknown" id="_dumpUnknown"><!-- --></a> <div class="oddrow"> <div class="method-header"> <span class="method-title">_dumpUnknown</span> (line <span class="line-number">768</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Dumps unknown</p> <p class="description"><p>Is called by the dump() method.</p></p> <ul class="tags"> <li><span class="field">access:</span> private</li> </ul> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> _dumpUnknown </span> (<span class="var-type">mixed</span> <span class="var-name">$thing</span>) </div> <ul class="parameters"> <li> <span class="var-type">mixed</span> <span class="var-name">$thing</span> </li> </ul> </div> <a name="method_onedimhor" id="_onedimhor"><!-- --></a> <div class="evenrow"> <div class="method-header"> <span class="method-title">_onedimhor</span> (line <span class="line-number">877</span>) </div> <!-- ========== Info from phpDoc block ========= --> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> _onedimhor </span> (<span class="var-type">mixed</span> <span class="var-name">&$array</span>, <span class="var-type">mixed</span> <span class="var-name">&$header</span>) </div> </div> <a name="method_onedimver" id="_onedimver"><!-- --></a> <div class="oddrow"> <div class="method-header"> <span class="method-title">_onedimver</span> (line <span class="line-number">895</span>) </div> <!-- ========== Info from phpDoc block ========= --> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> _onedimver </span> (<span class="var-type">mixed</span> <span class="var-name">&$array</span>, <span class="var-type">mixed</span> <span class="var-name">&$header</span>) </div> </div> <a name="method_twodimhor" id="_twodimhor"><!-- --></a> <div class="evenrow"> <div class="method-header"> <span class="method-title">_twodimhor</span> (line <span class="line-number">839</span>) </div> <!-- ========== Info from phpDoc block ========= --> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> _twodimhor </span> (<span class="var-type">mixed</span> <span class="var-name">&$array</span>, <span class="var-type">mixed</span> <span class="var-name">&$headerArray</span>) </div> </div> <a name="method_twodimver" id="_twodimver"><!-- --></a> <div class="oddrow"> <div class="method-header"> <span class="method-title">_twodimver</span> (line <span class="line-number">858</span>) </div> <!-- ========== Info from phpDoc block ========= --> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> _twodimver </span> (<span class="var-type">mixed</span> <span class="var-name">&$array</span>, <span class="var-type">mixed</span> <span class="var-name">&$headerArray</span>) </div> </div> </div> </div> <p class="notes" id="credit"> Documention generated on Mon, 7 Jul 2003 22:40:54 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.1</a> </p> </div></body> </html>