<html>
<head>
<title>Docs For Class DB</title>
<link rel="stylesheet" type="text/css" href="../media/style.css">
</head>
<body>
<table border="0" cellspacing="0" cellpadding="0" height="48" width="100%">
<tr>
<td class="header_top">PHPonTraxTest</td>
</tr>
<tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr>
<tr>
<td class="header_menu">
[ <a href="../classtrees_PHPonTraxTest.html" class="menu">class tree: PHPonTraxTest</a> ]
[ <a href="../elementindex_PHPonTraxTest.html" class="menu">index: PHPonTraxTest</a> ]
[ <a href="../elementindex.html" class="menu">all elements</a> ]
</td>
</tr>
<tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr>
</table>
<table width="100%" border="0" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="200" class="menu">
<div id="todolist">
<p><a href="../todolist.html">Todo List</a></p>
</div>
<b>Packages:</b><br />
<a href="../li_PHPonTrax.html">PHPonTrax</a><br />
<a href="../li_PHPonTraxTest.html">PHPonTraxTest</a><br />
<br /><br />
<b>Tutorials/Manuals:</b><br />
<strong>Package-level:</strong>
<ul>
<li type="square"><a href="../PHPonTraxTest/tutorial_PHPonTraxTest.pkg.html">PHP On Trax Test</a>
</ul>
<b>Files:</b><br />
<div class="package">
<a href="../PHPonTraxTest/_test_ActionControllerErrorTest_php.html"> ActionControllerErrorTest.php
</a><br>
<a href="../PHPonTraxTest/_test_ActionControllerTest_php.html"> ActionControllerTest.php
</a><br>
<a href="../PHPonTraxTest/_test_ActionMailerTest_php.html"> ActionMailerTest.php
</a><br>
<a href="../PHPonTraxTest/_test_mockActionController_action_controller_php.html"> action_controller.php
</a><br>
<a href="../PHPonTraxTest/_test_ActiveRecordErrorTest_php.html"> ActiveRecordErrorTest.php
</a><br>
<a href="../PHPonTraxTest/_test_ActiveRecordHelperTest_php.html"> ActiveRecordHelperTest.php
</a><br>
<a href="../PHPonTraxTest/_test_ActiveRecordTest_php.html"> ActiveRecordTest.php
</a><br>
<a href="../PHPonTraxTest/_test_mockActiveRecord_active_record_php.html"> active_record.php
</a><br>
<a href="../PHPonTraxTest/_test_controllers_application_php.html"> application.php
</a><br>
<a href="../PHPonTraxTest/_test_ApplicationControllerTest_php.html"> ApplicationControllerTest.php
</a><br>
<a href="../PHPonTraxTest/_test_ApplicationMailerTest_php.html"> ApplicationMailerTest.php
</a><br>
<a href="../PHPonTraxTest/_test_AssetTagHelperTest_php.html"> AssetTagHelperTest.php
</a><br>
<a href="../PHPonTraxTest/_test_controllers_catalog_controller_php.html"> catalog_controller.php
</a><br>
<a href="../PHPonTraxTest/_test_DateHelperTest_php.html"> DateHelperTest.php
</a><br>
<a href="../PHPonTraxTest/_test_mockDB_DB_php.html"> DB.php
</a><br>
<a href="../PHPonTraxTest/_test_DispatcherTest_php.html"> DispatcherTest.php
</a><br>
<a href="../PHPonTraxTest/_test_FormHelperTest_php.html"> FormHelperTest.php
</a><br>
<a href="../PHPonTraxTest/_test_FormOptionsHelperTest_php.html"> FormOptionsHelperTest.php
</a><br>
<a href="../PHPonTraxTest/_test_FormTagHelperTest_php.html"> FormTagHelperTest.php
</a><br>
<a href="../PHPonTraxTest/_test_HelpersTest_php.html"> HelpersTest.php
</a><br>
<a href="../PHPonTraxTest/_test_InflectorTest_php.html"> InflectorTest.php
</a><br>
<a href="../PHPonTraxTest/_test_InputFilterTest_php.html"> InputFilterTest.php
</a><br>
<a href="../PHPonTraxTest/_test_JavaScriptHelperTest_php.html"> JavaScriptHelperTest.php
</a><br>
<a href="../PHPonTraxTest/_test_controllers_noclass_controller_php.html"> noclass_controller.php
</a><br>
<a href="../PHPonTraxTest/_test_RouterTest_php.html"> RouterTest.php
</a><br>
<a href="../PHPonTraxTest/_test_config_routes_php.html"> routes.php
</a><br>
<a href="../PHPonTraxTest/_test_runtests_php.html"> runtests.php
</a><br>
<a href="../PHPonTraxTest/_test_ScaffoldControllerTest_php.html"> ScaffoldControllerTest.php
</a><br>
<a href="../PHPonTraxTest/_test_SessionTest_php.html"> SessionTest.php
</a><br>
<a href="../PHPonTraxTest/_test_testenv_php.html"> testenv.php
</a><br>
<a href="../PHPonTraxTest/_test_TraxErrorTest_php.html"> TraxErrorTest.php
</a><br>
<a href="../PHPonTraxTest/_test_TraxGeneratorTest_php.html"> TraxGeneratorTest.php
</a><br>
<a href="../PHPonTraxTest/_test_UrlHelperTest_php.html"> UrlHelperTest.php
</a><br>
</div><br />
<b>Classes:</b><br />
<div class="package">
<a href="../PHPonTraxTest/ActionController.html">ActionController</a><br />
<a href="../PHPonTraxTest/ActionControllerErrorTest.html">ActionControllerErrorTest</a><br />
<a href="../PHPonTraxTest/ActionControllerTest.html">ActionControllerTest</a><br />
<a href="../PHPonTraxTest/ActionMailerTest.html">ActionMailerTest</a><br />
<a href="../PHPonTraxTest/ActiveRecord.html">ActiveRecord</a><br />
<a href="../PHPonTraxTest/ActiveRecordErrorTest.html">ActiveRecordErrorTest</a><br />
<a href="../PHPonTraxTest/ActiveRecordHelperTest.html">ActiveRecordHelperTest</a><br />
<a href="../PHPonTraxTest/ActiveRecordTest.html">ActiveRecordTest</a><br />
<a href="../PHPonTraxTest/ApplicationControllerTest.html">ApplicationControllerTest</a><br />
<a href="../PHPonTraxTest/ApplicationMailerTest.html">ApplicationMailerTest</a><br />
<a href="../PHPonTraxTest/AssetTagHelperTest.html">AssetTagHelperTest</a><br />
<a href="../PHPonTraxTest/CatalogController.html">CatalogController</a><br />
<a href="../PHPonTraxTest/DataType.html">DataType</a><br />
<a href="../PHPonTraxTest/DateHelperTest.html">DateHelperTest</a><br />
<a href="../PHPonTraxTest/DB.html">DB</a><br />
<a href="../PHPonTraxTest/DB_common.html">DB_common</a><br />
<a href="../PHPonTraxTest/DB_Error.html">DB_Error</a><br />
<a href="../PHPonTraxTest/DB_find_all_result.html">DB_find_all_result</a><br />
<a href="../PHPonTraxTest/DB_mysql.html">DB_mysql</a><br />
<a href="../PHPonTraxTest/DB_result.html">DB_result</a><br />
<a href="../PHPonTraxTest/DB_row.html">DB_row</a><br />
<a href="../PHPonTraxTest/DispatcherTest.html">DispatcherTest</a><br />
<a href="../PHPonTraxTest/DummyController.html">DummyController</a><br />
<a href="../PHPonTraxTest/ExDateHelper.html">ExDateHelper</a><br />
<a href="../PHPonTraxTest/ExtHelpers.html">ExtHelpers</a><br />
<a href="../PHPonTraxTest/FormHelperTest.html">FormHelperTest</a><br />
<a href="../PHPonTraxTest/FormOptionsHelperTest.html">FormOptionsHelperTest</a><br />
<a href="../PHPonTraxTest/FormTagHelperTest.html">FormTagHelperTest</a><br />
<a href="../PHPonTraxTest/HelpersTest.html">HelpersTest</a><br />
<a href="../PHPonTraxTest/InflectorTest.html">InflectorTest</a><br />
<a href="../PHPonTraxTest/InputFilterTest.html">InputFilterTest</a><br />
<a href="../PHPonTraxTest/JavaScriptHelperTest.html">JavaScriptHelperTest</a><br />
<a href="../PHPonTraxTest/PersonName.html">PersonName</a><br />
<a href="../PHPonTraxTest/RouterTest.html">RouterTest</a><br />
<a href="../PHPonTraxTest/ScaffoldControllerTest.html">ScaffoldControllerTest</a><br />
<a href="../PHPonTraxTest/SessionTest.html">SessionTest</a><br />
<a href="../PHPonTraxTest/TraxErrorTest.html">TraxErrorTest</a><br />
<a href="../PHPonTraxTest/TraxGeneratorTest.html">TraxGeneratorTest</a><br />
<a href="../PHPonTraxTest/UrlHelperTest.html">UrlHelperTest</a><br />
</div>
</td>
<td>
<table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">
<h1>Class: DB</h1>
Source Location: /test/mockDB/DB.php<br /><br />
<table width="100%" border="0">
<tr><td valign="top">
<h3><a href="#class_details">Class Overview</a></h3>
<pre></pre><br />
<div class="description">Mock DB class for testing</div><br /><br />
</td>
<td valign="top">
<h3><a href="#class_methods">Methods</a></h3>
<ul>
<li><a href="../PHPonTraxTest/DB.html#methodapiVersion">apiVersion</a></li>
<li><a href="../PHPonTraxTest/DB.html#methodconnect">connect</a></li>
<li><a href="../PHPonTraxTest/DB.html#methoderrorMessage">errorMessage</a></li>
<li><a href="../PHPonTraxTest/DB.html#methodfactory">factory</a></li>
<li><a href="../PHPonTraxTest/DB.html#methodisConnection">isConnection</a></li>
<li><a href="../PHPonTraxTest/DB.html#methodisError">isError</a></li>
<li><a href="../PHPonTraxTest/DB.html#methodisManip">isManip</a></li>
<li><a href="../PHPonTraxTest/DB.html#methodparseDSN">parseDSN</a></li>
</ul>
</td>
</tr></table>
<hr />
<table width="100%" border="0"><tr>
</tr></table>
<hr />
<a name="class_details"></a>
<h3>Class Details</h3>
<div class="tags">
[line <a href="..//__filesource/fsource_PHPonTraxTest__testmockDBDB.php.html#a322">322</a>]<br />
Mock DB class for testing<br /><br /><p>This class is a mock version of the <a href="http://pear.php.net/package/DB">PEAR DB class</a>. It is intended to provide the same interface as the real DB class, plus a small database sufficient to test software.</p><br /></div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<hr />
<a name="class_methods"></a>
<h3>Class Methods</h3>
<div class="tags">
<hr />
<a name="methodapiVersion"></a>
<h3>method apiVersion <span class="smalllinenumber">[line <a href="..//__filesource/fsource_PHPonTraxTest__testmockDBDB.php.html#a409">409</a>]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string apiVersion(
)</code>
</td></tr></table>
</td></tr></table><br />
Return the DB API version<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>the DB API version number</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodconnect"></a>
<h3>method connect <span class="smalllinenumber">[line <a href="..//__filesource/fsource_PHPonTraxTest__testmockDBDB.php.html#a379">379</a>]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>object a &connect(
mixed
$dsn, [array
$options = array()])</code>
</td></tr></table>
</td></tr></table><br />
Create a new DB object including a connection to the specified database<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>new DB object. A DB_Error object on failure.</td>
</tr>
<tr>
<td><b>todo:</b> </td><td>Implement mock DB::connect</td>
</tr>
<tr>
<td><b>uses:</b> </td><td><a href="../PHPonTraxTest/DB.html#methodparseDSN">DB::parseDSN()</a>, <a href="../PHPonTrax/.html"></a> - DB_common::setOption(), PEAR::isError()</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">mixed </td>
<td><b>$dsn</b> </td>
<td>the string "data source name" or array in the format returned by DB::parseDSN()</td>
</tr>
<tr>
<td class="type">array </td>
<td><b>$options</b> </td>
<td>an associative array of option names and values</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methoderrorMessage"></a>
<h3>method errorMessage <span class="smalllinenumber">[line <a href="..//__filesource/fsource_PHPonTraxTest__testmockDBDB.php.html#a466">466</a>]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string errorMessage(
integer
$value)</code>
</td></tr></table>
</td></tr></table><br />
Return a textual error message for a DB error code<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>the error message or false if the error code was not recognized</td>
</tr>
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
<tr>
<td><b>todo:</b> </td><td>Implement mock DB::errorMessage</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">integer </td>
<td><b>$value</b> </td>
<td>the DB error code</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodfactory"></a>
<h3>method factory <span class="smalllinenumber">[line <a href="..//__filesource/fsource_PHPonTraxTest__testmockDBDB.php.html#a334">334</a>]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>object a &factory(
string
$type, [array
$options = false])</code>
</td></tr></table>
</td></tr></table><br />
Create a new DB object for the specified database type but don't connect to the database<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>new DB object. A DB_Error object on failure.</td>
</tr>
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
<tr>
<td><b>todo:</b> </td><td>Implement mock DB::factory</td>
</tr>
<tr>
<td><b>see:</b> </td><td><a href="../PHPonTraxTest/DB_common.html#methodsetOption">DB_common::setOption()</a></td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string </td>
<td><b>$type</b> </td>
<td>the database type (eg "mysql")</td>
</tr>
<tr>
<td class="type">array </td>
<td><b>$options</b> </td>
<td>an associative array of option names and values</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodisConnection"></a>
<h3>method isConnection <span class="smalllinenumber">[line <a href="..//__filesource/fsource_PHPonTraxTest__testmockDBDB.php.html#a432">432</a>]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>bool isConnection(
mixed
$value)</code>
</td></tr></table>
</td></tr></table><br />
Determines if a value is a DB_<driver> object<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>whether $value is a DB_<driver> object</td>
</tr>
<tr>
<td><b>todo:</b> </td><td>Implement mock DB::isConnection</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">mixed </td>
<td><b>$value</b> </td>
<td>the value to test</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodisError"></a>
<h3>method isError <span class="smalllinenumber">[line <a href="..//__filesource/fsource_PHPonTraxTest__testmockDBDB.php.html#a420">420</a>]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>bool isError(
mixed
$value)</code>
</td></tr></table>
</td></tr></table><br />
Determines if a variable is a DB_Error object<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>whether $value is DB_Error object</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">mixed </td>
<td><b>$value</b> </td>
<td>the variable to check</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodisManip"></a>
<h3>method isManip <span class="smalllinenumber">[line <a href="..//__filesource/fsource_PHPonTraxTest__testmockDBDB.php.html#a445">445</a>]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>boolean isManip(
string
$query)</code>
</td></tr></table>
</td></tr></table><br />
Tell whether a query is a data manipulation or data definition query<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>whether $query is a data manipulation query</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string </td>
<td><b>$query</b> </td>
<td>the query</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodparseDSN"></a>
<h3>method parseDSN <span class="smalllinenumber">[line <a href="..//__filesource/fsource_PHPonTraxTest__testmockDBDB.php.html#a524">524</a>]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>array parseDSN(
string
$dsn)</code>
</td></tr></table>
</td></tr></table><br />
Parse a data source name<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>an associative array with the following keys: <ul><li>phptype: Database backend used in PHP (mysql, odbc etc.)</li><li>dbsyntax: Database used with regards to SQL syntax etc.</li><li>protocol: Communication protocol to use (tcp, unix etc.)</li><li>hostspec: Host specification (hostname[:port])</li><li>database: Database to use on the DBMS server</li><li>username: User name for login</li><li>password: Password for login</li></ul></td>
</tr>
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
<tr>
<td><b>todo:</b> </td><td>Implement mock DB::parseDSN</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string </td>
<td><b>$dsn</b> </td>
<td>Data Source Name to be parsed</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
</div><br />
<div class="credit">
<hr />
Documentation generated on Thu, 04 May 2006 19:47:30 -0600 by <a href="http://www.phpdoc.org">phpDocumentor 1.3.0RC4</a>
</div>
</td></tr></table>
</td>
</tr>
</table>
</body>
</html>