Skip to content

D
doctrine-dbal
Switch branch/tag
Find file
Normal viewHistoryPermalink
foreignkeyconstraint.html 12 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 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 
<!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>ForeignKeyConstraint (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/schema/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../doctrine/dbal/schema/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/schema/foreignkeyconstraint.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\Schema\ForeignKeyConstraint</div>
<div class="location">/Doctrine/DBAL/Schema/ForeignKeyConstraint.php at line 26</div>

<h1>Class ForeignKeyConstraint</h1>

<pre class="tree">Class:ForeignKeyConstraint - Superclass: AbstractAsset
<a href="../../../doctrine/dbal/schema/abstractasset.html">AbstractAsset</a><br>   &lfloor;&nbsp;<strong>ForeignKeyConstraint</strong><br /></pre>

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

<hr>

<p class="signature">public  class <strong>ForeignKeyConstraint</strong><br>extends <a href="../../../doctrine/dbal/schema/abstractasset.html">AbstractAsset</a>

</p>

<div class="comment" id="overview_description"><p>The abstract asset allows to reset the name of all assets without publishing this to the public userland.</p><p>This encapsulation hack is necessary to keep a consistent state of the database schema. Say we have a list of tables
array($tableName => Table($tableName)); if you want to rename the table, you have to make sure</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:</dt>
<dd>Benjamin Eberlei <kontakt@beberlei.de></dd>
</dl>
<hr>

<table id="summary_field">
<tr><th colspan="2">Field Summary</th></tr>
<tr>
<td class="type">protected  string</td>
<td class="description"><p class="name"><a href="#_cascade">$_cascade</a></p><p class="description"></p></td>
</tr>
<tr>
<td class="type">protected  array</td>
<td class="description"><p class="name"><a href="#_foreignColumnNames">$_foreignColumnNames</a></p><p class="description"></p></td>
</tr>
<tr>
<td class="type">protected  string</td>
<td class="description"><p class="name"><a href="#_foreignTableName">$_foreignTableName</a></p><p class="description"></p></td>
</tr>
<tr>
<td class="type">protected  array</td>
<td class="description"><p class="name"><a href="#_localColumnNames">$_localColumnNames</a></p><p class="description"></p></td>
</tr>
<tr>
<td class="type">protected  <a href="../../../doctrine/dbal/schema/table.html">Table</a></td>
<td class="description"><p class="name"><a href="#_localTable">$_localTable</a></p><p class="description"></p></td>
</tr>
<tr>
<td class="type">protected  array</td>
<td class="description"><p class="name"><a href="#_options">$_options</a></p><p class="description"></p></td>
</tr>
</table>

<table class="inherit">
<tr><th colspan="2">Fields inherited from Doctrine\DBAL\Schema\AbstractAsset</th></tr>
<tr><td><a href="../../../doctrine/dbal/schema/abstractasset.html#_name">_name</a></td></tr></table>

<table id="summary_constr">
<tr><th colspan="2">Constructor Summary</th></tr>
<tr>
<td class="description"><p class="name"><a href="#ForeignKeyConstraint()">ForeignKeyConstraint</a>(array localColumnNames, string foreignTableName, array foreignColumnNames, string|null name, mixed options, string cascade)</p><p class="description"></p></td>
</tr>
</table>

<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="#getColumns()">getColumns</a>()</p></td>
</tr>
<tr>
<td class="type"> array</td>
<td class="description"><p class="name"><a href="#getForeignColumns()">getForeignColumns</a>()</p><p class="description"></p></td>
</tr>
<tr>
<td class="type"> string</td>
<td class="description"><p class="name"><a href="#getForeignTableName()">getForeignTableName</a>()</p><p class="description"></p></td>
</tr>
<tr>
<td class="type"> array</td>
<td class="description"><p class="name"><a href="#getLocalColumns()">getLocalColumns</a>()</p><p class="description"></p></td>
</tr>
<tr>
<td class="type"> string</td>
<td class="description"><p class="name"><a href="#getLocalTableName()">getLocalTableName</a>()</p><p class="description"></p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#getOption()">getOption</a>(mixed name)</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#hasOption()">hasOption</a>(mixed name)</p></td>
</tr>
<tr>
<td class="type"> string|null</td>
<td class="description"><p class="name"><a href="#onDelete()">onDelete</a>()</p><p class="description">Foreign Key onDelete status</p></td>
</tr>
<tr>
<td class="type"> string|null</td>
<td class="description"><p class="name"><a href="#onUpdate()">onUpdate</a>()</p><p class="description">Foreign Key onUpdate status</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#setLocalTable()">setLocalTable</a>(<a href="../../../doctrine/dbal/schema/table.html">Table</a> table)</p><p class="description"></p></td>
</tr>
</table>

<table class="inherit">
<tr><th colspan="2">Methods inherited from Doctrine\DBAL\Schema\AbstractAsset</th></tr>
<tr><td><a href="../../../doctrine/dbal/schema/abstractasset.html#getName()">getName</a></td></tr></table>

<h2 id="detail_field">Field Detail</h2>
<div class="location">/Doctrine/DBAL/Schema/ForeignKeyConstraint.php at line 51</div>
<h3 id="_cascade">_cascade</h3>
<code class="signature">protected  string <strong>$_cascade</strong> = ''</code>
<div class="details">
<p></p></div>

<hr>

<div class="location">/Doctrine/DBAL/Schema/ForeignKeyConstraint.php at line 46</div>
<h3 id="_foreignColumnNames">_foreignColumnNames</h3>
<code class="signature">protected  array <strong>$_foreignColumnNames</strong></code>
<div class="details">
<p></p></div>

<hr>

<div class="location">/Doctrine/DBAL/Schema/ForeignKeyConstraint.php at line 41</div>
<h3 id="_foreignTableName">_foreignTableName</h3>
<code class="signature">protected  string <strong>$_foreignTableName</strong></code>
<div class="details">
<p></p></div>

<hr>

<div class="location">/Doctrine/DBAL/Schema/ForeignKeyConstraint.php at line 36</div>
<h3 id="_localColumnNames">_localColumnNames</h3>
<code class="signature">protected  array <strong>$_localColumnNames</strong></code>
<div class="details">
<p></p></div>

<hr>

<div class="location">/Doctrine/DBAL/Schema/ForeignKeyConstraint.php at line 31</div>
<h3 id="_localTable">_localTable</h3>
<code class="signature">protected  <a href="../../../doctrine/dbal/schema/table.html">Table</a> <strong>$_localTable</strong></code>
<div class="details">
<p></p></div>

<hr>

<div class="location">/Doctrine/DBAL/Schema/ForeignKeyConstraint.php at line 56</div>
<h3 id="_options">_options</h3>
<code class="signature">protected  array <strong>$_options</strong></code>
<div class="details">
<p></p></div>

<hr>

<h2 id="detail_constr">Constructor Detail</h2>
<div class="location">/Doctrine/DBAL/Schema/ForeignKeyConstraint.php at line 66</div>
<h3 id="ForeignKeyConstraint()">ForeignKeyConstraint</h3>
<code class="signature">public <strong>ForeignKeyConstraint</strong>(array localColumnNames, string foreignTableName, array foreignColumnNames, string|null name, mixed options, string cascade)</code>
<div class="details">
<p></p></div>

<hr>

<h2 id="detail_method">Method Detail</h2>
<div class="location">/Doctrine/DBAL/Schema/ForeignKeyConstraint.php at line 99</div>
<h3 id="getColumns()">getColumns</h3>
<code class="signature">public  void <strong>getColumns</strong>()</code>
<div class="details">
</div>

<hr>

<div class="location">/Doctrine/DBAL/Schema/ForeignKeyConstraint.php at line 115</div>
<h3 id="getForeignColumns()">getForeignColumns</h3>
<code class="signature">public  array <strong>getForeignColumns</strong>()</code>
<div class="details">
<p></p></div>

<hr>

<div class="location">/Doctrine/DBAL/Schema/ForeignKeyConstraint.php at line 107</div>
<h3 id="getForeignTableName()">getForeignTableName</h3>
<code class="signature">public  string <strong>getForeignTableName</strong>()</code>
<div class="details">
<p></p></div>

<hr>

<div class="location">/Doctrine/DBAL/Schema/ForeignKeyConstraint.php at line 94</div>
<h3 id="getLocalColumns()">getLocalColumns</h3>
<code class="signature">public  array <strong>getLocalColumns</strong>()</code>
<div class="details">
<p></p></div>

<hr>

<div class="location">/Doctrine/DBAL/Schema/ForeignKeyConstraint.php at line 78</div>
<h3 id="getLocalTableName()">getLocalTableName</h3>
<code class="signature">public  string <strong>getLocalTableName</strong>()</code>
<div class="details">
<p></p></div>

<hr>

<div class="location">/Doctrine/DBAL/Schema/ForeignKeyConstraint.php at line 125</div>
<h3 id="getOption()">getOption</h3>
<code class="signature">public  void <strong>getOption</strong>(mixed name)</code>
<div class="details">
</div>

<hr>

<div class="location">/Doctrine/DBAL/Schema/ForeignKeyConstraint.php at line 120</div>
<h3 id="hasOption()">hasOption</h3>
<code class="signature">public  void <strong>hasOption</strong>(mixed name)</code>
<div class="details">
</div>

<hr>

<div class="location">/Doctrine/DBAL/Schema/ForeignKeyConstraint.php at line 145</div>
<h3 id="onDelete()">onDelete</h3>
<code class="signature">public  string|null <strong>onDelete</strong>()</code>
<div class="details">
<p>Foreign Key onDelete status</p></div>

<hr>

<div class="location">/Doctrine/DBAL/Schema/ForeignKeyConstraint.php at line 135</div>
<h3 id="onUpdate()">onUpdate</h3>
<code class="signature">public  string|null <strong>onUpdate</strong>()</code>
<div class="details">
<p>Foreign Key onUpdate status</p></div>

<hr>

<div class="location">/Doctrine/DBAL/Schema/ForeignKeyConstraint.php at line 86</div>
<h3 id="setLocalTable()">setLocalTable</h3>
<code class="signature">public  void <strong>setLocalTable</strong>(<a href="../../../doctrine/dbal/schema/table.html">Table</a> table)</code>
<div class="details">
<p></p></div>

<hr>

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