Query/apiDocumentation/classes/Query_Drivers_AbstractUtil.html
2020-04-23 18:21:35 -04:00

127 lines
5.7 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="#violations">Violations</a>
</li>
<li>
<a href="#methods">Methods</a>
</li>
<li>
<a href="../source/Drivers/AbstractUtil.php.html#line21">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="violations">Violations</h2>
<div class="styled">
<h3>PHPMessDetector</h3>
<table class="styled">
<thead>
<tr>
<th>Line</th>
<th>Rule</th>
<th>Message</th>
</tr>
</thead>
<tr>
<td class="line">58</td>
<td>
<a href="https://phpmd.org/rules/cleancode.html#booleanargumentflag" target="_blank" title="Clean Code Rules">BooleanArgumentFlag</a>
</td>
<td>The method createTable has a boolean flag argument $ifNotExists, which is a certain sign of a Single Responsibility Principle violation.</td>
</tr>
</table>
</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>
</section>
</div>
<footer>
<span>Generated using phpDox 0.12.0-dev - Copyright (C) 2010 - 2020 by Arne Blankerts and Contributors</span>
</footer>
</body>
</html>