1
0
mirror of synced 2024-12-15 23:56:02 +03:00
doctrine2/lib/api/doctrine/dbal/drivermanager.html
2010-04-14 17:13:14 +02:00

142 lines
5.3 KiB
HTML

<!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>DriverManager (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/drivermanager.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\DriverManager</div>
<div class="location">/Doctrine/DBAL/DriverManager.php at line 32</div>
<h1>Class DriverManager</h1>
<pre class="tree"><strong>DriverManager</strong><br /></pre>
<hr>
<p class="signature">public final class <strong>DriverManager</strong></p>
<div class="comment" id="overview_description"><p>Factory for creating Doctrine\DBAL\Connection instances.</p></div>
<dl>
<dt>Author:</dt>
<dd>Roman Borschel <roman@code-factory.org></dd>
<dt>Since:</dt>
<dd>2.0</dd>
</dl>
<hr>
<table id="summary_constr">
<tr><th colspan="2">Constructor Summary</th></tr>
<tr>
<td class="description"><p class="name"><a href="#DriverManager()">DriverManager</a>()</p><p class="description">Private constructor. </p></td>
</tr>
</table>
<table id="summary_method">
<tr><th colspan="2">Method Summary</th></tr>
<tr>
<td class="type">static Doctrine\DBAL\Connection</td>
<td class="description"><p class="name"><a href="#getConnection()">getConnection</a>(array params, mixed config, mixed eventManager, Doctrine\Common\EventManager The)</p><p class="description">Creates a connection object based on the specified parameters.
</p></td>
</tr>
</table>
<h2 id="detail_constr">Constructor Detail</h2>
<div class="location">/Doctrine/DBAL/DriverManager.php at line 50</div>
<h3 id="DriverManager()">DriverManager</h3>
<code class="signature">public <strong>DriverManager</strong>()</code>
<div class="details">
<p>Private constructor. This class cannot be instantiated.</p></div>
<hr>
<h2 id="detail_method">Method Detail</h2>
<div class="location">/Doctrine/DBAL/DriverManager.php at line 94</div>
<h3 id="getConnection()">getConnection</h3>
<code class="signature">public static Doctrine\DBAL\Connection <strong>getConnection</strong>(array params, mixed config, mixed eventManager, Doctrine\Common\EventManager The)</code>
<div class="details">
<p>Creates a connection object based on the specified parameters.
This method returns a Doctrine\DBAL\Connection which wraps the underlying
driver connection.</p><p>$params must contain at least one of the following.</p><p>Either 'driver' with one of the following values:
pdo_mysql
pdo_sqlite
pdo_pgsql
pdo_oracle
pdo_mssql</p><p>OR 'driverClass' that contains the full class name (with namespace) of the
driver class to instantiate.</p><p>Other (optional) parameters:</p><p><b>user (string)</b>:
The username to use when connecting. </p><p><b>password (string)</b>:
The password to use when connecting.</p><p><b>driverOptions (array)</b>:
Any additional driver-specific options for the driver. These are just passed
through to the driver.</p><p><b>pdo</b>:
You can pass an existing PDO instance through this parameter. The PDO
instance will be wrapped in a Doctrine\DBAL\Connection.</p><p><b>wrapperClass</b>:
You may specify a custom wrapper class through the 'wrapperClass'
parameter but this class MUST inherit from Doctrine\DBAL\Connection.</p><dl>
<dt>Parameters:</dt>
<dd>params - The parameters.</dd>
<dd>The - configuration to use.</dd>
<dd>The - event manager to use.</dd>
</dl>
</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/drivermanager.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>