328 lines
23 KiB
HTML
328 lines
23 KiB
HTML
<?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\AbstractDriver</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">AbstractDriver</li>
|
||
</ul>
|
||
</div>
|
||
<nav class="box">
|
||
<ul>
|
||
<li>
|
||
<a href="#introduction">Introduction</a>
|
||
</li>
|
||
<li>
|
||
<a href="#synopsis">Synopsis</a>
|
||
</li>
|
||
<li>
|
||
<a href="#hierarchy">Hierarchy</a>
|
||
</li>
|
||
<li>
|
||
<a href="#violations">Violations</a>
|
||
</li>
|
||
<li>
|
||
<a href="#methods">Methods</a>
|
||
</li>
|
||
<li>
|
||
<a href="../source/Drivers/AbstractDriver.php.html#line32">Source</a>
|
||
</li>
|
||
</ul>
|
||
</nav>
|
||
<section>
|
||
<h1 id="introduction"><small>Query\Drivers\</small>AbstractDriver</h1>
|
||
<h4>Base Database class</h4>
|
||
<p>Extends PDO to simplify cross-database issues</p>
|
||
<ul/>
|
||
<h2 id="synopsis">Synopsis</h2>
|
||
<div class="synopsis">class AbstractDriver
|
||
extends <a title="PDO" href="../classes/PDO.html">PDO</a>
|
||
implements
|
||
<a title="Query\Drivers\DriverInterface" href="../interfaces/Query_Drivers_DriverInterface.html">DriverInterface</a>
|
||
{<br/><ul class="none"><li>// methods</li><li>public void <a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/__construct.html">__construct</a>()
|
||
</li><li>public mixed <a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/__call.html">__call</a>()
|
||
</li><li>public string <a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/getLastQuery.html">getLastQuery</a>()
|
||
</li><li>public void <a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/setLastQuery.html">setLastQuery</a>()
|
||
</li><li>public <span title="SQLInterface">SQLInterface</span> <a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/getSql.html">getSql</a>()
|
||
</li><li>public <span title="AbstractUtil">AbstractUtil</span> <a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/getUtil.html">getUtil</a>()
|
||
</li><li>public void <a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/setTablePrefix.html">setTablePrefix</a>()
|
||
</li><li>public <span title="PDOStatement">PDOStatement</span> <a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/prepareQuery.html">prepareQuery</a>()
|
||
</li><li>public <span title="PDOStatement">PDOStatement</span> <a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/prepareExecute.html">prepareExecute</a>()
|
||
</li><li>public int <a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/affectedRows.html">affectedRows</a>()
|
||
</li><li>public string <a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/prefixTable.html">prefixTable</a>()
|
||
</li><li>public string <a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/quoteTable.html">quoteTable</a>()
|
||
</li><li>public string|array <a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/quoteIdent.html">quoteIdent</a>()
|
||
</li><li>public ?array <a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/getSchemas.html">getSchemas</a>()
|
||
</li><li>public ?array <a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/getTables.html">getTables</a>()
|
||
</li><li>public ?array <a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/getDbs.html">getDbs</a>()
|
||
</li><li>public ?array <a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/getViews.html">getViews</a>()
|
||
</li><li>public ?array <a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/getSequences.html">getSequences</a>()
|
||
</li><li>public ?array <a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/getFunctions.html">getFunctions</a>()
|
||
</li><li>public ?array <a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/getProcedures.html">getProcedures</a>()
|
||
</li><li>public ?array <a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/getTriggers.html">getTriggers</a>()
|
||
</li><li>public ?array <a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/getSystemTables.html">getSystemTables</a>()
|
||
</li><li>public ?array <a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/getColumns.html">getColumns</a>()
|
||
</li><li>public ?array <a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/getFks.html">getFks</a>()
|
||
</li><li>public ?array <a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/getIndexes.html">getIndexes</a>()
|
||
</li><li>public ?array <a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/getTypes.html">getTypes</a>()
|
||
</li><li>public string <a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/getVersion.html">getVersion</a>()
|
||
</li><li>public ?array <a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/driverQuery.html">driverQuery</a>()
|
||
</li><li>public ?int <a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/numRows.html">numRows</a>()
|
||
</li><li>public array <a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/insertBatch.html">insertBatch</a>()
|
||
</li><li>public array <a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/updateBatch.html">updateBatch</a>()
|
||
</li><li>public <span title="PDOStatement">PDOStatement</span> <a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/truncate.html">truncate</a>()
|
||
</li><li>public string <a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/returning.html">returning</a>()
|
||
</li><li>public mixed <a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/_quote.html">_quote</a>()
|
||
</li></ul><ul class="none"><li>// Inherited methods from <span title="PDO">PDO</span></li><li>public void <a title="PDO" href="../classes/PDO/__construct.html">__construct</a>()
|
||
</li><li>public bool <a title="PDO" href="../classes/PDO/beginTransaction.html">beginTransaction</a>()
|
||
</li><li>public bool <a title="PDO" href="../classes/PDO/commit.html">commit</a>()
|
||
</li><li>public string <a title="PDO" href="../classes/PDO/errorCode.html">errorCode</a>()
|
||
</li><li>public array <a title="PDO" href="../classes/PDO/errorInfo.html">errorInfo</a>()
|
||
</li><li>public int <a title="PDO" href="../classes/PDO/exec.html">exec</a>()
|
||
</li><li>public mixed <a title="PDO" href="../classes/PDO/getAttribute.html">getAttribute</a>()
|
||
</li><li>public array <a title="PDO" href="../classes/PDO/getAvailableDrivers.html">getAvailableDrivers</a>()
|
||
</li><li>public bool <a title="PDO" href="../classes/PDO/inTransaction.html">inTransaction</a>()
|
||
</li><li>public string <a title="PDO" href="../classes/PDO/lastInsertId.html">lastInsertId</a>()
|
||
</li><li>public PDOStatement <a title="PDO" href="../classes/PDO/prepare.html">prepare</a>()
|
||
</li><li>public PDOStatement <a title="PDO" href="../classes/PDO/query.html">query</a>()
|
||
</li><li>public string <a title="PDO" href="../classes/PDO/quote.html">quote</a>()
|
||
</li><li>public bool <a title="PDO" href="../classes/PDO/rollBack.html">rollBack</a>()
|
||
</li><li>public bool <a title="PDO" href="../classes/PDO/setAttribute.html">setAttribute</a>()
|
||
</li></ul>
|
||
|
||
}<br/></div>
|
||
<h2 id="hierarchy">Hierarchy</h2>
|
||
<div class="styled">
|
||
<h4>Extends</h4>
|
||
<ul>
|
||
<li>
|
||
<a title="PDO" href="../classes/PDO.html">PDO</a>
|
||
</li>
|
||
</ul>
|
||
<h4>Implements</h4>
|
||
<ul>
|
||
<li>
|
||
<a title="Query\Drivers\DriverInterface" href="../interfaces/Query_Drivers_DriverInterface.html">Query\Drivers\DriverInterface</a>
|
||
</li>
|
||
</ul>
|
||
</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">82 - 721</td>
|
||
<td>
|
||
<a href="https://phpmd.org/rules/codesize.html#toomanypublicmethods" target="_blank" title="Code Size Rules">TooManyPublicMethods</a>
|
||
</td>
|
||
<td>The class AbstractDriver has 15 public methods. Consider refactoring AbstractDriver to keep number of public methods under 10.</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="line">82 - 721</td>
|
||
<td>
|
||
<a href="https://phpmd.org/rules/codesize.html#excessiveclasscomplexity" target="_blank" title="Code Size Rules">ExcessiveClassComplexity</a>
|
||
</td>
|
||
<td>The class AbstractDriver has an overall complexity of 62 which is very high. The configured complexity threshold is 50.</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="line">500</td>
|
||
<td>
|
||
<a href="https://phpmd.org/rules/cleancode.html#booleanargumentflag" target="_blank" title="Clean Code Rules">BooleanArgumentFlag</a>
|
||
</td>
|
||
<td>The method driverQuery has a boolean flag argument $filteredIndex, which is a certain sign of a Single Responsibility Principle violation.</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="line">690 - 703</td>
|
||
<td>
|
||
<a href="#" target="_blank" title="Controversial Rules">CamelCaseMethodName</a>
|
||
</td>
|
||
<td>The method _quote is not named in camelCase.</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<h2 id="methods">Methods</h2>
|
||
<div class="styled">
|
||
<h4>public</h4>
|
||
<ul>
|
||
<li id="__construct"><a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/__construct.html">__construct()</a>
|
||
— PDO constructor wrapper</li>
|
||
<li id="__call"><a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/__call.html">__call()</a>
|
||
— Allow invoke to work on table object</li>
|
||
<li id="_quote"><a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/_quote.html">_quote()</a>
|
||
— Helper method for quote_ident</li>
|
||
<li id="affectedRows"><a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/affectedRows.html">affectedRows()</a>
|
||
— Returns number of rows affected by an INSERT, UPDATE, DELETE type query</li>
|
||
<li id="driverQuery"><a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/driverQuery.html">driverQuery()</a>
|
||
— Method to simplify retrieving db results for meta-data queries</li>
|
||
<li id="getColumns"><a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/getColumns.html">getColumns()</a>
|
||
— Retrieve column information for the current database table</li>
|
||
<li id="getDbs"><a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/getDbs.html">getDbs()</a>
|
||
— Return list of dbs for the current connection, if possible</li>
|
||
<li id="getFks"><a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/getFks.html">getFks()</a>
|
||
— Retrieve foreign keys for the table</li>
|
||
<li id="getFunctions"><a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/getFunctions.html">getFunctions()</a>
|
||
— Return list of functions for the current database</li>
|
||
<li id="getIndexes"><a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/getIndexes.html">getIndexes()</a>
|
||
— Retrieve indexes for the table</li>
|
||
<li id="getLastQuery"><a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/getLastQuery.html">getLastQuery()</a>
|
||
— Get the last sql query executed</li>
|
||
<li id="getProcedures"><a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/getProcedures.html">getProcedures()</a>
|
||
— Return list of stored procedures for the current database</li>
|
||
<li id="getSchemas"><a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/getSchemas.html">getSchemas()</a>
|
||
— Return schemas for databases that list them</li>
|
||
<li id="getSequences"><a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/getSequences.html">getSequences()</a>
|
||
— Return list of sequences for the current database, if they exist</li>
|
||
<li id="getSql"><a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/getSql.html">getSql()</a>
|
||
— Get the SQL class for the current driver</li>
|
||
<li id="getSystemTables"><a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/getSystemTables.html">getSystemTables()</a>
|
||
— Retrieves an array of non-user-created tables for the connection/database</li>
|
||
<li id="getTables"><a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/getTables.html">getTables()</a>
|
||
— Return list of tables for the current database</li>
|
||
<li id="getTriggers"><a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/getTriggers.html">getTriggers()</a>
|
||
— Return list of triggers for the current database</li>
|
||
<li id="getTypes"><a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/getTypes.html">getTypes()</a>
|
||
— Retrieve list of data types for the database</li>
|
||
<li id="getUtil"><a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/getUtil.html">getUtil()</a>
|
||
— Get the Util class for the current driver</li>
|
||
<li id="getVersion"><a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/getVersion.html">getVersion()</a>
|
||
— Get the version of the database engine</li>
|
||
<li id="getViews"><a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/getViews.html">getViews()</a>
|
||
— Return list of views for the current database</li>
|
||
<li id="insertBatch"><a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/insertBatch.html">insertBatch()</a>
|
||
— Create sql for batch insert</li>
|
||
<li id="numRows"><a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/numRows.html">numRows()</a>
|
||
— Return the number of rows returned for a SELECT query</li>
|
||
<li id="prefixTable"><a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/prefixTable.html">prefixTable()</a>
|
||
— Prefixes a table if it is not already prefixed</li>
|
||
<li id="prepareExecute"><a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/prepareExecute.html">prepareExecute()</a>
|
||
— Create and execute a prepared statement with the provided parameters</li>
|
||
<li id="prepareQuery"><a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/prepareQuery.html">prepareQuery()</a>
|
||
— Simplifies prepared statements for database queries</li>
|
||
<li id="quoteIdent"><a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/quoteIdent.html">quoteIdent()</a>
|
||
— Surrounds the string with the databases identifier escape characters</li>
|
||
<li id="quoteTable"><a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/quoteTable.html">quoteTable()</a>
|
||
— Quote database table name, and set prefix</li>
|
||
<li id="returning"><a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/returning.html">returning()</a>
|
||
— Generate the returning clause for the current database</li>
|
||
<li id="setLastQuery"><a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/setLastQuery.html">setLastQuery()</a>
|
||
— Set the last query sql</li>
|
||
<li id="setTablePrefix"><a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/setTablePrefix.html">setTablePrefix()</a>
|
||
— Set the common table name prefix</li>
|
||
<li id="truncate"><a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/truncate.html">truncate()</a>
|
||
— Empty the passed table</li>
|
||
<li id="updateBatch"><a title="Query\Drivers\AbstractDriver" href="../classes/Query_Drivers_AbstractDriver/updateBatch.html">updateBatch()</a>
|
||
— Creates a batch update, and executes it.</li>
|
||
</ul>
|
||
<h3>Inherited from <a title="PDO" href="../classes/PDO.html">PDO</a></h3>
|
||
<h4>public</h4>
|
||
<ul>
|
||
<li id="beginTransaction"><a title="PDO" href="../classes/PDO/beginTransaction.html">beginTransaction()</a>
|
||
—
|
||
Initiates a transaction
|
||
</li>
|
||
<li id="commit"><a title="PDO" href="../classes/PDO/commit.html">commit()</a>
|
||
—
|
||
Commits a transaction
|
||
</li>
|
||
<li id="errorCode"><a title="PDO" href="../classes/PDO/errorCode.html">errorCode()</a>
|
||
—
|
||
Fetch the SQLSTATE associated with the last operation on the database handle
|
||
</li>
|
||
<li id="errorInfo"><a title="PDO" href="../classes/PDO/errorInfo.html">errorInfo()</a>
|
||
—
|
||
Fetch extended error information associated with the last operation on the database handle
|
||
</li>
|
||
<li id="exec"><a title="PDO" href="../classes/PDO/exec.html">exec()</a>
|
||
—
|
||
Execute an SQL statement and return the number of affected rows
|
||
</li>
|
||
<li id="getAttribute"><a title="PDO" href="../classes/PDO/getAttribute.html">getAttribute()</a>
|
||
—
|
||
Retrieve a database connection attribute
|
||
</li>
|
||
<li id="getAvailableDrivers"><a title="PDO" href="../classes/PDO/getAvailableDrivers.html">getAvailableDrivers()</a>
|
||
—
|
||
Return an array of available PDO drivers
|
||
</li>
|
||
<li id="inTransaction"><a title="PDO" href="../classes/PDO/inTransaction.html">inTransaction()</a>
|
||
—
|
||
Checks if inside a transaction
|
||
</li>
|
||
<li id="lastInsertId"><a title="PDO" href="../classes/PDO/lastInsertId.html">lastInsertId()</a>
|
||
—
|
||
Returns the ID of the last inserted row or sequence value
|
||
</li>
|
||
<li id="prepare"><a title="PDO" href="../classes/PDO/prepare.html">prepare()</a>
|
||
—
|
||
Prepares a statement for execution and returns a statement object
|
||
</li>
|
||
<li id="query"><a title="PDO" href="../classes/PDO/query.html">query()</a>
|
||
—
|
||
Executes an SQL statement, returning a result set as a PDOStatement object
|
||
</li>
|
||
<li id="quote"><a title="PDO" href="../classes/PDO/quote.html">quote()</a>
|
||
—
|
||
Quotes a string for use in a query
|
||
</li>
|
||
<li id="rollBack"><a title="PDO" href="../classes/PDO/rollBack.html">rollBack()</a>
|
||
—
|
||
Rolls back a transaction
|
||
</li>
|
||
<li id="setAttribute"><a title="PDO" href="../classes/PDO/setAttribute.html">setAttribute()</a>
|
||
—
|
||
Set an attribute
|
||
</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>
|