303 lines
16 KiB
HTML
303 lines
16 KiB
HTML
|
<!DOCTYPE html><html lang="en">
|
|||
|
|
<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">
|
|||
|
|
<title>Query » \idriver</title>
|
|||
|
|
<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">
|
|||
|
|
<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>
|
|||
|
|
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
|||
|
|
<ul></ul></a></li>
|
|||
|
|
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
|||
|
|
<span class="label label-info">0</span></a></li>
|
|||
|
|
</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">
|
|||
|
|
<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">
|
|||
|
|
<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>
|
|||
|
|
</div>
|
|||
|
|
<ul class="side-nav nav nav-list"><li class="nav-header">
|
|||
|
|
<i title="Methods" class="icon-custom icon-method"></i> Methods
|
|||
|
|
<ul>
|
|||
|
|
<li class="method public "><a href="#method___construct" title="__construct() :: Constructor/Connection method"><span class="description">Constructor/Connection method</span><pre>__construct()</pre></a></li>
|
|||
|
|
<li class="method public "><a href="#method_beginTransaction" title="beginTransaction() :: Begin a transaction"><span class="description">Begin a transaction</span><pre>beginTransaction()</pre></a></li>
|
|||
|
|
<li class="method public "><a href="#method_commit" title="commit() :: Commit a transaction"><span class="description">Commit a transaction</span><pre>commit()</pre></a></li>
|
|||
|
|
<li class="method public "><a href="#method_errorCode" title="errorCode() :: Return the current error code"><span class="description">Return the current error code</span><pre>errorCode()</pre></a></li>
|
|||
|
|
<li class="method public "><a href="#method_errorInfo" title="errorInfo() :: Return information about the current error"><span class="description">Return information about the current error</span><pre>errorInfo()</pre></a></li>
|
|||
|
|
<li class="method public "><a href="#method_exec" title="exec() :: Execute an SQL statement and return the number of affected rows"><span class="description">Execute an SQL statement and return the number of affected rows</span><pre>exec()</pre></a></li>
|
|||
|
|
<li class="method public "><a href="#method_getAttribute" title="getAttribute() :: Get a connection attribute for the current db driver"><span class="description">Get a connection attribute for the current db driver</span><pre>getAttribute()</pre></a></li>
|
|||
|
|
<li class="method public "><a href="#method_inTransaction" title="inTransaction() :: Check if currently in a transaction"><span class="description">Check if currently in a transaction</span><pre>inTransaction()</pre></a></li>
|
|||
|
|
<li class="method public "><a href="#method_lastInsertId" title="lastInsertId() :: Returns the id of the last row inserted into the database"><span class="description">Returns the id of the last row inserted into the database</span><pre>lastInsertId()</pre></a></li>
|
|||
|
|
<li class="method public "><a href="#method_prepare" title="prepare() :: Prepare a statement for execution"><span class="description">Prepare a statement for execution</span><pre>prepare()</pre></a></li>
|
|||
|
|
<li class="method public "><a href="#method_query" title="query() :: Executes an sql statement"><span class="description">Executes an sql statement</span><pre>query()</pre></a></li>
|
|||
|
|
<li class="method public "><a href="#method_quote" title="quote() :: Quotes a string for use in a query"><span class="description">Quotes a string for use in a query</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>
|
|||
|
|
<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>
|
|||
|
|
</ul>
|
|||
|
|
</li></ul>
|
|||
|
|
</div>
|
|||
|
|
<div class="span8">
|
|||
|
|
<a id="\idriver"></a><ul class="breadcrumb">
|
|||
|
|
<li>
|
|||
|
|
<a href="../index.html"><i title="Classes" class="icon-custom icon-class"></i></a><span class="divider">\</span>
|
|||
|
|
</li>
|
|||
|
|
<li class="active">
|
|||
|
|
<span class="divider">\</span><a href="../classes/idriver.html">idriver</a>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
<div class="element interface">
|
|||
|
|
<p class="short_description">PDO Interface to implement for database drivers</p>
|
|||
|
|
<div class="details">
|
|||
|
|
<div class="long_description"></div>
|
|||
|
|
<h3>
|
|||
|
|
<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">
|
|||
|
|
<h2>Constructor/Connection method</h2>
|
|||
|
|
<pre>__construct(string $dsn, \[string] $username<code> = NULL</code>, \[string] $password<code> = NULL</code>, \[array] $driver_options<code> = array()</code>) : void</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>$dsn</h4>
|
|||
|
|
<code>string</code>
|
|||
|
|
</div>
|
|||
|
|
<div class="subelement argument">
|
|||
|
|
<h4>$username</h4>
|
|||
|
|
<code><a href="%5Bstring%5D.html">\[string]</a></code>
|
|||
|
|
</div>
|
|||
|
|
<div class="subelement argument">
|
|||
|
|
<h4>$password</h4>
|
|||
|
|
<code><a href="%5Bstring%5D.html">\[string]</a></code>
|
|||
|
|
</div>
|
|||
|
|
<div class="subelement argument">
|
|||
|
|
<h4>$driver_options</h4>
|
|||
|
|
<code><a href="%5Barray%5D.html">\[array]</a></code>
|
|||
|
|
</div>
|
|||
|
|
</div></div>
|
|||
|
|
</div>
|
|||
|
|
<a id="method_beginTransaction"></a><div class="element clickable method public method_beginTransaction" data-toggle="collapse" data-target=".method_beginTransaction .collapse" title="public">
|
|||
|
|
<h2>Begin a transaction</h2>
|
|||
|
|
<pre>beginTransaction() : 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>
|
|||
|
|
<a id="method_commit"></a><div class="element clickable method public method_commit" data-toggle="collapse" data-target=".method_commit .collapse" title="public">
|
|||
|
|
<h2>Commit a transaction</h2>
|
|||
|
|
<pre>commit() : 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>
|
|||
|
|
<a id="method_errorCode"></a><div class="element clickable method public method_errorCode" data-toggle="collapse" data-target=".method_errorCode .collapse" title="public">
|
|||
|
|
<h2>Return the current error code</h2>
|
|||
|
|
<pre>errorCode() : mixed</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>mixed</code></div>
|
|||
|
|
</div></div>
|
|||
|
|
</div>
|
|||
|
|
<a id="method_errorInfo"></a><div class="element clickable method public method_errorInfo" data-toggle="collapse" data-target=".method_errorInfo .collapse" title="public">
|
|||
|
|
<h2>Return information about the current error</h2>
|
|||
|
|
<pre>errorInfo() : array</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>array</code></div>
|
|||
|
|
</div></div>
|
|||
|
|
</div>
|
|||
|
|
<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 the number of affected rows</h2>
|
|||
|
|
<pre>exec(string $statement) : 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>$statement</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>Get a connection attribute for the current db driver</h2>
|
|||
|
|
<pre>getAttribute(int $attribute) </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>returm</th>
|
|||
|
|
<td>mixed</td>
|
|||
|
|
</tr></table>
|
|||
|
|
<h3>Parameters</h3>
|
|||
|
|
<div class="subelement argument">
|
|||
|
|
<h4>$attribute</h4>
|
|||
|
|
<code>int</code>
|
|||
|
|
</div>
|
|||
|
|
</div></div>
|
|||
|
|
</div>
|
|||
|
|
<a id="method_inTransaction"></a><div class="element clickable method public method_inTransaction" data-toggle="collapse" data-target=".method_inTransaction .collapse" title="public">
|
|||
|
|
<h2>Check if currently 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>
|
|||
|
|
<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 id of the last row inserted into the database</h2>
|
|||
|
|
<pre>lastInsertId(\[string] $name<code> = NULL</code>) : string</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><a href="%5Bstring%5D.html">\[string]</a></code>
|
|||
|
|
</div>
|
|||
|
|
<h3>Returns</h3>
|
|||
|
|
<div class="subelement response"><code>string</code></div>
|
|||
|
|
</div></div>
|
|||
|
|
</div>
|
|||
|
|
<a id="method_prepare"></a><div class="element clickable method public method_prepare" data-toggle="collapse" data-target=".method_prepare .collapse" title="public">
|
|||
|
|
<h2>Prepare a statement for execution</h2>
|
|||
|
|
<pre>prepare(string $statement, \[array] $driver_options<code> = array()</code>) : <a href="PDOStatement.html">\PDOStatement</a></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>$statement</h4>
|
|||
|
|
<code>string</code>
|
|||
|
|
</div>
|
|||
|
|
<div class="subelement argument">
|
|||
|
|
<h4>$driver_options</h4>
|
|||
|
|
<code><a href="%5Barray%5D.html">\[array]</a></code>
|
|||
|
|
</div>
|
|||
|
|
<h3>Returns</h3>
|
|||
|
|
<div class="subelement response"><code><a href="PDOStatement.html">\PDOStatement</a></code></div>
|
|||
|
|
</div></div>
|
|||
|
|
</div>
|
|||
|
|
<a id="method_query"></a><div class="element clickable method public method_query" data-toggle="collapse" data-target=".method_query .collapse" title="public">
|
|||
|
|
<h2>Executes an sql statement</h2>
|
|||
|
|
<pre>query() : <a href="PDOStatement.html">\PDOStatement</a></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><a href="PDOStatement.html">\PDOStatement</a></code></div>
|
|||
|
|
</div></div>
|
|||
|
|
</div>
|
|||
|
|
<a id="method_quote"></a><div class="element clickable method public method_quote" data-toggle="collapse" data-target=".method_quote .collapse" title="public">
|
|||
|
|
<h2>Quotes a string for use in a query</h2>
|
|||
|
|
<pre>quote(string $string, \[int] $parameter_type<code> = \PDO::PARAM_STRING</code>) </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>$string</h4>
|
|||
|
|
<code>string</code>
|
|||
|
|
</div>
|
|||
|
|
<div class="subelement argument">
|
|||
|
|
<h4>$parameter_type</h4>
|
|||
|
|
<code><a href="%5Bint%5D.html">\[int]</a></code><p>#return string</p></div>
|
|||
|
|
</div></div>
|
|||
|
|
</div>
|
|||
|
|
<a id="method_rollback"></a><div class="element clickable method public method_rollback" data-toggle="collapse" data-target=".method_rollback .collapse" title="public">
|
|||
|
|
<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>
|
|||
|
|
<h3>Returns</h3>
|
|||
|
|
<div class="subelement response"><code>bool</code></div>
|
|||
|
|
</div></div>
|
|||
|
|
</div>
|
|||
|
|
<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>
|
|||
|
|
</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>
|
|||
|
|
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.2.0
|
|||
|
|
</a> and<br>
|
|||
|
|
generated on 2014-03-26T20:50:45-04:00.<br></footer></div>
|
|||
|
|
</div>
|
|||
|
|
</body>
|
|||
|
|
</html>
|