<div id="content">
<h1 align="center">Source for file Schema.php</h1>
<p>Documentation is available at <a href="../Doctrine/_Doctrine---Import---Schema.php.html">Schema.php</a></p>
<div class="src-code"><span class="php">
<ol><li><div class="src-line"><a name="a1"></a><span class="src-php"><?php</span></div></li>
<li><div class="src-line"><a name="a2"></a><span class="src-comm">/*</span></div></li>
<li><div class="src-line"><a name="a3"></a><span class="src-comm"> * $Id: Schema.php 1838 2007-06-26 00:58:21Z nicobn $</span></div></li>
<li><div class="src-line"><a name="a4"></a><span class="src-comm"> *</span></div></li>
<li><div class="src-line"><a name="a5"></a><span class="src-comm"> * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS</span></div></li>
<li><div class="src-line"><a name="a6"></a><span class="src-comm"> * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT</span></div></li>
<li><div class="src-line"><a name="a7"></a><span class="src-comm"> * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR</span></div></li>
<li><div class="src-line"><a name="a8"></a><span class="src-comm"> * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT</span></div></li>
<li><div class="src-line"><a name="a9"></a><span class="src-comm"> * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,</span></div></li>
<li><div class="src-line"><a name="a10"></a><span class="src-comm"> * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT</span></div></li>
<li><div class="src-line"><a name="a11"></a><span class="src-comm"> * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,</span></div></li>
<li><div class="src-line"><a name="a12"></a><span class="src-comm"> * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY</span></div></li>
<li><div class="src-line"><a name="a13"></a><span class="src-comm"> * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT</span></div></li>
<li><div class="src-line"><a name="a14"></a><span class="src-comm"> * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE</span></div></li>
<li><div class="src-line"><a name="a15"></a><span class="src-comm"> * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span></div></li>
<li><div class="src-line"><a name="a16"></a><span class="src-comm"> *</span></div></li>
<li><div class="src-line"><a name="a17"></a><span class="src-comm"> * This software consists of voluntary contributions made by many individuals</span></div></li>
<li><div class="src-line"><a name="a18"></a><span class="src-comm"> * and is licensed under the LGPL. For more information, see</span></div></li>
<li><div class="src-line"><a name="a19"></a><span class="src-comm"> * <http://www.phpdoctrine.com>.</span></div></li>
<li><div class="src-line"><a name="a20"></a><span class="src-comm"> */</span></div></li>
<li><div class="src-line"><a name="a21"></a> </div></li>
<li><div class="src-line"><a name="a22"></a><span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a23"></a><span class="src-doc"> * class Doctrine_Import_Schema</span></div></li>
<li><div class="src-line"><a name="a24"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a25"></a><span class="src-doc"> * Different methods to import a XML schema. The logic behind using two different</span></div></li>
<li><div class="src-line"><a name="a26"></a><span class="src-doc"> * methods is simple. Some people will like the idea of producing Doctrine_Record</span></div></li>
<li><div class="src-line"><a name="a27"></a><span class="src-doc"> * objects directly, which is totally fine. But in fast and growing application,</span></div></li>
<li><div class="src-line"><a name="a28"></a><span class="src-doc"> * table definitions tend to be a little bit more volatile. importArr() can be used</span></div></li>
<li><div class="src-line"><a name="a29"></a><span class="src-doc"> * to output a table definition in a PHP file. This file can then be stored</span></div></li>
<li><div class="src-line"><a name="a30"></a><span class="src-doc"> * independantly from the object itself.</span></div></li>
<li><div class="src-line"><a name="a31"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a32"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@package</span><span class="src-doc"> Doctrine</span></div></li>
<li><div class="src-line"><a name="a33"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@category</span><span class="src-doc"> Object Relational Mapping</span></div></li>
<li><div class="src-line"><a name="a34"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@link</span><span class="src-doc"> www.phpdoctrine.com</span></div></li>
<li><div class="src-line"><a name="a35"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@license</span><span class="src-doc"> http://www.opensource.org/licenses/lgpl-license.php LGPL</span></div></li>
<li><div class="src-line"><a name="a36"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@version</span><span class="src-doc"> $Revision: 1838 $</span></div></li>
<li><div class="src-line"><a name="a37"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@author</span><span class="src-doc"> Nicolas Bérard-Nault <nicobn@gmail.com></span></div></li>
<li><div class="src-line"><a name="a38"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@author</span><span class="src-doc"> Jonathan H. Wage <jonwage@gmail.com></span></div></li>
<li><div class="src-line"><a name="a39"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a40"></a><span class="src-key">abstract </span><span class="src-key">class </span><a href="../Doctrine/Doctrine_Import_Schema.html">Doctrine_Import_Schema</a></div></li>
<li><div class="src-line"><a name="a41"></a><span class="src-sym">{</span></div></li>
<li><div class="src-line"><a name="a42"></a> <span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a43"></a><span class="src-doc"> * parse</span></div></li>
<li><div class="src-line"><a name="a44"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a45"></a><span class="src-doc"> * Function to do the actual parsing of the file</span></div></li>
<li><div class="src-line"><a name="a46"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a47"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$schema </span></div></li>
<li><div class="src-line"><a name="a48"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">void </span></div></li>
<li><div class="src-line"><a name="a49"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@author</span><span class="src-doc"> Jonathan H. Wage</span></div></li>
<li><div class="src-line"><a name="a50"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a51"></a> </div></li>
<li><div class="src-line"><a name="a52"></a> <span class="src-key">abstract </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Import_Schema.html#methodparse">parse</a><span class="src-sym">(</span><span class="src-var">$schema</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a53"></a> </div></li>
<li><div class="src-line"><a name="a54"></a> <span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a55"></a><span class="src-doc"> * Parse the schema and return it in an array</span></div></li>
<li><div class="src-line"><a name="a56"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a57"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc"> </span><span class="src-doc-type">string </span><span class="src-doc-var">$schema </span></div></li>
<li><div class="src-line"><a name="a58"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@access</span><span class="src-doc"> public</span></div></li>
<li><div class="src-line"><a name="a59"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a60"></a> <span class="src-key">abstract </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Import_Schema.html#methodparseSchema">parseSchema</a><span class="src-sym">(</span><span class="src-var">$schema</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a61"></a> </div></li>
<li><div class="src-line"><a name="a62"></a> <span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a63"></a><span class="src-doc"> * importSchema</span></div></li>
<li><div class="src-line"><a name="a64"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a65"></a><span class="src-doc"> * A method to import a Schema and translate it into a Doctrine_Record object</span></div></li>
<li><div class="src-line"><a name="a66"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a67"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc"> </span><span class="src-doc-type">string </span><span class="src-doc-var">$schema </span><span class="src-doc"> The file containing the XML schema</span></div></li>
<li><div class="src-line"><a name="a68"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc"> </span><span class="src-doc-type">string </span><span class="src-doc-var">$directory </span><span class="src-doc"> The directory where the Doctrine_Record class will</span></div></li>
<li><div class="src-line"><a name="a69"></a><span class="src-doc"> * be written</span></div></li>
<li><div class="src-line"><a name="a70"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@access</span><span class="src-doc"> public</span></div></li>
<li><div class="src-line"><a name="a71"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a72"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Import_Schema.html#methodimportSchema">importSchema</a><span class="src-sym">(</span><span class="src-var">$schema</span><span class="src-sym">, </span><span class="src-var">$directory</span><span class="src-sym">)</span></div></li>
<li><div class="src-line"><a name="a73"></a> <span class="src-sym">{</span></div></li>
<li><div class="src-line"><a name="a74"></a> <span class="src-var">$builder </span>= <span class="src-key">new </span><span class="src-id"><a href="../Doctrine/Doctrine_Import_Builder.html">Doctrine_Import_Builder</a></span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a75"></a> <span class="src-var">$builder</span><span class="src-sym">-></span><span class="src-id">setTargetPath</span><span class="src-sym">(</span><span class="src-var">$directory</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a76"></a> </div></li>
<li><div class="src-line"><a name="a77"></a> <span class="src-var">$array </span>= <span class="src-var">$this</span><span class="src-sym">-></span><a href="../Doctrine/Doctrine_Import_Schema.html#methodparseSchema">parseSchema</a><span class="src-sym">(</span><span class="src-var">$schema</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a78"></a> </div></li>
<li><div class="src-line"><a name="a79"></a> <span class="src-key">foreach </span><span class="src-sym">(</span><span class="src-var">$array </span><span class="src-key">as </span><span class="src-var">$name </span>=> <span class="src-var">$properties</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
<li><div class="src-line"><a name="a80"></a> <span class="src-var">$options</span><span class="src-sym">[</span><span class="src-str">'className'</span><span class="src-sym">] </span>= <span class="src-var">$properties</span><span class="src-sym">[</span><span class="src-str">'class'</span><span class="src-sym">]</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a81"></a> <span class="src-var">$options</span><span class="src-sym">[</span><span class="src-str">'fileName'</span><span class="src-sym">] </span>= <span class="src-var">$directory</span>.<span class="src-id">DIRECTORY_SEPARATOR</span>.<span class="src-var">$properties</span><span class="src-sym">[</span><span class="src-str">'class'</span><span class="src-sym">]</span>.<span class="src-str">'.class.php'</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a82"></a> </div></li>
<li><div class="src-line"><a name="a83"></a> <span class="src-var">$columns </span>= <span class="src-var">$properties</span><span class="src-sym">[</span><span class="src-str">'columns'</span><span class="src-sym">]</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a84"></a> </div></li>
<li><div class="src-line"><a name="a85"></a> <span class="src-var">$builder</span><span class="src-sym">-></span><span class="src-id">buildRecord</span><span class="src-sym">(</span><span class="src-var">$options</span><span class="src-sym">, </span><span class="src-var">$columns</span><span class="src-sym">, </span><span class="src-key">array</span><span class="src-sym">(</span><span class="src-sym">))</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a86"></a> <span class="src-sym">}</span></div></li>
<li><div class="src-line"><a name="a87"></a> <span class="src-sym">} </span></div></li>
<li><div class="src-line"><a name="a88"></a><span class="src-sym">}</span></div></li>
</ol>
</span></div>
</div>