Query/apiDocumentation/classes/Query_Drivers_AbstractUtil.html

270 lines
12 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html SYSTEM "about:legacy-compat">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<title>phpDox - Query\Drivers\AbstractUtil</title>
<link rel="stylesheet" type="text/css" href="../css/style.css" media="screen"/>
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
</head>
<body>
<nav class="topnav">
<ul>
<li>
<div class="logo"><span>/**</span>phpDox</div>
</li>
<li class="separator">
<a href="../index.html">Overview</a>
</li>
<li class="separator">
<a href="../namespaces.html">Namespaces</a>
</li>
<li>
<a href="../interfaces.html">Interfaces</a>
</li>
<li>
<a href="../classes.html">Classes</a>
</li>
<li class="separator">
<a href="../source/index.html">Source</a>
</li>
</ul>
</nav>
<div id="mainstage">
<div class="box">
<ul class="breadcrumb">
<li>
<a href="../index.html">Overview</a>
</li>
<li class="separator">
<a href="../classes.html">Classes</a>
</li>
<li class="separator">
<a href="../classes.html#Query_Drivers">Query\Drivers</a>
</li>
<li class="separator">AbstractUtil</li>
</ul>
</div>
<nav class="box">
<ul>
<li>
<a href="#introduction">Introduction</a>
</li>
<li>
<a href="#synopsis">Synopsis</a>
</li>
<li>
<a href="#methods">Methods</a>
</li>
<li>
<a href="#history">History</a>
</li>
<li>
<a href="../source/Drivers/AbstractUtil.php.html#line20">Source</a>
</li>
</ul>
</nav>
<section>
<h1 id="introduction"><small>Query\Drivers\</small>AbstractUtil</h1>
<h4>Abstract class defining database / table creation methods</h4>
<p/>
<ul/>
<h2 id="synopsis">Synopsis</h2>
<div class="synopsis">class AbstractUtil
{<br/><ul class="none"><li>// methods</li><li>public void <a title="Query\Drivers\AbstractUtil" href="../classes/Query_Drivers_AbstractUtil/__construct.html">__construct</a>()
</li><li>public <span title="DriverInterface">DriverInterface</span> <a title="Query\Drivers\AbstractUtil" href="../classes/Query_Drivers_AbstractUtil/getDriver.html">getDriver</a>()
</li><li>public string <a title="Query\Drivers\AbstractUtil" href="../classes/Query_Drivers_AbstractUtil/createTable.html">createTable</a>()
</li><li>public string <a title="Query\Drivers\AbstractUtil" href="../classes/Query_Drivers_AbstractUtil/deleteTable.html">deleteTable</a>()
</li><li>public abstract string <a title="Query\Drivers\AbstractUtil" href="../classes/Query_Drivers_AbstractUtil/backupStructure.html">backupStructure</a>()
</li><li>public abstract string <a title="Query\Drivers\AbstractUtil" href="../classes/Query_Drivers_AbstractUtil/backupData.html">backupData</a>()
</li></ul>
}<br/></div>
<h2 id="methods">Methods</h2>
<div class="styled">
<h4>public</h4>
<ul>
<li id="__construct"><a title="Query\Drivers\AbstractUtil" href="../classes/Query_Drivers_AbstractUtil/__construct.html">__construct()</a>
— Save a reference to the connection object for later use</li>
<li id="backupData"><a title="Query\Drivers\AbstractUtil" href="../classes/Query_Drivers_AbstractUtil/backupData.html">backupData()</a>
— Return an SQL file with the database data as insert statements</li>
<li id="backupStructure"><a title="Query\Drivers\AbstractUtil" href="../classes/Query_Drivers_AbstractUtil/backupStructure.html">backupStructure()</a>
— Return an SQL file with the database table structure</li>
<li id="createTable"><a title="Query\Drivers\AbstractUtil" href="../classes/Query_Drivers_AbstractUtil/createTable.html">createTable()</a>
— Convenience public function to generate sql for creating a db table</li>
<li id="deleteTable"><a title="Query\Drivers\AbstractUtil" href="../classes/Query_Drivers_AbstractUtil/deleteTable.html">deleteTable()</a>
— Drop the selected table</li>
<li id="getDriver"><a title="Query\Drivers\AbstractUtil" href="../classes/Query_Drivers_AbstractUtil/getDriver.html">getDriver()</a>
— Get the driver object for the current connection</li>
</ul>
</div>
<h2 id="history">History</h2>
<ul class="styled history">
<li>
<h3>2018-01-26T08:39:30-05:00 (commit #<span title="3067976cb170a4c26d78b21167978bb6ab4fdb7e">3067976</span>)</h3>
<div>
<p>
Author: Timothy J Warren (tim@timshomepage.net) /
Commiter: Timothy J Warren (tim@timshomepage.net)
</p>
<pre class="wrapped">Add updateBatch method</pre>
</div>
</li>
<li>
<h3>2018-01-24T13:14:03-05:00 (commit #<span title="1d583bcc23524ad8840e4be580e549e8d6e549f4">1d583bc</span>)</h3>
<div>
<p>
Author: Timothy J Warren (tim@timshomepage.net) /
Commiter: Timothy J Warren (tim@timshomepage.net)
</p>
<pre class="wrapped">Add more type hinting</pre>
</div>
</li>
<li>
<h3>2018-01-22T15:43:56-05:00 (commit #<span title="91eb8123d151dde674aa5aec4efbd1dc09e0b490">91eb812</span>)</h3>
<div>
<p>
Author: Timothy J Warren (tim@timshomepage.net) /
Commiter: Timothy J Warren (tim@timshomepage.net)
</p>
<pre class="wrapped">Various refactoring</pre>
</div>
</li>
<li>
<h3>2018-01-19T15:47:34-05:00 (commit #<span title="369ca6eb0439091697ee9cbc34c83e9a4bdaace3">369ca6e</span>)</h3>
<div>
<p>
Author: Timothy J Warren (tim@timshomepage.net) /
Commiter: Timothy J Warren (tim@timshomepage.net)
</p>
<pre class="wrapped">Flatten source structure a bit</pre>
</div>
</li>
<li>
<h3>2018-01-19T13:43:19-05:00 (commit #<span title="c735c27559da47b4d53867da59cd706e8048f4a0">c735c27</span>)</h3>
<div>
<p>
Author: Timothy J Warren (tim@timshomepage.net) /
Commiter: Timothy J Warren (tim@timshomepage.net)
</p>
<pre class="wrapped">Update file headers</pre>
</div>
</li>
<li>
<h3>2016-10-13T21:55:23-04:00 (commit #<span title="b8d4768b1bfe0f38d6b65f0d4acd982793c0e9ee">b8d4768</span>)</h3>
<div>
<p>
Author: Timothy J Warren (tim@timshomepage.net) /
Commiter: Timothy J Warren (tim@timshomepage.net)
</p>
<pre class="wrapped">camelCase methods and properties</pre>
</div>
</li>
<li>
<h3>2016-10-12T22:12:25-04:00 (commit #<span title="6740aaef79540842110b2f162d17a9373d2c30da">6740aae</span>)</h3>
<div>
<p>
Author: Timothy J Warren (tim@timshomepage.net) /
Commiter: Timothy J Warren (tim@timshomepage.net)
</p>
<pre class="wrapped">PHP7 or bust!</pre>
</div>
</li>
<li>
<h3>2016-09-07T17:39:19-04:00 (commit #<span title="ca601623ba0b2a5879c01597efbf55bbde3a34fa">ca60162</span>)</h3>
<div>
<p>
Author: Timothy J Warren (tim@timshomepage.net) /
Commiter: Timothy J Warren (tim@timshomepage.net)
</p>
<pre class="wrapped">Miscellaneous cleanup and refactoring</pre>
</div>
</li>
<li>
<h3>2016-09-07T14:22:52-04:00 (commit #<span title="2db7ad182db1419adb766249c9855d548adefd70">2db7ad1</span>)</h3>
<div>
<p>
Author: Timothy J Warren (tim@timshomepage.net) /
Commiter: Timothy J Warren (tim@timshomepage.net)
</p>
<pre class="wrapped">More style fixes</pre>
</div>
</li>
<li>
<h3>2016-09-07T13:17:17-04:00 (commit #<span title="24f3b1d7011b6087a549e190582386c2669da8ce">24f3b1d</span>)</h3>
<div>
<p>
Author: Timothy J Warren (tim@timshomepage.net) /
Commiter: Timothy J Warren (tim@timshomepage.net)
</p>
<pre class="wrapped">Update header comments</pre>
</div>
</li>
<li>
<h3>2016-09-07T13:10:03-04:00 (commit #<span title="bb382131cc0d34c5ef725a27b7133c595d11825e">bb38213</span>)</h3>
<div>
<p>
Author: Timothy J Warren (tim@timshomepage.net) /
Commiter: Timothy J Warren (tim@timshomepage.net)
</p>
<pre class="wrapped">Code Style fixes</pre>
</div>
</li>
<li>
<h3>2015-11-10T20:59:03-05:00 (commit #<span title="2613a1c8a44d7b94f427dce703114a25f38b15e8">2613a1c</span>)</h3>
<div>
<p>
Author: Timothy J Warren (tim@timshomepage.net) /
Commiter: Timothy J Warren (tim@timshomepage.net)
</p>
<pre class="wrapped">Update lots of comments</pre>
</div>
</li>
<li>
<h3>2015-11-10T10:12:23-05:00 (commit #<span title="b5a141ffc741a4f271bf4e110814ac8861a2312f">b5a141f</span>)</h3>
<div>
<p>
Author: Timothy J Warren (tim@timshomepage.net) /
Commiter: Timothy J Warren (tim@timshomepage.net)
</p>
<pre class="wrapped">Make class names Pascal Case</pre>
</div>
</li>
<li>
<h3>2015-07-29T16:51:17-04:00 (commit #<span title="8511c6a445e935547b59a1d3736e7c08cf9633ea">8511c6a</span>)</h3>
<div>
<p>
Author: Timothy J. Warren (tim@timshomepage.net) /
Commiter: Timothy J. Warren (tim@timshomepage.net)
</p>
<pre class="wrapped">Move library into src folder, fix simpletest test runner</pre>
</div>
</li>
<li>
<h3>2015-07-16T16:56:13-04:00 (commit #<span title="bfc3ea33ca5c8ddc8500b3d2d8857b9f95304417">bfc3ea3</span>)</h3>
<div>
<p>
Author: Timothy J. Warren (tim@timshomepage.net) /
Commiter: Timothy J. Warren (tim@timshomepage.net)
</p>
<pre class="wrapped">Reorganize drivers into a more modern layout</pre>
</div>
</li>
<li>
<h3>2014-08-08T13:48:20-04:00 (commit #<span title="dd672df81d8f6e423b4b8ed6d7b8077306a191a3">dd672df</span>)</h3>
<div>
<p>
Author: Timothy J. Warren (tim@timshomepage.net) /
Commiter: Timothy J. Warren (tim@timshomepage.net)
</p>
<pre class="wrapped">Reorganize classes to autoload by namespace</pre>
</div>
</li>
</ul>
</section>
</div>
<footer>
<span>Generated using phpDox 0.12.0-dev - Copyright (C) 2010 - 2019 by Arne Blankerts and Contributors</span>
</footer>
</body>
</html>