373 lines
16 KiB
HTML
373 lines
16 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>Schema (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/schema.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\Schema</div>
|
|
<div class="location">/Doctrine/DBAL/Schema/Schema.php at line 37</div>
|
|
|
|
<h1>Class Schema</h1>
|
|
|
|
<pre class="tree">Class:Schema - Superclass: AbstractAsset
|
|
<a href="../../../doctrine/dbal/schema/abstractasset.html">AbstractAsset</a><br> ⌊ <strong>Schema</strong><br /></pre>
|
|
|
|
<hr>
|
|
|
|
<p class="signature">public class <strong>Schema</strong><br>extends <a href="../../../doctrine/dbal/schema/abstractasset.html">AbstractAsset</a>
|
|
|
|
</p>
|
|
|
|
<div class="comment" id="overview_description"><p>Object representation of a database schema</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 <a href="../../../doctrine/dbal/schema/schemaconfig.html">SchemaConfig</a></td>
|
|
<td class="description"><p class="name"><a href="#_schemaConfig">$_schemaConfig</a></p><p class="description"></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type">protected array</td>
|
|
<td class="description"><p class="name"><a href="#_sequences">$_sequences</a></p><p class="description"></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type">protected array</td>
|
|
<td class="description"><p class="name"><a href="#_tables">$_tables</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="#Schema()">Schema</a>(array tables, <a href="../../../doctrine/dbal/schema/schemaconfig.html">SchemaConfig</a> schemaConfig, array sequences, array views, array triggers)</p><p class="description"></p></td>
|
|
</tr>
|
|
</table>
|
|
|
|
<table id="summary_method">
|
|
<tr><th colspan="2">Method Summary</th></tr>
|
|
<tr>
|
|
<td class="type"> <a href="../../../doctrine/dbal/schema/sequence.html">Sequence</a></td>
|
|
<td class="description"><p class="name"><a href="#createSequence()">createSequence</a>(string sequenceName, int allocationSize, int initialValue)</p><p class="description">Create a new sequence</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> <a href="../../../doctrine/dbal/schema/table.html">Table</a></td>
|
|
<td class="description"><p class="name"><a href="#createTable()">createTable</a>(string tableName)</p><p class="description">Create a new table</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> <a href="../../../doctrine/dbal/schema/schema.html">Schema</a></td>
|
|
<td class="description"><p class="name"><a href="#dropSequence()">dropSequence</a>(string sequenceName)</p><p class="description"></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> <a href="../../../doctrine/dbal/schema/schema.html">Schema</a></td>
|
|
<td class="description"><p class="name"><a href="#dropTable()">dropTable</a>(string tableName)</p><p class="description">Drop a table from the schema.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> void</td>
|
|
<td class="description"><p class="name"><a href="#getMigrateFromSql()">getMigrateFromSql</a>(<a href="../../../doctrine/dbal/schema/schema.html">Schema</a> fromSchema, <a href="../../../doctrine/dbal/platforms/abstractplatform.html">AbstractPlatform</a> platform)</p><p class="description"></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> void</td>
|
|
<td class="description"><p class="name"><a href="#getMigrateToSql()">getMigrateToSql</a>(<a href="../../../doctrine/dbal/schema/schema.html">Schema</a> toSchema, <a href="../../../doctrine/dbal/platforms/abstractplatform.html">AbstractPlatform</a> platform)</p><p class="description"></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> Doctrine\DBAL\Schema\Sequence</td>
|
|
<td class="description"><p class="name"><a href="#getSequence()">getSequence</a>(string sequenceName)</p><p class="description"></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> Doctrine\DBAL\Schema\Sequence[]</td>
|
|
<td class="description"><p class="name"><a href="#getSequences()">getSequences</a>()</p><p class="description"></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> <a href="../../../doctrine/dbal/schema/table.html">Table</a></td>
|
|
<td class="description"><p class="name"><a href="#getTable()">getTable</a>(string tableName)</p><p class="description"></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> array</td>
|
|
<td class="description"><p class="name"><a href="#getTables()">getTables</a>()</p><p class="description">Get all tables of this schema.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> bool</td>
|
|
<td class="description"><p class="name"><a href="#hasExplicitForeignKeyIndexes()">hasExplicitForeignKeyIndexes</a>()</p><p class="description"></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> bool</td>
|
|
<td class="description"><p class="name"><a href="#hasSequence()">hasSequence</a>(string sequenceName)</p><p class="description"></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> <a href="../../../doctrine/dbal/schema/schema.html">Schema</a></td>
|
|
<td class="description"><p class="name"><a href="#hasTable()">hasTable</a>(string tableName)</p><p class="description">Does this schema have a table with the given name?</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> <a href="../../../doctrine/dbal/schema/schema.html">Schema</a></td>
|
|
<td class="description"><p class="name"><a href="#renameTable()">renameTable</a>(string oldTableName, string newTableName)</p><p class="description">Rename a table</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> array</td>
|
|
<td class="description"><p class="name"><a href="#toDropSql()">toDropSql</a>(<a href="../../../doctrine/dbal/platforms/abstractplatform.html">AbstractPlatform</a> platform)</p><p class="description">Return an array of necessary sql queries to drop the schema on the given platform.</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">Return an array of necessary sql queries to create the schema on the given platform.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> void</td>
|
|
<td class="description"><p class="name"><a href="#visit()">visit</a>(<a href="../../../doctrine/dbal/schema/visitor/visitor.html">Visitor</a> visitor)</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/Schema.php at line 52</div>
|
|
<h3 id="_schemaConfig">_schemaConfig</h3>
|
|
<code class="signature">protected <a href="../../../doctrine/dbal/schema/schemaconfig.html">SchemaConfig</a> <strong>$_schemaConfig</strong> = false</code>
|
|
<div class="details">
|
|
<p></p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Schema/Schema.php at line 47</div>
|
|
<h3 id="_sequences">_sequences</h3>
|
|
<code class="signature">protected array <strong>$_sequences</strong> = array()</code>
|
|
<div class="details">
|
|
<p></p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Schema/Schema.php at line 42</div>
|
|
<h3 id="_tables">_tables</h3>
|
|
<code class="signature">protected array <strong>$_tables</strong> = array()</code>
|
|
<div class="details">
|
|
<p></p></div>
|
|
|
|
<hr>
|
|
|
|
<h2 id="detail_constr">Constructor Detail</h2>
|
|
<div class="location">/Doctrine/DBAL/Schema/Schema.php at line 61</div>
|
|
<h3 id="Schema()">Schema</h3>
|
|
<code class="signature">public <strong>Schema</strong>(array tables, <a href="../../../doctrine/dbal/schema/schemaconfig.html">SchemaConfig</a> schemaConfig, array sequences, array views, array triggers)</code>
|
|
<div class="details">
|
|
<p></p></div>
|
|
|
|
<hr>
|
|
|
|
<h2 id="detail_method">Method Detail</h2>
|
|
<div class="location">/Doctrine/DBAL/Schema/Schema.php at line 230</div>
|
|
<h3 id="createSequence()">createSequence</h3>
|
|
<code class="signature">public <a href="../../../doctrine/dbal/schema/sequence.html">Sequence</a> <strong>createSequence</strong>(string sequenceName, int allocationSize, int initialValue)</code>
|
|
<div class="details">
|
|
<p>Create a new sequence</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Schema/Schema.php at line 184</div>
|
|
<h3 id="createTable()">createTable</h3>
|
|
<code class="signature">public <a href="../../../doctrine/dbal/schema/table.html">Table</a> <strong>createTable</strong>(string tableName)</code>
|
|
<div class="details">
|
|
<p>Create a new table</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Schema/Schema.php at line 241</div>
|
|
<h3 id="dropSequence()">dropSequence</h3>
|
|
<code class="signature">public <a href="../../../doctrine/dbal/schema/schema.html">Schema</a> <strong>dropSequence</strong>(string sequenceName)</code>
|
|
<div class="details">
|
|
<p></p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Schema/Schema.php at line 214</div>
|
|
<h3 id="dropTable()">dropTable</h3>
|
|
<code class="signature">public <a href="../../../doctrine/dbal/schema/schema.html">Schema</a> <strong>dropTable</strong>(string tableName)</code>
|
|
<div class="details">
|
|
<p>Drop a table from the schema.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Schema/Schema.php at line 291</div>
|
|
<h3 id="getMigrateFromSql()">getMigrateFromSql</h3>
|
|
<code class="signature">public void <strong>getMigrateFromSql</strong>(<a href="../../../doctrine/dbal/schema/schema.html">Schema</a> fromSchema, <a href="../../../doctrine/dbal/platforms/abstractplatform.html">AbstractPlatform</a> platform)</code>
|
|
<div class="details">
|
|
<p></p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Schema/Schema.php at line 280</div>
|
|
<h3 id="getMigrateToSql()">getMigrateToSql</h3>
|
|
<code class="signature">public void <strong>getMigrateToSql</strong>(<a href="../../../doctrine/dbal/schema/schema.html">Schema</a> toSchema, <a href="../../../doctrine/dbal/platforms/abstractplatform.html">AbstractPlatform</a> platform)</code>
|
|
<div class="details">
|
|
<p></p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Schema/Schema.php at line 161</div>
|
|
<h3 id="getSequence()">getSequence</h3>
|
|
<code class="signature">public Doctrine\DBAL\Schema\Sequence <strong>getSequence</strong>(string sequenceName)</code>
|
|
<div class="details">
|
|
<p></p><dl>
|
|
<dt>Throws:</dt>
|
|
<dd><a href="../../../doctrine/dbal/schema/schemaexception.html">SchemaException</a></dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Schema/Schema.php at line 173</div>
|
|
<h3 id="getSequences()">getSequences</h3>
|
|
<code class="signature">public Doctrine\DBAL\Schema\Sequence[] <strong>getSequences</strong>()</code>
|
|
<div class="details">
|
|
<p></p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Schema/Schema.php at line 124</div>
|
|
<h3 id="getTable()">getTable</h3>
|
|
<code class="signature">public <a href="../../../doctrine/dbal/schema/table.html">Table</a> <strong>getTable</strong>(string tableName)</code>
|
|
<div class="details">
|
|
<p></p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Schema/Schema.php at line 115</div>
|
|
<h3 id="getTables()">getTables</h3>
|
|
<code class="signature">public array <strong>getTables</strong>()</code>
|
|
<div class="details">
|
|
<p>Get all tables of this schema.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Schema/Schema.php at line 79</div>
|
|
<h3 id="hasExplicitForeignKeyIndexes()">hasExplicitForeignKeyIndexes</h3>
|
|
<code class="signature">public bool <strong>hasExplicitForeignKeyIndexes</strong>()</code>
|
|
<div class="details">
|
|
<p></p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Schema/Schema.php at line 150</div>
|
|
<h3 id="hasSequence()">hasSequence</h3>
|
|
<code class="signature">public bool <strong>hasSequence</strong>(string sequenceName)</code>
|
|
<div class="details">
|
|
<p></p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Schema/Schema.php at line 140</div>
|
|
<h3 id="hasTable()">hasTable</h3>
|
|
<code class="signature">public <a href="../../../doctrine/dbal/schema/schema.html">Schema</a> <strong>hasTable</strong>(string tableName)</code>
|
|
<div class="details">
|
|
<p>Does this schema have a table with the given name?</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Schema/Schema.php at line 198</div>
|
|
<h3 id="renameTable()">renameTable</h3>
|
|
<code class="signature">public <a href="../../../doctrine/dbal/schema/schema.html">Schema</a> <strong>renameTable</strong>(string oldTableName, string newTableName)</code>
|
|
<div class="details">
|
|
<p>Rename a table</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Schema/Schema.php at line 268</div>
|
|
<h3 id="toDropSql()">toDropSql</h3>
|
|
<code class="signature">public array <strong>toDropSql</strong>(<a href="../../../doctrine/dbal/platforms/abstractplatform.html">AbstractPlatform</a> platform)</code>
|
|
<div class="details">
|
|
<p>Return an array of necessary sql queries to drop the schema on the given platform.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Schema/Schema.php at line 254</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>Return an array of necessary sql queries to create the schema on the given platform.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Schema/Schema.php at line 301</div>
|
|
<h3 id="visit()">visit</h3>
|
|
<code class="signature">public void <strong>visit</strong>(<a href="../../../doctrine/dbal/schema/visitor/visitor.html">Visitor</a> visitor)</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/schema.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> |