diff options
Diffstat (limited to 'doc/html/classdba__driver.html')
| -rw-r--r-- | doc/html/classdba__driver.html | 260 |
1 files changed, 256 insertions, 4 deletions
diff --git a/doc/html/classdba__driver.html b/doc/html/classdba__driver.html index e70d8bf1f..33b6d16db 100644 --- a/doc/html/classdba__driver.html +++ b/doc/html/classdba__driver.html @@ -114,38 +114,69 @@ $(document).ready(function(){initNavTree('classdba__driver.html','');}); <div class="title">dba_driver Class Reference</div> </div> </div><!--header--> <div class="contents"> + +<p>abstract database driver class. + <a href="classdba__driver.html#details">More...</a></p> <div class="dynheader"> Inheritance diagram for dba_driver:</div> <div class="dyncontent"> <div class="center"> <img src="classdba__driver.png" usemap="#dba_driver_map" alt=""/> <map id="dba_driver_map" name="dba_driver_map"> -<area href="classdba__mysql.html" alt="dba_mysql" shape="rect" coords="0,56,74,80"/> -<area href="classdba__mysqli.html" alt="dba_mysqli" shape="rect" coords="84,56,158,80"/> +<area href="classdba__mysql.html" alt="dba_mysql" shape="rect" coords="0,56,88,80"/> +<area href="classdba__mysqli.html" alt="dba_mysqli" shape="rect" coords="98,56,186,80"/> +<area href="classdba__postgres.html" alt="dba_postgres" shape="rect" coords="196,56,284,80"/> </map> </div></div> <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:ae533e62a240a793f17aef5ab4ef10edc"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdba__driver.html#ae533e62a240a793f17aef5ab4ef10edc">connect</a> ($server, $port, $user, $pass, $db)</td></tr> +<tr class="memdesc:ae533e62a240a793f17aef5ab4ef10edc"><td class="mdescLeft"> </td><td class="mdescRight">Connect to the database. <a href="#ae533e62a240a793f17aef5ab4ef10edc">More...</a><br/></td></tr> <tr class="separator:ae533e62a240a793f17aef5ab4ef10edc"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a558e738b88ae893cc5d79ffa3793d555"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdba__driver.html#a558e738b88ae893cc5d79ffa3793d555">q</a> ($sql)</td></tr> +<tr class="memdesc:a558e738b88ae893cc5d79ffa3793d555"><td class="mdescLeft"> </td><td class="mdescRight">Perform a DB query with the SQL statement $sql. <a href="#a558e738b88ae893cc5d79ffa3793d555">More...</a><br/></td></tr> <tr class="separator:a558e738b88ae893cc5d79ffa3793d555"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:afc95ffa103a3290581b537670cde5311"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdba__driver.html#afc95ffa103a3290581b537670cde5311">escape</a> ($str)</td></tr> +<tr class="memdesc:afc95ffa103a3290581b537670cde5311"><td class="mdescLeft"> </td><td class="mdescRight">Escape a string before being passed to a DB query. <a href="#afc95ffa103a3290581b537670cde5311">More...</a><br/></td></tr> <tr class="separator:afc95ffa103a3290581b537670cde5311"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5afa54172f3c837df61643f8f5b2c975"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdba__driver.html#a5afa54172f3c837df61643f8f5b2c975">close</a> ()</td></tr> +<tr class="memdesc:a5afa54172f3c837df61643f8f5b2c975"><td class="mdescLeft"> </td><td class="mdescRight">Close the database connection. <a href="#a5afa54172f3c837df61643f8f5b2c975">More...</a><br/></td></tr> <tr class="separator:a5afa54172f3c837df61643f8f5b2c975"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af3541d13ccb7a3eddfc03e253c746186"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdba__driver.html#af3541d13ccb7a3eddfc03e253c746186">__construct</a> ($server, $port, $user, $pass, $db, $<a class="el" href="classdba__driver.html#a4ccb27243e62a8ca30dd8e1b8cc67746">install</a>=false)</td></tr> <tr class="separator:af3541d13ccb7a3eddfc03e253c746186"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a65a5c7b355ab5529a43049e160006426"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdba__driver.html#a65a5c7b355ab5529a43049e160006426">get_null_date</a> ()</td></tr> +<tr class="separator:a65a5c7b355ab5529a43049e160006426"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a8d6a79d39d7eaee5aea4e952c4529d48"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdba__driver.html#a8d6a79d39d7eaee5aea4e952c4529d48">get_install_script</a> ()</td></tr> +<tr class="separator:a8d6a79d39d7eaee5aea4e952c4529d48"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad700712879719bee23752b8f424d97d0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdba__driver.html#ad700712879719bee23752b8f424d97d0">utcnow</a> ()</td></tr> +<tr class="separator:ad700712879719bee23752b8f424d97d0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a4ccb27243e62a8ca30dd8e1b8cc67746"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdba__driver.html#a4ccb27243e62a8ca30dd8e1b8cc67746">install</a> ($server, $user, $pass, $db)</td></tr> <tr class="separator:a4ccb27243e62a8ca30dd8e1b8cc67746"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:adcc1f8955120fec0708bce39202d0422"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdba__driver.html#adcc1f8955120fec0708bce39202d0422">dbg</a> ($dbg)</td></tr> +<tr class="memdesc:adcc1f8955120fec0708bce39202d0422"><td class="mdescLeft"> </td><td class="mdescRight">Sets the database driver's debugging state. <a href="#adcc1f8955120fec0708bce39202d0422">More...</a><br/></td></tr> <tr class="separator:adcc1f8955120fec0708bce39202d0422"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1a8bc9dc839a6320a0e07d8047a6b721"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdba__driver.html#a1a8bc9dc839a6320a0e07d8047a6b721">__destruct</a> ()</td></tr> <tr class="separator:a1a8bc9dc839a6320a0e07d8047a6b721"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac9127e9c55fcc93bcfbb323b9b99b9d9"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdba__driver.html#ac9127e9c55fcc93bcfbb323b9b99b9d9">quote_interval</a> ($txt)</td></tr> +<tr class="separator:ac9127e9c55fcc93bcfbb323b9b99b9d9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a77e59dcbeab30ca6000131d2e9ad4092"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdba__driver.html#a77e59dcbeab30ca6000131d2e9ad4092">optimize_table</a> ($table)</td></tr> +<tr class="separator:a77e59dcbeab30ca6000131d2e9ad4092"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab9982f38a02f008b127a0f3ccc1e99f4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdba__driver.html#ab9982f38a02f008b127a0f3ccc1e99f4">concat</a> ($fld, $sep)</td></tr> +<tr class="separator:ab9982f38a02f008b127a0f3ccc1e99f4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7dbe8318587ff1694825042bf58f4fbd"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdba__driver.html#a7dbe8318587ff1694825042bf58f4fbd">escapebin</a> ($str)</td></tr> +<tr class="separator:a7dbe8318587ff1694825042bf58f4fbd"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab43184239e1d6eb00a98319f4a3df155"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdba__driver.html#ab43184239e1d6eb00a98319f4a3df155">unescapebin</a> ($str)</td></tr> +<tr class="separator:ab43184239e1d6eb00a98319f4a3df155"><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:a98d8523dcedda316085b4d4f856b6583"><td class="memItemLeft" align="right" valign="top">const </td><td class="memItemRight" valign="bottom"><a class="el" href="classdba__driver.html#a98d8523dcedda316085b4d4f856b6583">INSTALL_SCRIPT</a> ='<a class="el" href="classdba__driver.html#a4ccb27243e62a8ca30dd8e1b8cc67746">install</a>/schema_mysql.sql'</td></tr> +<tr class="separator:a98d8523dcedda316085b4d4f856b6583"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:afce39394c010ea589d99a21579b2c31e"><td class="memItemLeft" align="right" valign="top">const </td><td class="memItemRight" valign="bottom"><a class="el" href="classdba__driver.html#afce39394c010ea589d99a21579b2c31e">NULL_DATE</a> = '0000-00-00 00:00:00'</td></tr> +<tr class="separator:afce39394c010ea589d99a21579b2c31e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa3325d982d4ee5d1114fd7e02a4356e8"><td class="memItemLeft" align="right" valign="top">const </td><td class="memItemRight" valign="bottom"><a class="el" href="classdba__driver.html#aa3325d982d4ee5d1114fd7e02a4356e8">UTC_NOW</a> = 'UTC_TIMESTAMP()'</td></tr> +<tr class="separator:aa3325d982d4ee5d1114fd7e02a4356e8"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a205f6535e399700b6fca2492f96f2229"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdba__driver.html#a205f6535e399700b6fca2492f96f2229">$connected</a> = false</td></tr> <tr class="separator:a205f6535e399700b6fca2492f96f2229"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a84675d28c7bd9b7290dd37e66dbd216c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdba__driver.html#a84675d28c7bd9b7290dd37e66dbd216c">$error</a> = false</td></tr> @@ -158,7 +189,10 @@ Protected Attributes</h2></td></tr> <tr class="memitem:a3033b5f1c2716b52202faeaae2592fe6"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdba__driver.html#a3033b5f1c2716b52202faeaae2592fe6">$db</a></td></tr> <tr class="separator:a3033b5f1c2716b52202faeaae2592fe6"><td class="memSeparator" colspan="2"> </td></tr> </table> -<h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>abstract database driver class. </p> +<p>This class gets extended by the real database driver classes, e.g. <a class="el" href="classdba__mysql.html">dba_mysql</a>, <a class="el" href="classdba__mysqli.html">dba_mysqli</a>. </p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a class="anchor" id="af3541d13ccb7a3eddfc03e253c746186"></a> <div class="memitem"> <div class="memproto"> @@ -246,10 +280,39 @@ Protected Attributes</h2></td></tr> </table> </div><div class="memdoc"> +<p>Close the database connection. </p> +<p>This abstract function needs to be implemented in the real driver. </p> + <p>Referenced by <a class="el" href="classdba__driver.html#a1a8bc9dc839a6320a0e07d8047a6b721">__destruct()</a>.</p> </div> </div> +<a class="anchor" id="ab9982f38a02f008b127a0f3ccc1e99f4"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">dba_driver::concat </td> + <td>(</td> + <td class="paramtype"> </td> + <td class="paramname"><em>$fld</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"><em>$sep</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> <a class="anchor" id="ae533e62a240a793f17aef5ab4ef10edc"></a> <div class="memitem"> <div class="memproto"> @@ -300,6 +363,20 @@ Protected Attributes</h2></td></tr> </table> </div><div class="memdoc"> +<p>Connect to the database. </p> +<p>This abstract function needs to be implemented in the real driver.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramtype">string</td><td class="paramname">$server</td><td>DB server name </td></tr> + <tr><td class="paramtype">string</td><td class="paramname">$port</td><td>DB port </td></tr> + <tr><td class="paramtype">string</td><td class="paramname">$user</td><td>DB username </td></tr> + <tr><td class="paramtype">string</td><td class="paramname">$pass</td><td>DB password </td></tr> + <tr><td class="paramtype">string</td><td class="paramname">$db</td><td>database name </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>bool </dd></dl> + <p>Referenced by <a class="el" href="classdba__driver.html#af3541d13ccb7a3eddfc03e253c746186">__construct()</a>.</p> </div> @@ -318,6 +395,14 @@ Protected Attributes</h2></td></tr> </table> </div><div class="memdoc"> +<p>Sets the database driver's debugging state. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramtype">int</td><td class="paramname">$dbg</td><td>0 to disable debugging </td></tr> + </table> + </dd> +</dl> + </div> </div> <a class="anchor" id="afc95ffa103a3290581b537670cde5311"></a> @@ -342,6 +427,61 @@ Protected Attributes</h2></td></tr> </table> </div><div class="memdoc"> +<p>Escape a string before being passed to a DB query. </p> +<p>This abstract function needs to be implemented in the real driver.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramtype">string</td><td class="paramname">$str</td><td>The string to escape. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a7dbe8318587ff1694825042bf58f4fbd"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">dba_driver::escapebin </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="a8d6a79d39d7eaee5aea4e952c4529d48"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">dba_driver::get_install_script </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="a65a5c7b355ab5529a43049e160006426"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">dba_driver::get_null_date </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + </div> </div> <a class="anchor" id="a4ccb27243e62a8ca30dd8e1b8cc67746"></a> @@ -384,6 +524,22 @@ Protected Attributes</h2></td></tr> </div> </div> +<a class="anchor" id="a77e59dcbeab30ca6000131d2e9ad4092"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">dba_driver::optimize_table </td> + <td>(</td> + <td class="paramtype"> </td> + <td class="paramname"><em>$table</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> <a class="anchor" id="a558e738b88ae893cc5d79ffa3793d555"></a> <div class="memitem"> <div class="memproto"> @@ -406,6 +562,64 @@ Protected Attributes</h2></td></tr> </table> </div><div class="memdoc"> +<p>Perform a DB query with the SQL statement $sql. </p> +<p>This abstract function needs to be implemented in the real driver.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramtype">string</td><td class="paramname">$sql</td><td>The SQL query to execute </td></tr> + </table> + </dd> +</dl> + +<p>Referenced by <a class="el" href="classdba__driver.html#a77e59dcbeab30ca6000131d2e9ad4092">optimize_table()</a>.</p> + +</div> +</div> +<a class="anchor" id="ac9127e9c55fcc93bcfbb323b9b99b9d9"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">dba_driver::quote_interval </td> + <td>(</td> + <td class="paramtype"> </td> + <td class="paramname"><em>$txt</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="ab43184239e1d6eb00a98319f4a3df155"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">dba_driver::unescapebin </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="ad700712879719bee23752b8f424d97d0"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">dba_driver::utcnow </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + </div> </div> <h2 class="groupheader">Member Data Documentation</h2> @@ -419,6 +633,8 @@ Protected Attributes</h2></td></tr> </table> </div><div class="memdoc"> +<p>Referenced by <a class="el" href="classdba__postgres.html#ab36244320f5b71dba92d9318ccf3f34e">dba_postgres\connect()</a>.</p> + </div> </div> <a class="anchor" id="a3033b5f1c2716b52202faeaae2592fe6"></a> @@ -439,7 +655,7 @@ Protected Attributes</h2></td></tr> </table> </div><div class="memdoc"> -<p>Referenced by <a class="el" href="classdba__driver.html#af3541d13ccb7a3eddfc03e253c746186">__construct()</a>, <a class="el" href="classdba__mysqli.html#add062bd93961e5f0194d94820e9a51b1">dba_mysqli\connect()</a>, and <a class="el" href="classdba__mysql.html#a1887338627ce0e28786839363014bd0b">dba_mysql\connect()</a>.</p> +<p>Referenced by <a class="el" href="classdba__driver.html#af3541d13ccb7a3eddfc03e253c746186">__construct()</a>, <a class="el" href="classdba__mysqli.html#add062bd93961e5f0194d94820e9a51b1">dba_mysqli\connect()</a>, <a class="el" href="classdba__mysql.html#a1887338627ce0e28786839363014bd0b">dba_mysql\connect()</a>, and <a class="el" href="classdba__postgres.html#ab36244320f5b71dba92d9318ccf3f34e">dba_postgres\connect()</a>.</p> </div> </div> @@ -475,6 +691,42 @@ Protected Attributes</h2></td></tr> </div> </div> +<a class="anchor" id="a98d8523dcedda316085b4d4f856b6583"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const dba_driver::INSTALL_SCRIPT ='<a class="el" href="classdba__driver.html#a4ccb27243e62a8ca30dd8e1b8cc67746">install</a>/schema_mysql.sql'</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="afce39394c010ea589d99a21579b2c31e"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const dba_driver::NULL_DATE = '0000-00-00 00:00:00'</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="aa3325d982d4ee5d1114fd7e02a4356e8"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const dba_driver::UTC_NOW = 'UTC_TIMESTAMP()'</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> <hr/>The documentation for this class was generated from the following file:<ul> <li>include/dba/<a class="el" href="dba__driver_8php.html">dba_driver.php</a></li> </ul> |