854 lines
38 KiB
HTML
854 lines
38 KiB
HTML
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" 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>OpenSQLManager » \PgSQL</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">OpenSQLManager</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/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||
<li><a href="../packages/OpenSQLManager.html"><i class="icon-folder-open"></i> OpenSQLManager</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">
|
||
<span 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></span><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>
|
||
<ul class="side-nav nav nav-list">
|
||
<li class="nav-header">
|
||
<i class="icon-custom icon-method"></i> Methods</li>
|
||
<li class="method public "><a href="#__construct" title="__construct :: Connect to a PosgreSQL database"><span class="description">Connect to a PosgreSQL database</span><pre>__construct()</pre></a></li>
|
||
<li class="method public inherited"><a href="#__sleep" title="__sleep :: "><span class="description">__sleep()
|
||
</span><pre>__sleep()</pre></a></li>
|
||
<li class="method public inherited"><a href="#__wakeup" title="__wakeup :: "><span class="description">__wakeup()
|
||
</span><pre>__wakeup()</pre></a></li>
|
||
<li class="method public inherited"><a href="#affected_rows" title="affected_rows :: Returns number of rows affected by an INSERT, UPDATE, DELETE type query"><span class="description">Returns number of rows affected by an INSERT, UPDATE, DELETE type query</span><pre>affected_rows()</pre></a></li>
|
||
<li class="method public inherited"><a href="#beginTransaction" title="beginTransaction :: "><span class="description">beginTransaction()
|
||
</span><pre>beginTransaction()</pre></a></li>
|
||
<li class="method public inherited"><a href="#commit" title="commit :: "><span class="description">commit()
|
||
</span><pre>commit()</pre></a></li>
|
||
<li class="method public inherited"><a href="#empty_table" title="empty_table :: Deletes all the rows from a table. Does the same as the truncate
|
||
method if the database does not support 'TRUNCATE';"><span class="description">Deletes all the rows from a table. Does the same as the truncate
|
||
method if the database does not support 'TRUNCATE';</span><pre>empty_table()</pre></a></li>
|
||
<li class="method public inherited"><a href="#errorCode" title="errorCode :: "><span class="description">errorCode()
|
||
</span><pre>errorCode()</pre></a></li>
|
||
<li class="method public inherited"><a href="#errorInfo" title="errorInfo :: "><span class="description">errorInfo()
|
||
</span><pre>errorInfo()</pre></a></li>
|
||
<li class="method public inherited"><a href="#exec" title="exec :: "><span class="description">exec()
|
||
</span><pre>exec()</pre></a></li>
|
||
<li class="method public inherited"><a href="#getAttribute" title="getAttribute :: "><span class="description">getAttribute()
|
||
</span><pre>getAttribute()</pre></a></li>
|
||
<li class="method public inherited"><a href="#getAvailableDrivers" title="getAvailableDrivers :: "><span class="description">getAvailableDrivers()
|
||
</span><pre>getAvailableDrivers()</pre></a></li>
|
||
<li class="method public inherited"><a href="#get_dbs" title="get_dbs :: Return list of dbs for the current connection, if possible"><span class="description">Return list of dbs for the current connection, if possible</span><pre>get_dbs()</pre></a></li>
|
||
<li class="method public inherited"><a href="#get_functions" title="get_functions :: Return list of function for the current database"><span class="description">Return list of function for the current database</span><pre>get_functions()</pre></a></li>
|
||
<li class="method public inherited"><a href="#get_last_error" title="get_last_error :: Return the last error for the current database connection"><span class="description">Return the last error for the current database connection</span><pre>get_last_error()</pre></a></li>
|
||
<li class="method public inherited"><a href="#get_procedures" title="get_procedures :: Return list of stored procedures for the current database"><span class="description">Return list of stored procedures for the current database</span><pre>get_procedures()</pre></a></li>
|
||
<li class="method public inherited"><a href="#get_query_data" title="get_query_data :: Retreives the data from a select query"><span class="description">Retreives the data from a select query</span><pre>get_query_data()</pre></a></li>
|
||
<li class="method public "><a href="#get_schemas" title="get_schemas :: Get a list of schemas for the current connection"><span class="description">Get a list of schemas for the current connection</span><pre>get_schemas()</pre></a></li>
|
||
<li class="method public inherited"><a href="#get_sequences" title="get_sequences :: Return list of sequences for the current database, if they exist"><span class="description">Return list of sequences for the current database, if they exist</span><pre>get_sequences()</pre></a></li>
|
||
<li class="method public inherited"><a href="#get_system_tables" title="get_system_tables :: Retreives an array of non-user-created tables for
|
||
the connection/database"><span class="description">Retreives an array of non-user-created tables for
|
||
the connection/database</span><pre>get_system_tables()</pre></a></li>
|
||
<li class="method public inherited"><a href="#get_tables" title="get_tables :: Return list of tables for the current database"><span class="description">Return list of tables for the current database</span><pre>get_tables()</pre></a></li>
|
||
<li class="method public inherited"><a href="#get_triggers" title="get_triggers :: Return list of triggers for the current database"><span class="description">Return list of triggers for the current database</span><pre>get_triggers()</pre></a></li>
|
||
<li class="method public inherited"><a href="#get_views" title="get_views :: Return list of views for the current database"><span class="description">Return list of views for the current database</span><pre>get_views()</pre></a></li>
|
||
<li class="method public inherited"><a href="#inTransaction" title="inTransaction :: "><span class="description">inTransaction()
|
||
</span><pre>inTransaction()</pre></a></li>
|
||
<li class="method public inherited"><a href="#lastInsertId" title="lastInsertId :: "><span class="description">lastInsertId()
|
||
</span><pre>lastInsertId()</pre></a></li>
|
||
<li class="method public "><a href="#num_rows" title="num_rows :: Return the number of rows returned for a SELECT query"><span class="description">Return the number of rows returned for a SELECT query</span><pre>num_rows()</pre></a></li>
|
||
<li class="method public inherited"><a href="#prepare" title="prepare :: "><span class="description">prepare()
|
||
</span><pre>prepare()</pre></a></li>
|
||
<li class="method public inherited"><a href="#prepare_execute" title="prepare_execute :: Create and execute a prepared statement with the provided parameters"><span class="description">Create and execute a prepared statement with the provided parameters</span><pre>prepare_execute()</pre></a></li>
|
||
<li class="method public inherited"><a href="#prepare_query" title="prepare_query :: Simplifies prepared statements for database queries"><span class="description">Simplifies prepared statements for database queries</span><pre>prepare_query()</pre></a></li>
|
||
<li class="method public inherited"><a href="#query" title="query :: "><span class="description">query()
|
||
</span><pre>query()</pre></a></li>
|
||
<li class="method public inherited"><a href="#quote" title="quote :: "><span class="description">quote()
|
||
</span><pre>quote()</pre></a></li>
|
||
<li class="method public inherited"><a href="#quote_ident" title="quote_ident :: Surrounds the string with the databases identifier escape characters"><span class="description">Surrounds the string with the databases identifier escape characters</span><pre>quote_ident()</pre></a></li>
|
||
<li class="method public inherited"><a href="#rollBack" title="rollBack :: "><span class="description">rollBack()
|
||
</span><pre>rollBack()</pre></a></li>
|
||
<li class="method public inherited"><a href="#setAttribute" title="setAttribute :: "><span class="description">setAttribute()
|
||
</span><pre>setAttribute()</pre></a></li>
|
||
<li class="method public "><a href="#switch_db" title="switch_db :: Connect to a different database"><span class="description">Connect to a different database</span><pre>switch_db()</pre></a></li>
|
||
<li class="method public "><a href="#truncate" title="truncate :: Empty a table"><span class="description">Empty a table</span><pre>truncate()</pre></a></li>
|
||
<li class="nav-header protected">» Protected</li>
|
||
<li class="method protected inherited"><a href="#driver_query" title="driver_query :: Method to simplify retreiving db results for meta-data queries"><span class="description">Method to simplify retreiving db results for meta-data queries</span><pre>driver_query()</pre></a></li>
|
||
<li class="nav-header">
|
||
<i class="icon-custom icon-property"></i> Properties</li>
|
||
<li class="property public inherited"><a href="#%24sql" title="$sql :: Reference to sql sub class"><span class="description">Reference to sql sub class</span><pre>$sql</pre></a></li>
|
||
<li class="property public inherited"><a href="#%24util" title="$util :: Reference to util sub class"><span class="description">Reference to util sub class</span><pre>$util</pre></a></li>
|
||
<li class="nav-header protected">» Protected</li>
|
||
<li class="property protected inherited"><a href="#%24escape_char" title="$escape_char :: Character to escape identifiers"><span class="description">Character to escape identifiers</span><pre>$escape_char</pre></a></li>
|
||
<li class="property protected inherited"><a href="#%24statement" title="$statement :: Reference to the last executed query"><span class="description">Reference to the last executed query</span><pre>$statement</pre></a></li>
|
||
</ul>
|
||
</div>
|
||
<div class="span8">
|
||
<a name="%5CPgSQL" id="\PgSQL"></a><div href="../classes/PgSQL.html" class="element class">
|
||
<p class="short_description">PostgreSQL specifc class</p>
|
||
<div class="details">
|
||
<p class="long_description"><p>Extends PDO to simplify cross-database issues</p></p>
|
||
<table class="table table-bordered">
|
||
<tr>
|
||
<th>package</th>
|
||
<td><a href="..//packages/Query.Drivers.html">Query</a></td>
|
||
</tr>
|
||
<tr>
|
||
<th>subpackage</th>
|
||
<td>Drivers</td>
|
||
</tr>
|
||
</table>
|
||
<h3>
|
||
<i class="icon-custom icon-method"></i> Methods</h3>
|
||
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse">
|
||
<h2>Connect to a PosgreSQL database</h2>
|
||
<pre>__construct(string $dsn, string $username, string $password, array $options) </pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="span8">
|
||
<p class="long_description"></p>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$dsn</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$username</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$password</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$options</h4>
|
||
<code>array</code>
|
||
</div>
|
||
</div></div>
|
||
</div>
|
||
<a name="__sleep" id="__sleep"></a><div class="element clickable method public __sleep" data-toggle="collapse" data-target=".__sleep .collapse">
|
||
<h2>__sleep()
|
||
</h2>
|
||
<pre>__sleep() </pre>
|
||
<div class="labels"><span class="label">Inherited</span></div>
|
||
<div class="row collapse"><div class="span8">
|
||
<p class="long_description"></p>
|
||
<table class="table table-bordered">
|
||
<tr>
|
||
<th>inherited_from</th>
|
||
<td>PDO::__sleep()</td>
|
||
</tr>
|
||
<tr>
|
||
<th>inherited_from</th>
|
||
<td>\DB_PDO::__sleep()</td>
|
||
</tr>
|
||
</table>
|
||
</div></div>
|
||
</div>
|
||
<a name="__wakeup" id="__wakeup"></a><div class="element clickable method public __wakeup" data-toggle="collapse" data-target=".__wakeup .collapse">
|
||
<h2>__wakeup()
|
||
</h2>
|
||
<pre>__wakeup() </pre>
|
||
<div class="labels"><span class="label">Inherited</span></div>
|
||
<div class="row collapse"><div class="span8">
|
||
<p class="long_description"></p>
|
||
<table class="table table-bordered">
|
||
<tr>
|
||
<th>inherited_from</th>
|
||
<td>PDO::__wakeup()</td>
|
||
</tr>
|
||
<tr>
|
||
<th>inherited_from</th>
|
||
<td>\DB_PDO::__wakeup()</td>
|
||
</tr>
|
||
</table>
|
||
</div></div>
|
||
</div>
|
||
<a name="affected_rows" id="affected_rows"></a><div class="element clickable method public affected_rows" data-toggle="collapse" data-target=".affected_rows .collapse">
|
||
<h2>Returns number of rows affected by an INSERT, UPDATE, DELETE type query</h2>
|
||
<pre>affected_rows(<a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a> $statement) : int</pre>
|
||
<div class="labels"><span class="label">Inherited</span></div>
|
||
<div class="row collapse"><div class="span8">
|
||
<p class="long_description"></p>
|
||
<table class="table table-bordered"><tr>
|
||
<th>inherited_from</th>
|
||
<td>\DB_PDO::affected_rows()</td>
|
||
</tr></table>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$statement</h4>
|
||
<code><a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>int</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a name="beginTransaction" id="beginTransaction"></a><div class="element clickable method public beginTransaction" data-toggle="collapse" data-target=".beginTransaction .collapse">
|
||
<h2>beginTransaction()
|
||
</h2>
|
||
<pre>beginTransaction() </pre>
|
||
<div class="labels"><span class="label">Inherited</span></div>
|
||
<div class="row collapse"><div class="span8">
|
||
<p class="long_description"></p>
|
||
<table class="table table-bordered">
|
||
<tr>
|
||
<th>inherited_from</th>
|
||
<td>PDO::beginTransaction()</td>
|
||
</tr>
|
||
<tr>
|
||
<th>inherited_from</th>
|
||
<td>\DB_PDO::beginTransaction()</td>
|
||
</tr>
|
||
</table>
|
||
</div></div>
|
||
</div>
|
||
<a name="commit" id="commit"></a><div class="element clickable method public commit" data-toggle="collapse" data-target=".commit .collapse">
|
||
<h2>commit()
|
||
</h2>
|
||
<pre>commit() </pre>
|
||
<div class="labels"><span class="label">Inherited</span></div>
|
||
<div class="row collapse"><div class="span8">
|
||
<p class="long_description"></p>
|
||
<table class="table table-bordered">
|
||
<tr>
|
||
<th>inherited_from</th>
|
||
<td>PDO::commit()</td>
|
||
</tr>
|
||
<tr>
|
||
<th>inherited_from</th>
|
||
<td>\DB_PDO::commit()</td>
|
||
</tr>
|
||
</table>
|
||
</div></div>
|
||
</div>
|
||
<a name="empty_table" id="empty_table"></a><div class="element clickable method public empty_table" data-toggle="collapse" data-target=".empty_table .collapse">
|
||
<h2>Deletes all the rows from a table. Does the same as the truncate
|
||
method if the database does not support 'TRUNCATE';</h2>
|
||
<pre>empty_table(string $table) : mixed</pre>
|
||
<div class="labels"><span class="label">Inherited</span></div>
|
||
<div class="row collapse"><div class="span8">
|
||
<p class="long_description"></p>
|
||
<table class="table table-bordered"><tr>
|
||
<th>inherited_from</th>
|
||
<td>\DB_PDO::empty_table()</td>
|
||
</tr></table>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$table</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>mixed</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a name="errorCode" id="errorCode"></a><div class="element clickable method public errorCode" data-toggle="collapse" data-target=".errorCode .collapse">
|
||
<h2>errorCode()
|
||
</h2>
|
||
<pre>errorCode() </pre>
|
||
<div class="labels"><span class="label">Inherited</span></div>
|
||
<div class="row collapse"><div class="span8">
|
||
<p class="long_description"></p>
|
||
<table class="table table-bordered">
|
||
<tr>
|
||
<th>inherited_from</th>
|
||
<td>PDO::errorCode()</td>
|
||
</tr>
|
||
<tr>
|
||
<th>inherited_from</th>
|
||
<td>\DB_PDO::errorCode()</td>
|
||
</tr>
|
||
</table>
|
||
</div></div>
|
||
</div>
|
||
<a name="errorInfo" id="errorInfo"></a><div class="element clickable method public errorInfo" data-toggle="collapse" data-target=".errorInfo .collapse">
|
||
<h2>errorInfo()
|
||
</h2>
|
||
<pre>errorInfo() </pre>
|
||
<div class="labels"><span class="label">Inherited</span></div>
|
||
<div class="row collapse"><div class="span8">
|
||
<p class="long_description"></p>
|
||
<table class="table table-bordered">
|
||
<tr>
|
||
<th>inherited_from</th>
|
||
<td>PDO::errorInfo()</td>
|
||
</tr>
|
||
<tr>
|
||
<th>inherited_from</th>
|
||
<td>\DB_PDO::errorInfo()</td>
|
||
</tr>
|
||
</table>
|
||
</div></div>
|
||
</div>
|
||
<a name="exec" id="exec"></a><div class="element clickable method public exec" data-toggle="collapse" data-target=".exec .collapse">
|
||
<h2>exec()
|
||
</h2>
|
||
<pre>exec() </pre>
|
||
<div class="labels"><span class="label">Inherited</span></div>
|
||
<div class="row collapse"><div class="span8">
|
||
<p class="long_description"></p>
|
||
<table class="table table-bordered">
|
||
<tr>
|
||
<th>inherited_from</th>
|
||
<td>PDO::exec()</td>
|
||
</tr>
|
||
<tr>
|
||
<th>inherited_from</th>
|
||
<td>\DB_PDO::exec()</td>
|
||
</tr>
|
||
</table>
|
||
</div></div>
|
||
</div>
|
||
<a name="getAttribute" id="getAttribute"></a><div class="element clickable method public getAttribute" data-toggle="collapse" data-target=".getAttribute .collapse">
|
||
<h2>getAttribute()
|
||
</h2>
|
||
<pre>getAttribute() </pre>
|
||
<div class="labels"><span class="label">Inherited</span></div>
|
||
<div class="row collapse"><div class="span8">
|
||
<p class="long_description"></p>
|
||
<table class="table table-bordered">
|
||
<tr>
|
||
<th>inherited_from</th>
|
||
<td>PDO::getAttribute()</td>
|
||
</tr>
|
||
<tr>
|
||
<th>inherited_from</th>
|
||
<td>\DB_PDO::getAttribute()</td>
|
||
</tr>
|
||
</table>
|
||
</div></div>
|
||
</div>
|
||
<a name="getAvailableDrivers" id="getAvailableDrivers"></a><div class="element clickable method public getAvailableDrivers" data-toggle="collapse" data-target=".getAvailableDrivers .collapse">
|
||
<h2>getAvailableDrivers()
|
||
</h2>
|
||
<pre>getAvailableDrivers() </pre>
|
||
<div class="labels"><span class="label">Inherited</span></div>
|
||
<div class="row collapse"><div class="span8">
|
||
<p class="long_description"></p>
|
||
<table class="table table-bordered">
|
||
<tr>
|
||
<th>inherited_from</th>
|
||
<td>PDO::getAvailableDrivers()</td>
|
||
</tr>
|
||
<tr>
|
||
<th>inherited_from</th>
|
||
<td>\DB_PDO::getAvailableDrivers()</td>
|
||
</tr>
|
||
</table>
|
||
</div></div>
|
||
</div>
|
||
<a name="get_dbs" id="get_dbs"></a><div class="element clickable method public get_dbs" data-toggle="collapse" data-target=".get_dbs .collapse">
|
||
<h2>Return list of dbs for the current connection, if possible</h2>
|
||
<pre>get_dbs() : array</pre>
|
||
<div class="labels"><span class="label">Inherited</span></div>
|
||
<div class="row collapse"><div class="span8">
|
||
<p class="long_description"></p>
|
||
<table class="table table-bordered"><tr>
|
||
<th>inherited_from</th>
|
||
<td>\DB_PDO::get_dbs()</td>
|
||
</tr></table>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>array</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a name="get_functions" id="get_functions"></a><div class="element clickable method public get_functions" data-toggle="collapse" data-target=".get_functions .collapse">
|
||
<h2>Return list of function for the current database</h2>
|
||
<pre>get_functions() : array</pre>
|
||
<div class="labels"><span class="label">Inherited</span></div>
|
||
<div class="row collapse"><div class="span8">
|
||
<p class="long_description"></p>
|
||
<table class="table table-bordered"><tr>
|
||
<th>inherited_from</th>
|
||
<td>\DB_PDO::get_functions()</td>
|
||
</tr></table>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>array</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a name="get_last_error" id="get_last_error"></a><div class="element clickable method public get_last_error" data-toggle="collapse" data-target=".get_last_error .collapse">
|
||
<h2>Return the last error for the current database connection</h2>
|
||
<pre>get_last_error() : string</pre>
|
||
<div class="labels"><span class="label">Inherited</span></div>
|
||
<div class="row collapse"><div class="span8">
|
||
<p class="long_description"></p>
|
||
<table class="table table-bordered"><tr>
|
||
<th>inherited_from</th>
|
||
<td>\DB_PDO::get_last_error()</td>
|
||
</tr></table>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>string</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a name="get_procedures" id="get_procedures"></a><div class="element clickable method public get_procedures" data-toggle="collapse" data-target=".get_procedures .collapse">
|
||
<h2>Return list of stored procedures for the current database</h2>
|
||
<pre>get_procedures() : array</pre>
|
||
<div class="labels"><span class="label">Inherited</span></div>
|
||
<div class="row collapse"><div class="span8">
|
||
<p class="long_description"></p>
|
||
<table class="table table-bordered"><tr>
|
||
<th>inherited_from</th>
|
||
<td>\DB_PDO::get_procedures()</td>
|
||
</tr></table>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>array</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a name="get_query_data" id="get_query_data"></a><div class="element clickable method public get_query_data" data-toggle="collapse" data-target=".get_query_data .collapse">
|
||
<h2>Retreives the data from a select query</h2>
|
||
<pre>get_query_data(<a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a> $statement) : array</pre>
|
||
<div class="labels"><span class="label">Inherited</span></div>
|
||
<div class="row collapse"><div class="span8">
|
||
<p class="long_description"></p>
|
||
<table class="table table-bordered"><tr>
|
||
<th>inherited_from</th>
|
||
<td>\DB_PDO::get_query_data()</td>
|
||
</tr></table>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$statement</h4>
|
||
<code><a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>array</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a name="get_schemas" id="get_schemas"></a><div class="element clickable method public get_schemas" data-toggle="collapse" data-target=".get_schemas .collapse">
|
||
<h2>Get a list of schemas for the current connection</h2>
|
||
<pre>get_schemas() : array</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="span8">
|
||
<p class="long_description"></p>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>array</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a name="get_sequences" id="get_sequences"></a><div class="element clickable method public get_sequences" data-toggle="collapse" data-target=".get_sequences .collapse">
|
||
<h2>Return list of sequences for the current database, if they exist</h2>
|
||
<pre>get_sequences() : array</pre>
|
||
<div class="labels"><span class="label">Inherited</span></div>
|
||
<div class="row collapse"><div class="span8">
|
||
<p class="long_description"></p>
|
||
<table class="table table-bordered"><tr>
|
||
<th>inherited_from</th>
|
||
<td>\DB_PDO::get_sequences()</td>
|
||
</tr></table>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>array</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a name="get_system_tables" id="get_system_tables"></a><div class="element clickable method public get_system_tables" data-toggle="collapse" data-target=".get_system_tables .collapse">
|
||
<h2>Retreives an array of non-user-created tables for
|
||
the connection/database</h2>
|
||
<pre>get_system_tables() : array</pre>
|
||
<div class="labels"><span class="label">Inherited</span></div>
|
||
<div class="row collapse"><div class="span8">
|
||
<p class="long_description"></p>
|
||
<table class="table table-bordered"><tr>
|
||
<th>inherited_from</th>
|
||
<td>\DB_PDO::get_system_tables()</td>
|
||
</tr></table>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>array</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a name="get_tables" id="get_tables"></a><div class="element clickable method public get_tables" data-toggle="collapse" data-target=".get_tables .collapse">
|
||
<h2>Return list of tables for the current database</h2>
|
||
<pre>get_tables() : array</pre>
|
||
<div class="labels"><span class="label">Inherited</span></div>
|
||
<div class="row collapse"><div class="span8">
|
||
<p class="long_description"></p>
|
||
<table class="table table-bordered"><tr>
|
||
<th>inherited_from</th>
|
||
<td>\DB_PDO::get_tables()</td>
|
||
</tr></table>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>array</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a name="get_triggers" id="get_triggers"></a><div class="element clickable method public get_triggers" data-toggle="collapse" data-target=".get_triggers .collapse">
|
||
<h2>Return list of triggers for the current database</h2>
|
||
<pre>get_triggers() : array</pre>
|
||
<div class="labels"><span class="label">Inherited</span></div>
|
||
<div class="row collapse"><div class="span8">
|
||
<p class="long_description"></p>
|
||
<table class="table table-bordered"><tr>
|
||
<th>inherited_from</th>
|
||
<td>\DB_PDO::get_triggers()</td>
|
||
</tr></table>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>array</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a name="get_views" id="get_views"></a><div class="element clickable method public get_views" data-toggle="collapse" data-target=".get_views .collapse">
|
||
<h2>Return list of views for the current database</h2>
|
||
<pre>get_views() : array</pre>
|
||
<div class="labels"><span class="label">Inherited</span></div>
|
||
<div class="row collapse"><div class="span8">
|
||
<p class="long_description"></p>
|
||
<table class="table table-bordered"><tr>
|
||
<th>inherited_from</th>
|
||
<td>\DB_PDO::get_views()</td>
|
||
</tr></table>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>array</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a name="inTransaction" id="inTransaction"></a><div class="element clickable method public inTransaction" data-toggle="collapse" data-target=".inTransaction .collapse">
|
||
<h2>inTransaction()
|
||
</h2>
|
||
<pre>inTransaction() </pre>
|
||
<div class="labels"><span class="label">Inherited</span></div>
|
||
<div class="row collapse"><div class="span8">
|
||
<p class="long_description"></p>
|
||
<table class="table table-bordered">
|
||
<tr>
|
||
<th>inherited_from</th>
|
||
<td>PDO::inTransaction()</td>
|
||
</tr>
|
||
<tr>
|
||
<th>inherited_from</th>
|
||
<td>\DB_PDO::inTransaction()</td>
|
||
</tr>
|
||
</table>
|
||
</div></div>
|
||
</div>
|
||
<a name="lastInsertId" id="lastInsertId"></a><div class="element clickable method public lastInsertId" data-toggle="collapse" data-target=".lastInsertId .collapse">
|
||
<h2>lastInsertId()
|
||
</h2>
|
||
<pre>lastInsertId() </pre>
|
||
<div class="labels"><span class="label">Inherited</span></div>
|
||
<div class="row collapse"><div class="span8">
|
||
<p class="long_description"></p>
|
||
<table class="table table-bordered">
|
||
<tr>
|
||
<th>inherited_from</th>
|
||
<td>PDO::lastInsertId()</td>
|
||
</tr>
|
||
<tr>
|
||
<th>inherited_from</th>
|
||
<td>\DB_PDO::lastInsertId()</td>
|
||
</tr>
|
||
</table>
|
||
</div></div>
|
||
</div>
|
||
<a name="num_rows" id="num_rows"></a><div class="element clickable method public num_rows" data-toggle="collapse" data-target=".num_rows .collapse">
|
||
<h2>Return the number of rows returned for a SELECT query</h2>
|
||
<pre>num_rows() : int</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="span8">
|
||
<p class="long_description"></p>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>int</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a name="prepare" id="prepare"></a><div class="element clickable method public prepare" data-toggle="collapse" data-target=".prepare .collapse">
|
||
<h2>prepare()
|
||
</h2>
|
||
<pre>prepare() </pre>
|
||
<div class="labels"><span class="label">Inherited</span></div>
|
||
<div class="row collapse"><div class="span8">
|
||
<p class="long_description"></p>
|
||
<table class="table table-bordered">
|
||
<tr>
|
||
<th>inherited_from</th>
|
||
<td>PDO::prepare()</td>
|
||
</tr>
|
||
<tr>
|
||
<th>inherited_from</th>
|
||
<td>\DB_PDO::prepare()</td>
|
||
</tr>
|
||
</table>
|
||
</div></div>
|
||
</div>
|
||
<a name="prepare_execute" id="prepare_execute"></a><div class="element clickable method public prepare_execute" data-toggle="collapse" data-target=".prepare_execute .collapse">
|
||
<h2>Create and execute a prepared statement with the provided parameters</h2>
|
||
<pre>prepare_execute(string $sql, array $params) : <a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></pre>
|
||
<div class="labels"><span class="label">Inherited</span></div>
|
||
<div class="row collapse"><div class="span8">
|
||
<p class="long_description"></p>
|
||
<table class="table table-bordered"><tr>
|
||
<th>inherited_from</th>
|
||
<td>\DB_PDO::prepare_execute()</td>
|
||
</tr></table>
|
||
<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><a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></code></div>
|
||
</div></div>
|
||
</div>
|
||
<a name="prepare_query" id="prepare_query"></a><div class="element clickable method public prepare_query" data-toggle="collapse" data-target=".prepare_query .collapse">
|
||
<h2>Simplifies prepared statements for database queries</h2>
|
||
<pre>prepare_query(string $sql, array $data) : mixed</pre>
|
||
<div class="labels"><span class="label">Inherited</span></div>
|
||
<div class="row collapse"><div class="span8">
|
||
<p class="long_description"></p>
|
||
<table class="table table-bordered"><tr>
|
||
<th>inherited_from</th>
|
||
<td>\DB_PDO::prepare_query()</td>
|
||
</tr></table>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$sql</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$data</h4>
|
||
<code>array</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response">
|
||
<code>mixed</code>PDOStatement / FALSE</div>
|
||
</div></div>
|
||
</div>
|
||
<a name="query" id="query"></a><div class="element clickable method public query" data-toggle="collapse" data-target=".query .collapse">
|
||
<h2>query()
|
||
</h2>
|
||
<pre>query() </pre>
|
||
<div class="labels"><span class="label">Inherited</span></div>
|
||
<div class="row collapse"><div class="span8">
|
||
<p class="long_description"></p>
|
||
<table class="table table-bordered">
|
||
<tr>
|
||
<th>inherited_from</th>
|
||
<td>PDO::query()</td>
|
||
</tr>
|
||
<tr>
|
||
<th>inherited_from</th>
|
||
<td>\DB_PDO::query()</td>
|
||
</tr>
|
||
</table>
|
||
</div></div>
|
||
</div>
|
||
<a name="quote" id="quote"></a><div class="element clickable method public quote" data-toggle="collapse" data-target=".quote .collapse">
|
||
<h2>quote()
|
||
</h2>
|
||
<pre>quote() </pre>
|
||
<div class="labels"><span class="label">Inherited</span></div>
|
||
<div class="row collapse"><div class="span8">
|
||
<p class="long_description"></p>
|
||
<table class="table table-bordered">
|
||
<tr>
|
||
<th>inherited_from</th>
|
||
<td>PDO::quote()</td>
|
||
</tr>
|
||
<tr>
|
||
<th>inherited_from</th>
|
||
<td>\DB_PDO::quote()</td>
|
||
</tr>
|
||
</table>
|
||
</div></div>
|
||
</div>
|
||
<a name="quote_ident" id="quote_ident"></a><div class="element clickable method public quote_ident" data-toggle="collapse" data-target=".quote_ident .collapse">
|
||
<h2>Surrounds the string with the databases identifier escape characters</h2>
|
||
<pre>quote_ident(mixed $ident) : string</pre>
|
||
<div class="labels"><span class="label">Inherited</span></div>
|
||
<div class="row collapse"><div class="span8">
|
||
<p class="long_description"></p>
|
||
<table class="table table-bordered"><tr>
|
||
<th>inherited_from</th>
|
||
<td>\DB_PDO::quote_ident()</td>
|
||
</tr></table>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$ident</h4>
|
||
<code>mixed</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>string</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a name="rollBack" id="rollBack"></a><div class="element clickable method public rollBack" data-toggle="collapse" data-target=".rollBack .collapse">
|
||
<h2>rollBack()
|
||
</h2>
|
||
<pre>rollBack() </pre>
|
||
<div class="labels"><span class="label">Inherited</span></div>
|
||
<div class="row collapse"><div class="span8">
|
||
<p class="long_description"></p>
|
||
<table class="table table-bordered">
|
||
<tr>
|
||
<th>inherited_from</th>
|
||
<td>PDO::rollBack()</td>
|
||
</tr>
|
||
<tr>
|
||
<th>inherited_from</th>
|
||
<td>\DB_PDO::rollBack()</td>
|
||
</tr>
|
||
</table>
|
||
</div></div>
|
||
</div>
|
||
<a name="setAttribute" id="setAttribute"></a><div class="element clickable method public setAttribute" data-toggle="collapse" data-target=".setAttribute .collapse">
|
||
<h2>setAttribute()
|
||
</h2>
|
||
<pre>setAttribute() </pre>
|
||
<div class="labels"><span class="label">Inherited</span></div>
|
||
<div class="row collapse"><div class="span8">
|
||
<p class="long_description"></p>
|
||
<table class="table table-bordered">
|
||
<tr>
|
||
<th>inherited_from</th>
|
||
<td>PDO::setAttribute()</td>
|
||
</tr>
|
||
<tr>
|
||
<th>inherited_from</th>
|
||
<td>\DB_PDO::setAttribute()</td>
|
||
</tr>
|
||
</table>
|
||
</div></div>
|
||
</div>
|
||
<a name="switch_db" id="switch_db"></a><div class="element clickable method public switch_db" data-toggle="collapse" data-target=".switch_db .collapse">
|
||
<h2>Connect to a different database</h2>
|
||
<pre>switch_db(string $name) : void</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="span8">
|
||
<p class="long_description"></p>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$name</h4>
|
||
<code>string</code>
|
||
</div>
|
||
</div></div>
|
||
</div>
|
||
<a name="truncate" id="truncate"></a><div class="element clickable method public truncate" data-toggle="collapse" data-target=".truncate .collapse">
|
||
<h2>Empty a table</h2>
|
||
<pre>truncate(string $table) : void</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="span8">
|
||
<p class="long_description"></p>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$table</h4>
|
||
<code>string</code>
|
||
</div>
|
||
</div></div>
|
||
</div>
|
||
<a name="driver_query" id="driver_query"></a><div class="element clickable method protected driver_query" data-toggle="collapse" data-target=".driver_query .collapse">
|
||
<h2>Method to simplify retreiving db results for meta-data queries</h2>
|
||
<pre>driver_query(string $sql, bool $filtered_index) : mixed</pre>
|
||
<div class="labels"><span class="label">Inherited</span></div>
|
||
<div class="row collapse"><div class="span8">
|
||
<p class="long_description"></p>
|
||
<table class="table table-bordered"><tr>
|
||
<th>inherited_from</th>
|
||
<td>\DB_PDO::driver_query()</td>
|
||
</tr></table>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$sql</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$filtered_index</h4>
|
||
<code>bool</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>mixed</code></div>
|
||
</div></div>
|
||
</div>
|
||
<h3>
|
||
<i class="icon-custom icon-property"></i> Properties</h3>
|
||
<a name="%24sql" id="$sql"> </a><div class="element clickable property public $sql" data-toggle="collapse" data-target=".$sql .collapse">
|
||
<h2>Reference to sql sub class</h2>
|
||
<pre>$sql </pre>
|
||
<div class="labels"><span class="label">Inherited</span></div>
|
||
<div class="row collapse"><div class="span8">
|
||
<p class="long_description"></p>
|
||
<table class="table table-bordered"><tr>
|
||
<th>inherited_from</th>
|
||
<td>\DB_PDO::$$sql</td>
|
||
</tr></table>
|
||
</div></div>
|
||
</div>
|
||
<a name="%24util" id="$util"> </a><div class="element clickable property public $util" data-toggle="collapse" data-target=".$util .collapse">
|
||
<h2>Reference to util sub class</h2>
|
||
<pre>$util </pre>
|
||
<div class="labels"><span class="label">Inherited</span></div>
|
||
<div class="row collapse"><div class="span8">
|
||
<p class="long_description"></p>
|
||
<table class="table table-bordered"><tr>
|
||
<th>inherited_from</th>
|
||
<td>\DB_PDO::$$util</td>
|
||
</tr></table>
|
||
</div></div>
|
||
</div>
|
||
<a name="%24escape_char" id="$escape_char"> </a><div class="element clickable property protected $escape_char" data-toggle="collapse" data-target=".$escape_char .collapse">
|
||
<h2>Character to escape identifiers</h2>
|
||
<pre>$escape_char </pre>
|
||
<div class="labels"><span class="label">Inherited</span></div>
|
||
<div class="row collapse"><div class="span8">
|
||
<p class="long_description"></p>
|
||
<table class="table table-bordered"><tr>
|
||
<th>inherited_from</th>
|
||
<td>\DB_PDO::$$escape_char</td>
|
||
</tr></table>
|
||
</div></div>
|
||
</div>
|
||
<a name="%24statement" id="$statement"> </a><div class="element clickable property protected $statement" data-toggle="collapse" data-target=".$statement .collapse">
|
||
<h2>Reference to the last executed query</h2>
|
||
<pre>$statement </pre>
|
||
<div class="labels"><span class="label">Inherited</span></div>
|
||
<div class="row collapse"><div class="span8">
|
||
<p class="long_description"></p>
|
||
<table class="table table-bordered"><tr>
|
||
<th>inherited_from</th>
|
||
<td>\DB_PDO::$$statement</td>
|
||
</tr></table>
|
||
</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.0.0a2</a> and<br>
|
||
generated on 2012-04-20T13:27:44-04:00.<br></footer></div>
|
||
</div>
|
||
</body>
|
||
</html>
|