diff options
Diffstat (limited to 'doc/html/classdba.html')
| -rw-r--r-- | doc/html/classdba.html | 363 |
1 files changed, 363 insertions, 0 deletions
diff --git a/doc/html/classdba.html b/doc/html/classdba.html new file mode 100644 index 000000000..dcb6e4b3c --- /dev/null +++ b/doc/html/classdba.html @@ -0,0 +1,363 @@ +<!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> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.3.1"/> +<title>The Red Project: dba Class Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); + $(window).load(resizeHeight); +</script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td id="projectlogo"><img alt="Logo" src="r!-64.png"/></td> + <td style="padding-left: 0.5em;"> + <div id="projectname">The Red Project + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.3.1 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="pages.html"><span>Related Pages</span></a></li> + <li><a href="namespaces.html"><span>Namespaces</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </span> + </div> + </li> + </ul> + </div> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="classes.html"><span>Class Index</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +$(document).ready(function(){initNavTree('classdba.html','');}); +</script> +<div id="doc-content"> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Pages</a></div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="#pub-attribs">Public Attributes</a> | +<a href="#pri-attribs">Private Attributes</a> | +<a href="classdba-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">dba Class Reference</div> </div> +</div><!--header--> +<div class="contents"> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> +Public Member Functions</h2></td></tr> +<tr class="memitem:aa36df91d776eedd1b90b9518a610d9fb"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdba.html#aa36df91d776eedd1b90b9518a610d9fb">__construct</a> ($server, $user, $pass, $db, $install=false)</td></tr> +<tr class="separator:aa36df91d776eedd1b90b9518a610d9fb"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a066ce6eab1282c9220ac4652ac2dbd27"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdba.html#a066ce6eab1282c9220ac4652ac2dbd27">getdb</a> ()</td></tr> +<tr class="separator:a066ce6eab1282c9220ac4652ac2dbd27"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0060c8611e3c3ee71049904ad028a695"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdba.html#a0060c8611e3c3ee71049904ad028a695">q</a> ($sql)</td></tr> +<tr class="separator:a0060c8611e3c3ee71049904ad028a695"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2c6fecf396c66e07f00276fc18d31ca7"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdba.html#a2c6fecf396c66e07f00276fc18d31ca7">dbg</a> ($dbg)</td></tr> +<tr class="separator:a2c6fecf396c66e07f00276fc18d31ca7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a522329687ff042074c1cbc8bd3226d2f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdba.html#a522329687ff042074c1cbc8bd3226d2f">escape</a> ($str)</td></tr> +<tr class="separator:a522329687ff042074c1cbc8bd3226d2f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac25853e4d454aec9cfead4814429550d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdba.html#ac25853e4d454aec9cfead4814429550d">__destruct</a> ()</td></tr> +<tr class="separator:ac25853e4d454aec9cfead4814429550d"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> +Public Attributes</h2></td></tr> +<tr class="memitem:ab5dcbd758d3f8fb84702c323cd85067e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdba.html#ab5dcbd758d3f8fb84702c323cd85067e">$mysqli</a> = true</td></tr> +<tr class="separator:ab5dcbd758d3f8fb84702c323cd85067e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a986eb5c3bbd4c70801a9ddd2f8e5c561"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdba.html#a986eb5c3bbd4c70801a9ddd2f8e5c561">$connected</a> = false</td></tr> +<tr class="separator:a986eb5c3bbd4c70801a9ddd2f8e5c561"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a6a1471c18c6530044d20db5d3532958b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdba.html#a6a1471c18c6530044d20db5d3532958b">$error</a> = false</td></tr> +<tr class="separator:a6a1471c18c6530044d20db5d3532958b"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a> +Private Attributes</h2></td></tr> +<tr class="memitem:a4da56b3eb82ad26ba49ca5f97e1490cb"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdba.html#a4da56b3eb82ad26ba49ca5f97e1490cb">$debug</a> = 0</td></tr> +<tr class="separator:a4da56b3eb82ad26ba49ca5f97e1490cb"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab57b3a4399f22ce5cdafbd3cd542a414"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdba.html#ab57b3a4399f22ce5cdafbd3cd542a414">$db</a></td></tr> +<tr class="separator:ab57b3a4399f22ce5cdafbd3cd542a414"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>MySQL database class</p> +<p>For debugging, insert 'dbg(1);' anywhere in the program flow. dbg(0); will turn it off. Logging is performed at LOGGER_DATA level. When logging, all binary info is converted to text and html entities are escaped so that the debugging stream is safe to view within both terminals and web pages. </p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a class="anchor" id="aa36df91d776eedd1b90b9518a610d9fb"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">dba::__construct </td> + <td>(</td> + <td class="paramtype"> </td> + <td class="paramname"><em>$server</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"><em>$user</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"><em>$pass</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"><em>$db</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"><em>$install</em> = <code>false</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="ac25853e4d454aec9cfead4814429550d"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">dba::__destruct </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a class="anchor" id="a2c6fecf396c66e07f00276fc18d31ca7"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">dba::dbg </td> + <td>(</td> + <td class="paramtype"> </td> + <td class="paramname"><em>$dbg</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="a522329687ff042074c1cbc8bd3226d2f"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">dba::escape </td> + <td>(</td> + <td class="paramtype"> </td> + <td class="paramname"><em>$str</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="a066ce6eab1282c9220ac4652ac2dbd27"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">dba::getdb </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="a0060c8611e3c3ee71049904ad028a695"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">dba::q </td> + <td>(</td> + <td class="paramtype"> </td> + <td class="paramname"><em>$sql</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>If dbfail.out exists, we will write any failed calls directly to it, regardless of any logging that may or may nor be in effect. These usually indicate SQL syntax errors that need to be resolved.</p> + +</div> +</div> +<h2 class="groupheader">Member Data Documentation</h2> +<a class="anchor" id="a986eb5c3bbd4c70801a9ddd2f8e5c561"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">dba::$connected = false</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="ab57b3a4399f22ce5cdafbd3cd542a414"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">dba::$db</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">private</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Referenced by <a class="el" href="classdba.html#aa36df91d776eedd1b90b9518a610d9fb">__construct()</a>, and <a class="el" href="classdba.html#a066ce6eab1282c9220ac4652ac2dbd27">getdb()</a>.</p> + +</div> +</div> +<a class="anchor" id="a4da56b3eb82ad26ba49ca5f97e1490cb"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">dba::$debug = 0</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">private</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="a6a1471c18c6530044d20db5d3532958b"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">dba::$error = false</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Referenced by <a class="el" href="classdba.html#a0060c8611e3c3ee71049904ad028a695">q()</a>.</p> + +</div> +</div> +<a class="anchor" id="ab5dcbd758d3f8fb84702c323cd85067e"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">dba::$mysqli = true</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>include/<a class="el" href="dba_8php.html">dba.php</a></li> +</ul> +</div><!-- contents --> +</div><!-- doc-content --> + |