Skip to content

D
doctrine-dbal
Switch branch/tag
Find file
Normal viewHistoryPermalink
driverchain.html 6.74 KB
Newer Older
Roman S. Borschel's avatar
Adding new API docs.
10acab65
 
Roman S. Borschel committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 
<!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:05 +0000">

<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css">
<link rel="start" href="../../../../overview-summary.html">

<title>DriverChain (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/orm/mapping/driver/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../../doctrine/orm/mapping/driver/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/orm/mapping/driver/driverchain.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\ORM\Mapping\Driver\DriverChain</div>
<div class="location">/Doctrine/ORM/Mapping/Driver/DriverChain.php at line 41</div>

<h1>Class DriverChain</h1>

<pre class="tree"><strong>DriverChain</strong><br /></pre>

<dl>
<dt>All Implemented Interfaces:</dt>
<dd>Driver </dt>
</dl>

<hr>

<p class="signature">public  class <strong>DriverChain</strong></p>

<div class="comment" id="overview_description"><p>The DriverChain allows you to add multiple other mapping drivers for
certain namespaces</p></div>

<dl>
<dt>License:</dt>
<dd>http://www.opensource.org/licenses/lgpl-license.php LGPL</dd>
<dt>See Also:</dt>
<dd><code>www.doctrine-project.org</code></dd>
<dt>Since:</dt>
<dd>2.0</dd>
<dt>Version:</dt>
<dd>$Revision$</dd>
<dt>Author		Benjamin:</dt>
<dd>Eberlei <kontakt@beberlei.de></dd>
<dt>Author		Guilherme:</dt>
<dd>Blanco <guilhermeblanco@hotmail.com></dd>
<dt>Author:</dt>
<dd>Jonathan H. Wage <jonwage@gmail.com></dd>
<dd>Roman Borschel <roman@code-factory.org></dd>
</dl>
<hr>

<table id="summary_method">
<tr><th colspan="2">Method Summary</th></tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#addDriver()">addDriver</a>(<a href="../../../../doctrine/dbal/driver.html">Driver</a> nestedDriver, string namespace)</p><p class="description">Add a nested driver.</p></td>
</tr>
<tr>
<td class="type"> array</td>
<td class="description"><p class="name"><a href="#getAllClassNames()">getAllClassNames</a>()</p><p class="description">Gets the names of all mapped classes known to this driver.</p></td>
</tr>
<tr>
<td class="type"> array</td>
<td class="description"><p class="name"><a href="#getDrivers()">getDrivers</a>()</p><p class="description">Get the array of nested drivers.</p></td>
</tr>
<tr>
<td class="type"> boolean</td>
<td class="description"><p class="name"><a href="#isTransient()">isTransient</a>(string className)</p><p class="description">Whether the class with the specified name should have its metadata loaded.
</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#loadMetadataForClass()">loadMetadataForClass</a>(string className, <a href="../../../../doctrine/orm/mapping/classmetadatainfo.html">ClassMetadataInfo</a> metadata)</p><p class="description">Loads the metadata for the specified class into the provided container.</p></td>
</tr>
</table>

<h2 id="detail_method">Method Detail</h2>
<div class="location">/Doctrine/ORM/Mapping/Driver/DriverChain.php at line 54</div>
<h3 id="addDriver()">addDriver</h3>
<code class="signature">public  void <strong>addDriver</strong>(<a href="../../../../doctrine/dbal/driver.html">Driver</a> nestedDriver, string namespace)</code>
<div class="details">
<p>Add a nested driver.</p></div>

<hr>

<div class="location">/Doctrine/ORM/Mapping/Driver/DriverChain.php at line 92</div>
<h3 id="getAllClassNames()">getAllClassNames</h3>
<code class="signature">public  array <strong>getAllClassNames</strong>()</code>
<div class="details">
<p>Gets the names of all mapped classes known to this driver.</p><dl>
<dt>Returns:</dt>
<dd>The names of all mapped classes known to this driver.</dd>
</dl>
</div>

<hr>

<div class="location">/Doctrine/ORM/Mapping/Driver/DriverChain.php at line 64</div>
<h3 id="getDrivers()">getDrivers</h3>
<code class="signature">public  array <strong>getDrivers</strong>()</code>
<div class="details">
<p>Get the array of nested drivers.</p><dl>
<dt>Returns:</dt>
<dd>$drivers</dd>
</dl>
</div>

<hr>

<div class="location">/Doctrine/ORM/Mapping/Driver/DriverChain.php at line 109</div>
<h3 id="isTransient()">isTransient</h3>
<code class="signature">public  boolean <strong>isTransient</strong>(string className)</code>
<div class="details">
<p>Whether the class with the specified name should have its metadata loaded.
This is only the case if it is either mapped as an Entity or a
MappedSuperclass.</p></div>

<hr>

<div class="location">/Doctrine/ORM/Mapping/Driver/DriverChain.php at line 75</div>
<h3 id="loadMetadataForClass()">loadMetadataForClass</h3>
<code class="signature">public  void <strong>loadMetadataForClass</strong>(string className, <a href="../../../../doctrine/orm/mapping/classmetadatainfo.html">ClassMetadataInfo</a> metadata)</code>
<div class="details">
<p>Loads the metadata for the specified class into the provided container.</p></div>

<hr>

<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="../../../../doctrine/orm/mapping/driver/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../../doctrine/orm/mapping/driver/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/orm/mapping/driver/driverchain.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>