<!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>Comparator (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/comparator.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\Comparator</div> <div class="location">/Doctrine/DBAL/Schema/Comparator.php at line 35</div> <h1>Class Comparator</h1> <pre class="tree"><strong>Comparator</strong><br /></pre> <hr> <p class="signature">public class <strong>Comparator</strong></p> <div class="comment" id="overview_description"><p>Compare to Schemas and return an instance of SchemaDiff</p></div> <dl> <dt>Copyright:</dt> <dd>Copyright (C) 2005-2009 eZ Systems AS. All rights reserved.</dd> <dt>License:</dt> <dd>http://ez.no/licenses/new_bsd New BSD License</dd> <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_method"> <tr><th colspan="2">Method Summary</th></tr> <tr> <td class="type"> void</td> <td class="description"><p class="name"><a href="#addColumnPlatformOptionCheck()">addColumnPlatformOptionCheck</a>(string optionName)</p><p class="description"></p></td> </tr> <tr> <td class="type"> <a href="../../../doctrine/dbal/schema/schemadiff.html">SchemaDiff</a></td> <td class="description"><p class="name"><a href="#compare()">compare</a>(<a href="../../../doctrine/dbal/schema/schema.html">Schema</a> fromSchema, <a href="../../../doctrine/dbal/schema/schema.html">Schema</a> toSchema)</p><p class="description">Returns a SchemaDiff object containing the differences between the schemas $fromSchema and $toSchema. </p></td> </tr> <tr> <td class="type">static <a href="../../../doctrine/dbal/schema/schemadiff.html">SchemaDiff</a></td> <td class="description"><p class="name"><a href="#compareSchemas()">compareSchemas</a>(<a href="../../../doctrine/dbal/schema/schema.html">Schema</a> fromSchema, <a href="../../../doctrine/dbal/schema/schema.html">Schema</a> toSchema)</p><p class="description"></p></td> </tr> <tr> <td class="type"> array</td> <td class="description"><p class="name"><a href="#diffColumn()">diffColumn</a>(<a href="../../../doctrine/dbal/schema/column.html">Column</a> column1, <a href="../../../doctrine/dbal/schema/column.html">Column</a> column2)</p><p class="description">Returns the difference between the fields $field1 and $field2. </p></td> </tr> <tr> <td class="type"> bool</td> <td class="description"><p class="name"><a href="#diffForeignKey()">diffForeignKey</a>(<a href="../../../doctrine/dbal/schema/foreignkeyconstraint.html">ForeignKeyConstraint</a> key1, <a href="../../../doctrine/dbal/schema/foreignkeyconstraint.html">ForeignKeyConstraint</a> key2)</p><p class="description"></p></td> </tr> <tr> <td class="type"> bool</td> <td class="description"><p class="name"><a href="#diffIndex()">diffIndex</a>(<a href="../../../doctrine/dbal/schema/index.html">Index</a> index1, <a href="../../../doctrine/dbal/schema/index.html">Index</a> index2)</p><p class="description">Finds the difference between the indexes $index1 and $index2. </p></td> </tr> <tr> <td class="type"> void</td> <td class="description"><p class="name"><a href="#diffSequence()">diffSequence</a>(<a href="../../../doctrine/dbal/schema/sequence.html">Sequence</a> sequence1, <a href="../../../doctrine/dbal/schema/sequence.html">Sequence</a> sequence2)</p><p class="description"></p></td> </tr> <tr> <td class="type"> bool|TableDiff</td> <td class="description"><p class="name"><a href="#diffTable()">diffTable</a>(<a href="../../../doctrine/dbal/schema/table.html">Table</a> table1, <a href="../../../doctrine/dbal/schema/table.html">Table</a> table2)</p><p class="description">Returns the difference between the tables $table1 and $table2. </p></td> </tr> </table> <h2 id="detail_method">Method Detail</h2> <div class="location">/Doctrine/DBAL/Schema/Comparator.php at line 45</div> <h3 id="addColumnPlatformOptionCheck()">addColumnPlatformOptionCheck</h3> <code class="signature">public void <strong>addColumnPlatformOptionCheck</strong>(string optionName)</code> <div class="details"> <p></p></div> <hr> <div class="location">/Doctrine/DBAL/Schema/Comparator.php at line 73</div> <h3 id="compare()">compare</h3> <code class="signature">public <a href="../../../doctrine/dbal/schema/schemadiff.html">SchemaDiff</a> <strong>compare</strong>(<a href="../../../doctrine/dbal/schema/schema.html">Schema</a> fromSchema, <a href="../../../doctrine/dbal/schema/schema.html">Schema</a> toSchema)</code> <div class="details"> <p>Returns a SchemaDiff object containing the differences between the schemas $fromSchema and $toSchema.</p><p>The returned diferences are returned in such a way that they contain the operations to change the schema stored in $fromSchema to the schema that is stored in $toSchema.</p></div> <hr> <div class="location">/Doctrine/DBAL/Schema/Comparator.php at line 55</div> <h3 id="compareSchemas()">compareSchemas</h3> <code class="signature">public static <a href="../../../doctrine/dbal/schema/schemadiff.html">SchemaDiff</a> <strong>compareSchemas</strong>(<a href="../../../doctrine/dbal/schema/schema.html">Schema</a> fromSchema, <a href="../../../doctrine/dbal/schema/schema.html">Schema</a> toSchema)</code> <div class="details"> <p></p></div> <hr> <div class="location">/Doctrine/DBAL/Schema/Comparator.php at line 305</div> <h3 id="diffColumn()">diffColumn</h3> <code class="signature">public array <strong>diffColumn</strong>(<a href="../../../doctrine/dbal/schema/column.html">Column</a> column1, <a href="../../../doctrine/dbal/schema/column.html">Column</a> column2)</code> <div class="details"> <p>Returns the difference between the fields $field1 and $field2.</p><p>If there are differences this method returns $field2, otherwise the boolean false.</p></div> <hr> <div class="location">/Doctrine/DBAL/Schema/Comparator.php at line 273</div> <h3 id="diffForeignKey()">diffForeignKey</h3> <code class="signature">public bool <strong>diffForeignKey</strong>(<a href="../../../doctrine/dbal/schema/foreignkeyconstraint.html">ForeignKeyConstraint</a> key1, <a href="../../../doctrine/dbal/schema/foreignkeyconstraint.html">ForeignKeyConstraint</a> key2)</code> <div class="details"> <p></p></div> <hr> <div class="location">/Doctrine/DBAL/Schema/Comparator.php at line 366</div> <h3 id="diffIndex()">diffIndex</h3> <code class="signature">public bool <strong>diffIndex</strong>(<a href="../../../doctrine/dbal/schema/index.html">Index</a> index1, <a href="../../../doctrine/dbal/schema/index.html">Index</a> index2)</code> <div class="details"> <p>Finds the difference between the indexes $index1 and $index2.</p><p>Compares $index1 with $index2 and returns $index2 if there are any differences or false in case there are no differences.</p></div> <hr> <div class="location">/Doctrine/DBAL/Schema/Comparator.php at line 140</div> <h3 id="diffSequence()">diffSequence</h3> <code class="signature">public void <strong>diffSequence</strong>(<a href="../../../doctrine/dbal/schema/sequence.html">Sequence</a> sequence1, <a href="../../../doctrine/dbal/schema/sequence.html">Sequence</a> sequence2)</code> <div class="details"> <p></p></div> <hr> <div class="location">/Doctrine/DBAL/Schema/Comparator.php at line 163</div> <h3 id="diffTable()">diffTable</h3> <code class="signature">public bool|TableDiff <strong>diffTable</strong>(<a href="../../../doctrine/dbal/schema/table.html">Table</a> table1, <a href="../../../doctrine/dbal/schema/table.html">Table</a> table2)</code> <div class="details"> <p>Returns the difference between the tables $table1 and $table2.</p><p>If there are no differences this method returns the boolean false.</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/comparator.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>