<h2>Usage</h2>
<p><b>Example 1</b>: creating a specific connector type<br />
<pre><br />
<code>
class Connector_MyDBType implements Connector {
// Implement all methods in the Connector interface here
}
</code><br />
</pre></p>
<p><b>Example 2</b>: using a standalone connector<br />
<pre><br />
<code>
$connector = new Connector_MyDBType();
$connector->connect('mydbtype://user:pass@host:port');
if (!$connector->query('SELECT * FROM table')) {
echo "The query failed!";
exit;
}
if (!$connector->affectedrows()) {
echo "No rows were found!";
exit;
}
while ($row = $connector->fetchrow()) {
var_dump($row); // Dumps each result set row hash
}
</code><br />
</pre></p>
<h2>Constants</h2>
<p><code>RS_HASH</code> — indicates each row in a result set should be a hash (associative array) of key/value pairs</p>
<p><code>RS_NUM</code> — indicates each row in a result set should be a numerically indexed array</p>
<p><code>RS_BOTH</code> — indicates each row in a result should should return each field both as a key/value pair and a numerical index (combines formats of RS_HASH and RS_NUM)</p>
<h2>Methods</h2>
<h3>Connecting</h3>
<div class="method">
<p><b>connect</b><br />
<small>public <b>connect</b>($connection_string)</small><br />
<div style="margin-left:20px;"><br />
Connects to a database server<br />
Opens a connection to the given database server using the (optional) username and password<br />
param {str} Connection string in standard <span class="caps">PHP</span> parse_url format<br />
return {bool} Success or failure in connection</p>
</div>
</div>
<div class="method">
<p><b>disconnect</b><br />
<small>public <b>disconnect</b>()</small><br />
<div style="margin-left:20px;"><br />
Closes a connection<br />
return {bool} Success or failure</p>
</div>
</div>
<div class="method">
<p><b>useDB</b><br />
<small>public <b>useDB</b>($db)</small><br />
<div style="margin-left:20px;"><br />
Selects a database to use on a host<br />
param {str} Database name<br />
return {bool} Success or failure</p>
</div>
</div>
<h3>Query Building</h3>
<div class="method">
<p><b>query</b><br />
<small>public <b>query</b>($sql)</small><br />
<div style="margin-left:20px;"><br />
Sends a <span class="caps">SQL</span> query to the database<br />
param {str} <span class="caps">SQL</span> statement to run<br />
return {bool} Success or failure of statement</p>
</div>
</div>
<h3>Result Set Manipulation</h3>
<div class="method">
<p><b>affectedrows</b><br />
<small>public <b>affectedrows</b>()</small><br />
<div style="margin-left:20px;"><br />
Gets the number of affected rows in a query<br />
For <span class="caps">SELECT</span> queries, returns the number of found rows. For <span class="caps">INSERT</span>/<span class="caps">UPDATE</span>/<span class="caps">DELETE</span>, returns the number of affected rows.<br />
return {int} Number of found or affected rows</p>
</div>
</div>
<div class="method">
<p><b>fetchrowset</b><br />
<small>public <b>fetchrowset</b>([$type])</small><br />
<div style="margin-left:20px;"><br />
Gets all the rows returned in a <span class="caps">SELECT</span> query<br />
Returns all the rows in a <span class="caps">SELECT</span> query resultset as an array. Each row can be returned as a hash (default) by passing in the RS_HASH constant or as a numerically indexed array by passing in the RS_NUM constant, or both at once with the RS_BOTH constant. If no rows are found, returns <span class="caps">FALSE</span>.<br />
return {array}</p>
</div>
</div>
<div class="method">
<p><b>fetchrow</b><br />
<small>public <b>fetchrow</b>([$type])</small><br />
<div style="margin-left:20px;"><br />
Gets the current result set row<br />
Returns the current result set row and increments the result set pointer. When no more rows are found, returns <span class="caps">FALSE</span>. A row can be returned as a hash (default) by passing in the RS_HASH constant or as a numerically indexed array by passing in the RS_NUM constant, or both at once with the RS_BOTH constant. This method is best used when only one row is expected or in using a while loop to pull down one row at a time.<br />
return {array} Current row in requested format</p>
</div>
</div>
<div class="method">
<p><b>fetchfield</b><br />
<small>public <b>fetchfield</b>($field)</small><br />
<div style="margin-left:20px;"><br />
Gets a field’s value in the current result set row<br />
Returns the value of a given field in the current result set row and increments the result set pointer. When no more rows are found, returns <span class="caps">FALSE</span>. If the field does not exist, an exception is thrown. This method is best used when only one row is expected or in using a while loop to pull down one row at a time.<br />
return {array}</p>
</div>
</div>
2008-03-27T22:34:27-07:00
6336
connector-interface
1902
Connector Interface
2008-04-03T14:44:30-07:00
1816