Query/docs/classes/Query.Driver.Firebird.html

505 lines
26 KiB
HTML
Raw Normal View History

<!DOCTYPE html><html lang="en">
2012-09-13 11:45:27 -04:00
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
2014-04-02 17:08:50 -04:00
<title>Query » \Query\Driver\Firebird</title>
2012-09-13 11:45:27 -04:00
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner"><div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">Query</a><div class="nav-collapse"><ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
2014-04-02 17:08:50 -04:00
<li><a>Namespaces</a></li>
<li><a href="../namespaces/Query.html"><i class="icon-th"></i> Query</a></li>
<li><a href="../namespaces/global.html"><i class="icon-th"></i> global</a></li>
2012-09-13 11:45:27 -04:00
<li><a>Packages</a></li>
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">0</span></a></li>
2012-09-13 11:45:27 -04:00
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul></ul></a></li>
2012-09-13 11:45:27 -04:00
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
2014-04-10 15:55:52 -04:00
<span class="label label-info">2</span></a></li>
2012-09-13 11:45:27 -04:00
</ul>
</li>
</ul></div>
</div></div>
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
</div>
<div id="___" class="container">
<noscript><div class="alert alert-warning">
Javascript is disabled; several features are only available
if Javascript is enabled.
</div></noscript>
<div class="row">
<div class="span4">
2014-02-18 15:16:34 -05:00
<div class="btn-toolbar">
<div class="btn-group visibility" data-toggle="buttons-checkbox">
<button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button>
</div>
<div class="btn-group view pull-right" data-toggle="buttons-radio">
2012-09-13 11:45:27 -04:00
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
2014-02-18 15:16:34 -05:00
</div>
2012-09-13 11:45:27 -04:00
<ul class="side-nav nav nav-list">
<li class="nav-header">
2014-02-18 15:16:34 -05:00
<i title="Methods" class="icon-custom icon-method"></i> Methods
<ul>
<li class="method public "><a href="#method___construct" title="__construct() :: Open the link to the database"><span class="description">Open the link to the database</span><pre>__construct()</pre></a></li>
2014-04-09 13:19:59 -04:00
<li class="method public "><a href="#method___destruct" title="__destruct() :: Cleanup some loose ends"><span class="description">Cleanup some loose ends</span><pre>__destruct()</pre></a></li>
<li class="method public "><a href="#method_beginTransaction" title="beginTransaction() :: Start a database transaction"><span class="description">Start a database transaction</span><pre>beginTransaction()</pre></a></li>
<li class="method public "><a href="#method_commit" title="commit() :: Commit a database transaction"><span class="description">Commit a database transaction</span><pre>commit()</pre></a></li>
<li class="method public "><a href="#method_errorCode" title="errorCode() :: Method to emulate PDO-&gt;errorCode"><span class="description">Method to emulate PDO-&gt;errorCode</span><pre>errorCode()</pre></a></li>
<li class="method public "><a href="#method_errorInfo" title="errorInfo() :: Method to emulate PDO-&gt;errorInfo / PDOStatement-&gt;errorInfo"><span class="description">Method to emulate PDO-&gt;errorInfo / PDOStatement-&gt;errorInfo</span><pre>errorInfo()</pre></a></li>
2014-03-26 20:54:40 -04:00
<li class="method public "><a href="#method_exec" title="exec() :: Execute an sql statement and return number of affected rows"><span class="description">Execute an sql statement and return number of affected rows</span><pre>exec()</pre></a></li>
<li class="method public "><a href="#method_getAttribute" title="getAttribute() :: Implement for compatibility with PDO"><span class="description">Implement for compatibility with PDO</span><pre>getAttribute()</pre></a></li>
2014-04-09 13:19:59 -04:00
<li class="method public "><a href="#method_get_service" title="get_service() :: Return service handle"><span class="description">Return service handle</span><pre>get_service()</pre></a></li>
2014-03-26 20:54:40 -04:00
<li class="method public "><a href="#method_inTransaction" title="inTransaction() :: Return whether the current statement is in a transaction"><span class="description">Return whether the current statement is in a transaction</span><pre>inTransaction()</pre></a></li>
<li class="method public "><a href="#method_insert_batch" title="insert_batch() :: Create sql for batch insert"><span class="description">Create sql for batch insert</span><pre>insert_batch()</pre></a></li>
2014-03-26 20:54:40 -04:00
<li class="method public "><a href="#method_lastInsertId" title="lastInsertId() :: Returns the last value of the specified generator"><span class="description">Returns the last value of the specified generator</span><pre>lastInsertId()</pre></a></li>
<li class="method public "><a href="#method_prepare" title="prepare() :: Emulate PDO prepare"><span class="description">Emulate PDO prepare</span><pre>prepare()</pre></a></li>
<li class="method public "><a href="#method_prepare_execute" title="prepare_execute() :: Prepare and execute a query"><span class="description">Prepare and execute a query</span><pre>prepare_execute()</pre></a></li>
<li class="method public "><a href="#method_prepare_query" title="prepare_query() :: Bind a prepared query with arguments for executing"><span class="description">Bind a prepared query with arguments for executing</span><pre>prepare_query()</pre></a></li>
<li class="method public "><a href="#method_query" title="query() :: Wrapper public function to better match PDO"><span class="description">Wrapper public function to better match PDO</span><pre>query()</pre></a></li>
<li class="method public "><a href="#method_quote" title="quote() :: Method to emulate PDO-&gt;quote"><span class="description">Method to emulate PDO-&gt;quote</span><pre>quote()</pre></a></li>
<li class="method public "><a href="#method_rollBack" title="rollBack() :: Rollback a transaction"><span class="description">Rollback a transaction</span><pre>rollBack()</pre></a></li>
2014-03-26 20:54:40 -04:00
<li class="method public "><a href="#method_setAttribute" title="setAttribute() :: Set a connection attribute"><span class="description">Set a connection attribute</span><pre>setAttribute()</pre></a></li>
<li class="method public "><a href="#method_truncate" title="truncate() :: Empty a database table"><span class="description">Empty a database table</span><pre>truncate()</pre></a></li>
</ul>
</li>
2012-09-13 11:45:27 -04:00
<li class="nav-header">
2014-02-18 15:16:34 -05:00
<i title="Properties" class="icon-custom icon-property"></i> Properties
<ul></ul>
</li>
<li class="nav-header protected">» Protected
<ul>
<li class="property protected "><a href="#property_conn" title="$conn() :: Reference to the connection resource"><span class="description"></span><pre>$conn</pre></a></li>
2014-04-09 13:19:59 -04:00
<li class="property protected "><a href="#property_service" title="$service() :: Reference to the service resource"><span class="description"></span><pre>$service</pre></a></li>
<li class="property protected "><a href="#property_statement" title="$statement() :: Reference to the last query executed"><span class="description"></span><pre>$statement</pre></a></li>
<li class="property protected "><a href="#property_statement_link" title="$statement_link() :: Reference to the resource returned by
the last query executed"><span class="description"></span><pre>$statement_link</pre></a></li>
<li class="property protected "><a href="#property_trans" title="$trans() :: Reference to the current transaction"><span class="description"></span><pre>$trans</pre></a></li>
</ul>
</li>
2012-09-13 11:45:27 -04:00
</ul>
</div>
<div class="span8">
2014-04-02 17:08:50 -04:00
<a id="\Query\Driver\Firebird"></a><ul class="breadcrumb">
<li>
2014-02-18 15:16:34 -05:00
<a href="../index.html"><i title="Classes" class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
2014-04-02 17:08:50 -04:00
<li><a href="../namespaces/Query.html">Query</a></li>
<li>
<span class="divider">\</span><a href="../namespaces/Query.Driver.html">Driver</a>
</li>
<li class="active">
2014-04-02 17:08:50 -04:00
<span class="divider">\</span><a href="../classes/Query.Driver.Firebird.html">Firebird</a>
</li>
</ul>
<div class="element class">
2012-09-13 11:45:27 -04:00
<p class="short_description">Firebird Database class</p>
<div class="details">
<div class="long_description">PDO-firebird isn't stable, so this is a wrapper of the fbird_ public functions.</div>
2012-09-13 11:45:27 -04:00
<table class="table table-bordered">
<tr>
<th>package</th>
<td><a href="../packages/Query.Drivers.html">Query</a></td>
2012-09-13 11:45:27 -04:00
</tr>
<tr>
<th>subpackage</th>
<td>Drivers</td>
</tr>
</table>
<h3>
2014-02-18 15:16:34 -05:00
<i title="Methods" class="icon-custom icon-method"></i> Methods</h3>
<a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse" title="public">
2012-09-13 11:45:27 -04:00
<h2>Open the link to the database</h2>
2014-02-18 15:16:34 -05:00
<pre>__construct(string $dbpath, string $user<code> = 'SYSDBA'</code>, string $pass<code> = 'masterkey'</code>, array $options<code> = array()</code>) </pre>
2012-09-13 11:45:27 -04:00
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
2012-09-13 11:45:27 -04:00
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$dbpath</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$user</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$pass</h4>
<code>string</code>
</div>
2014-02-18 15:16:34 -05:00
<div class="subelement argument">
<h4>$options</h4>
<code>array</code>
</div>
2012-09-13 11:45:27 -04:00
</div></div>
</div>
2014-04-09 13:19:59 -04:00
<a id="method___destruct"></a><div class="element clickable method public method___destruct" data-toggle="collapse" data-target=".method___destruct .collapse" title="public">
<h2>Cleanup some loose ends</h2>
<pre>__destruct() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>codeCoverageIgnore</th>
<td></td>
</tr></table>
</div></div>
</div>
2014-02-18 15:16:34 -05:00
<a id="method_beginTransaction"></a><div class="element clickable method public method_beginTransaction" data-toggle="collapse" data-target=".method_beginTransaction .collapse" title="public">
2012-09-13 11:45:27 -04:00
<h2>Start a database transaction</h2>
2014-03-26 20:54:40 -04:00
<pre>beginTransaction() : boolean | null</pre>
2012-09-13 11:45:27 -04:00
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
2012-09-13 11:45:27 -04:00
<h3>Returns</h3>
2014-03-26 20:54:40 -04:00
<div class="subelement response">
<code>boolean</code><code>null</code>
</div>
2012-09-13 11:45:27 -04:00
</div></div>
</div>
2014-02-18 15:16:34 -05:00
<a id="method_commit"></a><div class="element clickable method public method_commit" data-toggle="collapse" data-target=".method_commit .collapse" title="public">
2012-09-13 11:45:27 -04:00
<h2>Commit a database transaction</h2>
<pre>commit() : bool</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
2012-09-13 11:45:27 -04:00
<h3>Returns</h3>
<div class="subelement response"><code>bool</code></div>
</div></div>
</div>
2014-02-18 15:16:34 -05:00
<a id="method_errorCode"></a><div class="element clickable method public method_errorCode" data-toggle="collapse" data-target=".method_errorCode .collapse" title="public">
2012-09-13 11:45:27 -04:00
<h2>Method to emulate PDO-&gt;errorCode</h2>
<pre>errorCode() : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
2012-09-13 11:45:27 -04:00
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
2014-02-18 15:16:34 -05:00
<a id="method_errorInfo"></a><div class="element clickable method public method_errorInfo" data-toggle="collapse" data-target=".method_errorInfo .collapse" title="public">
2012-09-13 11:45:27 -04:00
<h2>Method to emulate PDO-&gt;errorInfo / PDOStatement-&gt;errorInfo</h2>
<pre>errorInfo() : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
2012-09-13 11:45:27 -04:00
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
2014-03-26 20:54:40 -04:00
<a id="method_exec"></a><div class="element clickable method public method_exec" data-toggle="collapse" data-target=".method_exec .collapse" title="public">
<h2>Execute an sql statement and return number of affected rows</h2>
<pre>exec(string $sql) : int</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$sql</h4>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>int</code></div>
</div></div>
</div>
<a id="method_getAttribute"></a><div class="element clickable method public method_getAttribute" data-toggle="collapse" data-target=".method_getAttribute .collapse" title="public">
<h2>Implement for compatibility with PDO</h2>
<pre>getAttribute(int $attribute) : mixed</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$attribute</h4>
<code>int</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>mixed</code></div>
</div></div>
</div>
2014-04-09 13:19:59 -04:00
<a id="method_get_service"></a><div class="element clickable method public method_get_service" data-toggle="collapse" data-target=".method_get_service .collapse" title="public">
<h2>Return service handle</h2>
<pre>get_service() : resource</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Returns</h3>
<div class="subelement response"><code>resource</code></div>
</div></div>
</div>
2014-03-26 20:54:40 -04:00
<a id="method_inTransaction"></a><div class="element clickable method public method_inTransaction" data-toggle="collapse" data-target=".method_inTransaction .collapse" title="public">
<h2>Return whether the current statement is in a transaction</h2>
<pre>inTransaction() : bool</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Returns</h3>
<div class="subelement response"><code>bool</code></div>
</div></div>
</div>
2014-02-18 15:16:34 -05:00
<a id="method_insert_batch"></a><div class="element clickable method public method_insert_batch" data-toggle="collapse" data-target=".method_insert_batch .collapse" title="public">
<h2>Create sql for batch insert</h2>
2014-04-03 14:50:36 -04:00
<pre>insert_batch(string $table, array $data<code> = array()</code>) : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$table</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$data</h4>
<code>array</code>
</div>
<h3>Returns</h3>
2014-04-03 14:50:36 -04:00
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
2014-03-26 20:54:40 -04:00
<a id="method_lastInsertId"></a><div class="element clickable method public method_lastInsertId" data-toggle="collapse" data-target=".method_lastInsertId .collapse" title="public">
<h2>Returns the last value of the specified generator</h2>
<pre>lastInsertId(string $name<code> = NULL</code>) : mixed</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$name</h4>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>mixed</code></div>
</div></div>
</div>
2014-02-18 15:16:34 -05:00
<a id="method_prepare"></a><div class="element clickable method public method_prepare" data-toggle="collapse" data-target=".method_prepare .collapse" title="public">
2012-09-13 11:45:27 -04:00
<h2>Emulate PDO prepare</h2>
2014-04-02 17:08:50 -04:00
<pre>prepare(string $query, array $options<code> = array()</code>) : <a href="../classes/Query.Driver.Firebird_Result.html">\Query\Driver\Firebird_Result</a></pre>
2012-09-13 11:45:27 -04:00
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
2012-09-13 11:45:27 -04:00
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$query</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$options</h4>
<code>array</code>
</div>
2014-02-14 10:38:25 -05:00
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
2014-04-02 17:08:50 -04:00
<th><code><a href="PDOException.html">\Query\Driver\PDOException</a></code></th>
2014-02-14 10:38:25 -05:00
<td></td>
</tr></table>
2012-09-13 11:45:27 -04:00
<h3>Returns</h3>
2014-04-02 17:08:50 -04:00
<div class="subelement response"><code><a href="../classes/Query.Driver.Firebird_Result.html">\Query\Driver\Firebird_Result</a></code></div>
2012-09-13 11:45:27 -04:00
</div></div>
</div>
2014-02-18 15:16:34 -05:00
<a id="method_prepare_execute"></a><div class="element clickable method public method_prepare_execute" data-toggle="collapse" data-target=".method_prepare_execute .collapse" title="public">
2012-09-13 11:45:27 -04:00
<h2>Prepare and execute a query</h2>
2014-04-02 17:08:50 -04:00
<pre>prepare_execute(string $sql, array $args) : <a href="../classes/Query.Driver.Firebird_Result.html">\Query\Driver\Firebird_Result</a></pre>
2012-09-13 11:45:27 -04:00
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
2012-09-13 11:45:27 -04:00
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$sql</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$args</h4>
<code>array</code>
</div>
<h3>Returns</h3>
2014-04-02 17:08:50 -04:00
<div class="subelement response"><code><a href="../classes/Query.Driver.Firebird_Result.html">\Query\Driver\Firebird_Result</a></code></div>
2012-09-13 11:45:27 -04:00
</div></div>
</div>
2014-02-18 15:16:34 -05:00
<a id="method_prepare_query"></a><div class="element clickable method public method_prepare_query" data-toggle="collapse" data-target=".method_prepare_query .collapse" title="public">
2012-09-13 11:45:27 -04:00
<h2>Bind a prepared query with arguments for executing</h2>
<pre>prepare_query(string $sql, array $params) : NULL</pre>
2012-09-13 11:45:27 -04:00
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
2012-09-13 11:45:27 -04:00
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$sql</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$params</h4>
<code>array</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>NULL</code></div>
2012-09-13 11:45:27 -04:00
</div></div>
</div>
2014-02-18 15:16:34 -05:00
<a id="method_query"></a><div class="element clickable method public method_query" data-toggle="collapse" data-target=".method_query .collapse" title="public">
2012-09-13 11:45:27 -04:00
<h2>Wrapper public function to better match PDO</h2>
2014-04-02 17:08:50 -04:00
<pre>query(string $sql<code> = ''</code>) : <a href="../classes/Query.Driver.Firebird_Result.html">\Query\Driver\Firebird_Result</a></pre>
2012-09-13 11:45:27 -04:00
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
2012-09-13 11:45:27 -04:00
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$sql</h4>
<code>string</code>
</div>
2014-02-14 10:38:25 -05:00
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
2014-04-02 17:08:50 -04:00
<th><code><a href="PDOException.html">\Query\Driver\PDOException</a></code></th>
2014-02-14 10:38:25 -05:00
<td></td>
</tr></table>
2012-09-13 11:45:27 -04:00
<h3>Returns</h3>
2014-04-02 17:08:50 -04:00
<div class="subelement response"><code><a href="../classes/Query.Driver.Firebird_Result.html">\Query\Driver\Firebird_Result</a></code></div>
2012-09-13 11:45:27 -04:00
</div></div>
</div>
2014-02-18 15:16:34 -05:00
<a id="method_quote"></a><div class="element clickable method public method_quote" data-toggle="collapse" data-target=".method_quote .collapse" title="public">
2012-09-13 11:45:27 -04:00
<h2>Method to emulate PDO-&gt;quote</h2>
2014-03-26 20:54:40 -04:00
<pre>quote(string $str, int $param_type<code> = \PDO::PARAM_STR</code>) : string</pre>
2012-09-13 11:45:27 -04:00
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
2012-09-13 11:45:27 -04:00
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$str</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$param_type</h4>
<code>int</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
2014-02-18 15:16:34 -05:00
<a id="method_rollBack"></a><div class="element clickable method public method_rollBack" data-toggle="collapse" data-target=".method_rollBack .collapse" title="public">
2012-09-13 11:45:27 -04:00
<h2>Rollback a transaction</h2>
<pre>rollBack() : bool</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
2012-09-13 11:45:27 -04:00
<h3>Returns</h3>
<div class="subelement response"><code>bool</code></div>
</div></div>
</div>
2014-03-26 20:54:40 -04:00
<a id="method_setAttribute"></a><div class="element clickable method public method_setAttribute" data-toggle="collapse" data-target=".method_setAttribute .collapse" title="public">
<h2>Set a connection attribute</h2>
<pre>setAttribute(int $attribute, mixed $value) : bool</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$attribute</h4>
<code>int</code>
</div>
<div class="subelement argument">
<h4>$value</h4>
<code>mixed</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>bool</code></div>
</div></div>
</div>
2014-02-18 15:16:34 -05:00
<a id="method_truncate"></a><div class="element clickable method public method_truncate" data-toggle="collapse" data-target=".method_truncate .collapse" title="public">
2012-09-13 11:45:27 -04:00
<h2>Empty a database table</h2>
<pre>truncate(string $table) </pre>
2012-09-13 11:45:27 -04:00
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
2012-09-13 11:45:27 -04:00
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$table</h4>
<code>string</code>
</div>
</div></div>
</div>
<h3>
2014-02-18 15:16:34 -05:00
<i title="Properties" class="icon-custom icon-property"></i> Properties</h3>
<a id="property_conn"> </a><div class="element clickable property protected property_conn" data-toggle="collapse" data-target=".property_conn .collapse" title="protected">
2012-09-13 11:45:27 -04:00
<h2>Reference to the connection resource</h2>
<pre>$conn : resource</pre>
2014-02-18 15:16:34 -05:00
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
2014-03-17 19:34:48 -04:00
<div class="subelement argument"><code>NULL</code></div>
2014-02-18 15:16:34 -05:00
</div></div>
2012-09-13 11:45:27 -04:00
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
2012-09-13 11:45:27 -04:00
</div>
2014-04-09 13:19:59 -04:00
<a id="property_service"> </a><div class="element clickable property protected property_service" data-toggle="collapse" data-target=".property_service .collapse" title="protected">
<h2>Reference to the service resource</h2>
<pre>$service : resource</pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"><code>NULL</code></div>
</div></div>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
2014-02-18 15:16:34 -05:00
<a id="property_statement"> </a><div class="element clickable property protected property_statement" data-toggle="collapse" data-target=".property_statement .collapse" title="protected">
2012-09-13 11:45:27 -04:00
<h2>Reference to the last query executed</h2>
<pre>$statement : object</pre>
2014-02-18 15:16:34 -05:00
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
2014-03-17 19:34:48 -04:00
<div class="subelement argument"><code>NULL</code></div>
2014-02-18 15:16:34 -05:00
</div></div>
2012-09-13 11:45:27 -04:00
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
2012-09-13 11:45:27 -04:00
</div>
2014-02-18 15:16:34 -05:00
<a id="property_statement_link"> </a><div class="element clickable property protected property_statement_link" data-toggle="collapse" data-target=".property_statement_link .collapse" title="protected">
2012-09-13 11:45:27 -04:00
<h2>Reference to the resource returned by
the last query executed</h2>
<pre>$statement_link : resource</pre>
2014-02-18 15:16:34 -05:00
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
2014-03-26 20:54:40 -04:00
<div class="subelement argument"><code>NULL</code></div>
2014-02-18 15:16:34 -05:00
</div></div>
2012-09-13 11:45:27 -04:00
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
2012-09-13 11:45:27 -04:00
</div>
2014-02-18 15:16:34 -05:00
<a id="property_trans"> </a><div class="element clickable property protected property_trans" data-toggle="collapse" data-target=".property_trans .collapse" title="protected">
2012-09-13 11:45:27 -04:00
<h2>Reference to the current transaction</h2>
<pre>$trans : resource</pre>
2014-02-18 15:16:34 -05:00
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
2014-03-26 20:54:40 -04:00
<div class="subelement argument"><code>NULL</code></div>
2014-02-18 15:16:34 -05:00
</div></div>
2012-09-13 11:45:27 -04:00
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
2012-09-13 11:45:27 -04:00
</div>
</div>
</div>
</div>
</div>
<div class="row"><footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
2014-02-18 15:16:34 -05:00
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.2.0
</a> and<br>
2014-04-10 15:55:52 -04:00
generated on 2014-04-10T15:54:52-04:00.<br></footer></div>
2012-09-13 11:45:27 -04:00
</div>
</body>
</html>