Query/docs/classes/Query_Drivers_Sqlite_SQL/explain.html

124 lines
3.7 KiB
HTML
Raw Normal View History

2015-11-10 09:20:27 -05:00
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html SYSTEM "about:legacy-compat">
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:pu="http://schema.phpunit.de/coverage/1.0" lang="en">
<head>
<title>phpDox - Test Method</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_Sqlite">Query\Drivers\Sqlite</a>
</li>
<li class="separator">
<a title="Query\Drivers\Sqlite\SQL" href="../../classes/Query_Drivers_Sqlite_SQL.html">SQL</a>
</li>
<li class="separator">explain</li>
</ul>
</div>
<nav class="box">
<ul>
<li>
<a href="#introduction">Introduction</a>
</li>
<li>
<a href="#synopsis">Synopsis</a>
</li>
<li>
<a href="#parameter">Parameter</a>
</li>
<li>
<a href="#return">Return</a>
</li>
<li>
<a href="#interface">Interface</a>
</li>
2015-11-10 16:40:14 -05:00
<li>
<a href="#tests">Tests</a>
</li>
2015-11-10 09:20:27 -05:00
<li>
<a href="../../source/Query/Drivers/Sqlite/SQL.php.html#line32">Source</a>
</li>
</ul>
</nav>
<section>
<h1><small>Query\Drivers\Sqlite\SQL::</small>explain</h1>
<h4>Get the query plan for the sql query</h4>
<p/>
<ul/>
<h2 id="signature">Signature</h2>
<div class="styled synopsis">
<code>public function explain(string
$sql )
</code>
</div>
<h2 id="parameterlist">Parameters</h2>
<dl class="styled">
<dt><code>$sql</code>
string</dt>
<dd/>
</dl>
<h2 id="return">Returns</h2>
<dl class="styled">
<dt>string</dt>
<dd/>
</dl>
<h2 id="interface">Defined by Interface</h2>
<p class="styled">
<code>
2015-11-10 11:10:27 -05:00
<a title="Query\SQLInterface" href="../../interfaces/Query_SQLInterface.html">SQLInterface</a>
2015-11-10 09:20:27 -05:00
</code>
</p>
2015-11-10 16:40:14 -05:00
<h2 id="tests">Test Coverage</h2>
<div class="styled">
<h3>Information</h3>
<ul class="styled">
<li>Coverage: 1/1 Lines (100%)</li>
<li>Tests: 1</li>
<li>Passed: 1 (100%)</li>
</ul>
<h3>Tests</h3>
<ul class="styled">
<li>[ <span class="testresult-PASSED">PASSED</span> ] — SQLiteQBTest::testQueryExplain</li>
</ul>
</div>
2015-11-10 09:20:27 -05:00
</section>
</div>
<footer>
<span>Generated using phpDox 0.8.2-dev - Copyright (C) 2010 - 2015 by Arne Blankerts</span>
</footer>
</body>
</html>