<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> <html lang="en"> <head> <meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)"> <meta name="when" content="Wed, 14 Apr 2010 15:12:04 +0000"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css"> <link rel="start" href="../../overview-summary.html"> <title>Driver (Doctrine)</title> </head> <body id="definition" onload="parent.document.title=document.title;"> <div class="header"> <h1>Doctrine</h1> <ul> <li><a href="../../overview-summary.html">Overview</a></li> <li><a href="../../doctrine/dbal/package-summary.html">Namespace</a></li> <li class="active">Class</li> <li><a href="../../doctrine/dbal/package-tree.html">Tree</a></li> <li><a href="../../deprecated-list.html">Deprecated</a></li> <li><a href="../../index-all.html">Index</a></li> </ul> </div> <div class="small_links"> <a href="../../index.html" target="_top">Frames</a> <a href="../../doctrine/dbal/driver.html" target="_top">No frames</a> </div> <div class="small_links"> Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a> Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a> </div> <hr> <div class="qualifiedName">Doctrine\DBAL\Driver</div> <div class="location">/Doctrine/DBAL/Driver.php at line 11</div> <h1>Interface Driver</h1> <pre class="tree"><strong>Driver</strong><br /></pre> <hr> <p class="signature">public interface <strong>Driver</strong></p> <div class="comment" id="overview_description"><p>Driver interface. Interface that all DBAL drivers must implement.</p></div> <dl> <dt>Since:</dt> <dd>2.0</dd> </dl> <hr> <table id="summary_method"> <tr><th colspan="2">Method Summary</th></tr> <tr> <td class="type"> Doctrine\DBAL\Driver\Connection</td> <td class="description"><p class="name"><a href="#connect()">connect</a>(array params, string username, string password, array driverOptions)</p><p class="description">Attempts to create a connection with the database.</p></td> </tr> <tr> <td class="type"> string</td> <td class="description"><p class="name"><a href="#getDatabase()">getDatabase</a>(Doctrine\DBAL\Connection conn)</p><p class="description">Get the name of the database connected to for this driver.</p></td> </tr> <tr> <td class="type"> Doctrine\DBAL\Platforms\AbstractPlatform</td> <td class="description"><p class="name"><a href="#getDatabasePlatform()">getDatabasePlatform</a>()</p><p class="description">Gets the DatabasePlatform instance that provides all the metadata about the platform this driver connects to.</p></td> </tr> <tr> <td class="type"> string</td> <td class="description"><p class="name"><a href="#getName()">getName</a>()</p><p class="description">Gets the name of the driver.</p></td> </tr> <tr> <td class="type"> Doctrine\DBAL\SchemaManager</td> <td class="description"><p class="name"><a href="#getSchemaManager()">getSchemaManager</a>(Doctrine\DBAL\Connection conn)</p><p class="description">Gets the SchemaManager that can be used to inspect and change the underlying database schema of the platform this driver connects to.</p></td> </tr> </table> <h2 id="detail_method">Method Detail</h2> <div class="location">/Doctrine/DBAL/Driver.php at line 22</div> <h3 id="connect()">connect</h3> <code class="signature">public Doctrine\DBAL\Driver\Connection <strong>connect</strong>(array params, string username, string password, array driverOptions)</code> <div class="details"> <p>Attempts to create a connection with the database.</p><dl> <dt>Parameters:</dt> <dd>params - All connection parameters passed by the user.</dd> <dd>username - The username to use when connecting.</dd> <dd>password - The password to use when connecting.</dd> <dd>driverOptions - The driver options to use when connecting.</dd> <dt>Returns:</dt> <dd>The database connection.</dd> </dl> </div> <hr> <div class="location">/Doctrine/DBAL/Driver.php at line 54</div> <h3 id="getDatabase()">getDatabase</h3> <code class="signature">public string <strong>getDatabase</strong>(Doctrine\DBAL\Connection conn)</code> <div class="details"> <p>Get the name of the database connected to for this driver.</p><dl> <dt>Returns:</dt> <dd>$database</dd> </dl> </div> <hr> <div class="location">/Doctrine/DBAL/Driver.php at line 30</div> <h3 id="getDatabasePlatform()">getDatabasePlatform</h3> <code class="signature">public Doctrine\DBAL\Platforms\AbstractPlatform <strong>getDatabasePlatform</strong>()</code> <div class="details"> <p>Gets the DatabasePlatform instance that provides all the metadata about the platform this driver connects to.</p><dl> <dt>Returns:</dt> <dd>The database platform.</dd> </dl> </div> <hr> <div class="location">/Doctrine/DBAL/Driver.php at line 46</div> <h3 id="getName()">getName</h3> <code class="signature">public string <strong>getName</strong>()</code> <div class="details"> <p>Gets the name of the driver.</p><dl> <dt>Returns:</dt> <dd>The name of the driver.</dd> </dl> </div> <hr> <div class="location">/Doctrine/DBAL/Driver.php at line 39</div> <h3 id="getSchemaManager()">getSchemaManager</h3> <code class="signature">public Doctrine\DBAL\SchemaManager <strong>getSchemaManager</strong>(Doctrine\DBAL\Connection conn)</code> <div class="details"> <p>Gets the SchemaManager that can be used to inspect and change the underlying database schema of the platform this driver connects to.</p></div> <hr> <div class="header"> <h1>Doctrine</h1> <ul> <li><a href="../../overview-summary.html">Overview</a></li> <li><a href="../../doctrine/dbal/package-summary.html">Namespace</a></li> <li class="active">Class</li> <li><a href="../../doctrine/dbal/package-tree.html">Tree</a></li> <li><a href="../../deprecated-list.html">Deprecated</a></li> <li><a href="../../index-all.html">Index</a></li> </ul> </div> <div class="small_links"> <a href="../../index.html" target="_top">Frames</a> <a href="../../doctrine/dbal/driver.html" target="_top">No frames</a> </div> <div class="small_links"> Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a> Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a> </div> <hr> <p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p> </body> </html>