1
0
mirror of synced 2024-12-16 08:06:02 +03:00
doctrine2/lib/api/doctrine/dbal/schema/schemadiff.html
2010-04-14 17:13:14 +02:00

231 lines
8.7 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>SchemaDiff (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/schemadiff.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\SchemaDiff</div>
<div class="location">/Doctrine/DBAL/Schema/SchemaDiff.php at line 37</div>
<h1>Class SchemaDiff</h1>
<pre class="tree"><strong>SchemaDiff</strong><br /></pre>
<hr>
<p class="signature">public class <strong>SchemaDiff</strong></p>
<div class="comment" id="overview_description"><p>Schema Diff</p></div>
<dl>
<dt>License:</dt>
<dd>http://www.opensource.org/licenses/lgpl-license.php LGPL</dd>
<dd>http://ez.no/licenses/new_bsd New BSD License</dd>
<dt>See Also:</dt>
<dd><code>www.doctrine-project.org</code></dd>
<dt>Copyright:</dt>
<dd>Copyright (C) 2005-2009 eZ Systems AS. All rights reserved.</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"> array</td>
<td class="description"><p class="name"><a href="#changedSequences">$changedSequences</a></p><p class="description"></p></td>
</tr>
<tr>
<td class="type"> array(string=>ezcDbSchemaTableDiff)</td>
<td class="description"><p class="name"><a href="#changedTables">$changedTables</a></p><p class="description">All changed tables</p></td>
</tr>
<tr>
<td class="type"> array</td>
<td class="description"><p class="name"><a href="#newSequences">$newSequences</a></p><p class="description"></p></td>
</tr>
<tr>
<td class="type"> array(string=>ezcDbSchemaTable)</td>
<td class="description"><p class="name"><a href="#newTables">$newTables</a></p><p class="description">All added tables</p></td>
</tr>
<tr>
<td class="type"> array</td>
<td class="description"><p class="name"><a href="#orphanedForeignKeys">$orphanedForeignKeys</a></p><p class="description"></p></td>
</tr>
<tr>
<td class="type"> array</td>
<td class="description"><p class="name"><a href="#removedSequences">$removedSequences</a></p><p class="description"></p></td>
</tr>
<tr>
<td class="type"> array(string=>Table)</td>
<td class="description"><p class="name"><a href="#removedTables">$removedTables</a></p><p class="description">All removed tables</p></td>
</tr>
</table>
<table id="summary_constr">
<tr><th colspan="2">Constructor Summary</th></tr>
<tr>
<td class="description"><p class="name"><a href="#SchemaDiff()">SchemaDiff</a>(array(string=>Table) newTables, array(string=>TableDiff) changedTables, array(string=>bool) removedTables)</p><p class="description">Constructs an SchemaDiff object.</p></td>
</tr>
</table>
<table id="summary_method">
<tr><th colspan="2">Method Summary</th></tr>
<tr>
<td class="type"> array</td>
<td class="description"><p class="name"><a href="#toSaveSql()">toSaveSql</a>(<a href="../../../doctrine/dbal/platforms/abstractplatform.html">AbstractPlatform</a> platform)</p><p class="description">The to save sql mode ensures that the following things don't happen:1. </p></td>
</tr>
<tr>
<td class="type"> array</td>
<td class="description"><p class="name"><a href="#toSql()">toSql</a>(<a href="../../../doctrine/dbal/platforms/abstractplatform.html">AbstractPlatform</a> platform)</p><p class="description"></p></td>
</tr>
</table>
<h2 id="detail_field">Field Detail</h2>
<div class="location">/Doctrine/DBAL/Schema/SchemaDiff.php at line 68</div>
<h3 id="changedSequences">changedSequences</h3>
<code class="signature">public array <strong>$changedSequences</strong> = array()</code>
<div class="details">
<p></p></div>
<hr>
<div class="location">/Doctrine/DBAL/Schema/SchemaDiff.php at line 51</div>
<h3 id="changedTables">changedTables</h3>
<code class="signature">public array(string=>ezcDbSchemaTableDiff) <strong>$changedTables</strong> = array()</code>
<div class="details">
<p>All changed tables</p></div>
<hr>
<div class="location">/Doctrine/DBAL/Schema/SchemaDiff.php at line 63</div>
<h3 id="newSequences">newSequences</h3>
<code class="signature">public array <strong>$newSequences</strong> = array()</code>
<div class="details">
<p></p></div>
<hr>
<div class="location">/Doctrine/DBAL/Schema/SchemaDiff.php at line 44</div>
<h3 id="newTables">newTables</h3>
<code class="signature">public array(string=>ezcDbSchemaTable) <strong>$newTables</strong> = array()</code>
<div class="details">
<p>All added tables</p></div>
<hr>
<div class="location">/Doctrine/DBAL/Schema/SchemaDiff.php at line 78</div>
<h3 id="orphanedForeignKeys">orphanedForeignKeys</h3>
<code class="signature">public array <strong>$orphanedForeignKeys</strong> = array()</code>
<div class="details">
<p></p></div>
<hr>
<div class="location">/Doctrine/DBAL/Schema/SchemaDiff.php at line 73</div>
<h3 id="removedSequences">removedSequences</h3>
<code class="signature">public array <strong>$removedSequences</strong> = array()</code>
<div class="details">
<p></p></div>
<hr>
<div class="location">/Doctrine/DBAL/Schema/SchemaDiff.php at line 58</div>
<h3 id="removedTables">removedTables</h3>
<code class="signature">public array(string=>Table) <strong>$removedTables</strong> = array()</code>
<div class="details">
<p>All removed tables</p></div>
<hr>
<h2 id="detail_constr">Constructor Detail</h2>
<div class="location">/Doctrine/DBAL/Schema/SchemaDiff.php at line 87</div>
<h3 id="SchemaDiff()">SchemaDiff</h3>
<code class="signature">public <strong>SchemaDiff</strong>(array(string=>Table) newTables, array(string=>TableDiff) changedTables, array(string=>bool) removedTables)</code>
<div class="details">
<p>Constructs an SchemaDiff object.</p></div>
<hr>
<h2 id="detail_method">Method Detail</h2>
<div class="location">/Doctrine/DBAL/Schema/SchemaDiff.php at line 106</div>
<h3 id="toSaveSql()">toSaveSql</h3>
<code class="signature">public array <strong>toSaveSql</strong>(<a href="../../../doctrine/dbal/platforms/abstractplatform.html">AbstractPlatform</a> platform)</code>
<div class="details">
<p>The to save sql mode ensures that the following things don't happen:</p><p>1. Tables are deleted
2. Sequences are deleted
3. Foreign Keys which reference tables that would otherwise be deleted.</p><p>This way it is ensured that assets are deleted which might not be relevant to the metadata schema at all.</p></div>
<hr>
<div class="location">/Doctrine/DBAL/Schema/SchemaDiff.php at line 115</div>
<h3 id="toSql()">toSql</h3>
<code class="signature">public array <strong>toSql</strong>(<a href="../../../doctrine/dbal/platforms/abstractplatform.html">AbstractPlatform</a> platform)</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/schemadiff.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>