Myobjects > Docs / Api / MyObjectsCompiler / DDLField.html

Questions? Need Help? Want to share? » PHP Forum
Script Name:
Myobjects

Download:
myobjects.zip

Category:
Development Tools

Archive Content:

Compiler

Compiler > CVS

Compiler

CVS

Docs > Api

Docs > Api > CVS

Docs > Api

Docs > Api > Media

Docs > Api > Media > CVS

Docs > Api > Media

Docs > Api > MyObjectsCommandLineClient

Docs > Api > MyObjectsCommandLineClient > CVS

Docs > Api > MyObjectsCommandLineClient

Docs > Api > MyObjectsCompiler

Docs > Api > MyObjectsCompiler > CVS

Docs > Api > MyObjectsCompiler

Docs > Api > MyObjectsRuntime > CVS

Docs > Api > MyObjectsRuntime

Docs > Api > MyObjectsWebClient

Docs > Api > MyObjectsWebClient > CVS

Docs > Api > MyObjectsWebClient

Docs > Api

Docs > Api > UserManagerExample

Docs > Api > UserManagerExample > CVS

Docs > Api > UserManagerExample

Docs > Api > WorldExample

Docs > Api > WorldExample > CVS

Docs > Api > WorldExample

Docs > Api > Filesource > CVS

Docs > Api > Filesource

Docs

Docs > CVS

Docs

Docs > Ddl Files

Docs > Ddl Files > CVS

Docs > Ddl Files

Docs

Docs > Developer

Docs > Developer > CVS

Docs

Docs > Images > CVS

Docs > Images

Docs

Docs > Mapable Files

Docs > Mapable Files > CVS

Docs > Mapable Files

Docs

Docs > Project Files > CVS

Docs > Project Files

Docs

Example App > CVS

Example App > User Manager > Casestudy > CVS

Example App > User Manager > Casestudy

Example App > User Manager

Example App > User Manager > CVS

Example App > User Manager

Example App > World Database > CVS

Example App > World Database

Example App > World Database > World

Example App > World Database > World > CVS

Example App > World Database > World

Example App > World Database

Runtime

Runtime > CVS

Runtime

Webclient > Actions

Webclient > Actions > CVS

Webclient > Actions

Webclient > CVS

Webclient > Images

Webclient > Images > CVS

Webclient > Images

Webclient

Webclient > Scripts > CVS

Webclient > Scripts

Webclient > Templates

Webclient > Templates > CVS

Webclient > Templates

Webclient > Tmp > CVS

Webclient

Content:

DDLField.html:


<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
<head>
    <title>Docs For Class DDLField</title>
    <link rel="stylesheet" type="text/css" href="../media/style.css">
    <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
</head>
<body>

<table border="0" cellspacing="0" cellpadding="0" height="48" width="100%">
  <tr>
    <td class="header-top-left">&nbsp;</td>
    <td class="header-top-right">MyObjectsCompiler<br /><div class="header-top-right-subpackage"></div></td>
  </tr>
  <tr><td colspan="2" class="header-line"><img src="../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
  <tr>
    <td colspan="2" class="header-menu">
            [ <a href="../classtrees_MyObjectsCompiler.html" class="menu">class tree: MyObjectsCompiler</a> ]
          [ <a href="../elementindex_MyObjectsCompiler.html" class="menu">index: MyObjectsCompiler</a> ]
          [ <a href="../elementindex.html" class="menu">all elements</a> ]
    </td>
  </tr>
  <tr><td colspan="2" class="header-line"><img src="../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
</table>

<table width="100%" border="0" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="195" class="menu">
        <div class="package-title">MyObjectsCompiler</div>
  <div class="package">
    <div id="ric">
                    <p><a href="../ric_changelog.html">changelog</a></p>
                    <p><a href="../ric_install.html">install</a></p>
                    <p><a href="../ric_license.html">license</a></p>
            </div>
    </div>
      <b>Packages:</b><br />
  <div class="package">
              <a href="../li_MyObjectsCommandLineClient.html">MyObjectsCommandLineClient</a><br />
              <a href="../li_MyObjectsCompiler.html">MyObjectsCompiler</a><br />
              <a href="../li_MyObjectsRuntime.html">MyObjectsRuntime</a><br />
              <a href="../li_MyObjectsWebClient.html">MyObjectsWebClient</a><br />
              <a href="../li_UserManagerExample.html">UserManagerExample</a><br />
              <a href="../li_WorldExample.html">WorldExample</a><br />
          </div>
      <br />
                        <b>Files:</b><br />
        <div class="package">
                <span style="padding-left: 1em;"><a href="../MyObjectsCompiler/_compiler_ClassCompiler_php.html">ClassCompiler.php</a></span><br />
            <span style="padding-left: 1em;"><a href="../MyObjectsCompiler/_compiler_DDL_php.html">DDL.php</a></span><br />
            <span style="padding-left: 1em;"><a href="../MyObjectsCompiler/_compiler_DefaultClassGenerator_php.html">DefaultClassGenerator.php</a></span><br />
            <span style="padding-left: 1em;"><a href="../MyObjectsCompiler/_compiler_Exceptions_php.html">Exceptions.php</a></span><br />
      </div>
            <br />
            <b>Classes:</b><br />
        <div class="package">
                    <a href="../MyObjectsCompiler/BooleanFlagNotSetException.html">BooleanFlagNotSetException</a>         <br />
                <a href="../MyObjectsCompiler/ClassGenerator.html">ClassGenerator</a>         <br />
                <a href="../MyObjectsCompiler/Compiler.html">Compiler</a>         <br />
                <a href="../MyObjectsCompiler/CompileTimeException.html">CompileTimeException</a>         <br />
                <a href="../MyObjectsCompiler/DDL.html">DDL</a>         <br />
                <a href="../MyObjectsCompiler/DDLData.html">DDLData</a>         <br />
                <a href="../MyObjectsCompiler/DDLDatabase.html">DDLDatabase</a>         <br />
                <a href="../MyObjectsCompiler/DDLEnumData.html">DDLEnumData</a>         <br />
                <a href="../MyObjectsCompiler/DDLEnumValue.html">DDLEnumValue</a>         <br />
                <a href="../MyObjectsCompiler/DDLField.html">DDLField</a>         <br />
                <a href="../MyObjectsCompiler/DDLFileNotValidException.html">DDLFileNotValidException</a>         <br />
                <a href="../MyObjectsCompiler/DDLNumericData.html">DDLNumericData</a>         <br />
                <a href="../MyObjectsCompiler/DDLSetData.html">DDLSetData</a>         <br />
                <a href="../MyObjectsCompiler/DDLTable.html">DDLTable</a>         <br />
                <a href="../MyObjectsCompiler/DDLTextData.html">DDLTextData</a>         <br />
                <a href="../MyObjectsCompiler/DDLTimeData.html">DDLTimeData</a>         <br />
                <a href="../MyObjectsCompiler/DDLVersionNotSupportedException.html">DDLVersionNotSupportedException</a>         <br />
                <a href="../MyObjectsCompiler/DefaultClassGenerator.html">DefaultClassGenerator</a>         <br />
                <a href="../MyObjectsCompiler/InvalidBooleanFieldException.html">InvalidBooleanFieldException</a>         <br />
                <a href="../MyObjectsCompiler/InvalidForeignKeyException.html">InvalidForeignKeyException</a>         <br />
      </div>
                </td>
    <td>
      <table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">

<h1>Class: DDLField</h1>
Source Location: /compiler/DDL.php<br /><br />

<h2 class="class-name">Class DDLField</h2>

<a name="sec-description"></a>
<div class="info-box">
    <div class="info-box-title">Class Overview</div>
    <div class="nav-bar">
                    <span class="disabled">Class Overview</span> |
                                                            <a href="#sec-var-summary">Properties Summary</a> | <a href="#sec-vars">Properties Detail</a>
                        |                                            <a href="#sec-method-summary">Method Summary</a> | <a href="#sec-methods">Methods Detail</a>
                                            </div>
    <div class="info-box-body">
        <table width="100%" border="0">
        <tr><td valign="top" width="60%" class="class-overview">

        <p align="center" class="short-description"><strong>Represents fields of tables defined in the ddl file
</strong></p>

        <p class="notes">
            Located in <a class="field" href="_compiler_DDL_php.html">/compiler/DDL.php</a> [<span class="field">line <a href="..//__filesource/fsource_MyObjectsCompiler__compilerDDL.php.html#a1313">1313</a></span>]
        </p>

        
        <pre></pre>

        
                <strong>Author(s):</strong>
        <ul>
                                    <li>Erdinc Yilmazel &lt;<a href="mailto:erdinc <at> yilmazel <dot> com">erdinc <at> yilmazel <dot> com</a>&gt;</li>
                                                      </ul>
        
        
<strong>Information Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
                <tr><td><strong>Version:</strong>&nbsp;&nbsp;</td><td>1.0</td></tr>
    </table>
        </td>

                <td valign="top" width="20%" class="class-overview">
        <p align="center" class="short-description"><strong><a href="#sec_vars">Properties</a></strong></p>
        <ul>
                    <li><a href="../MyObjectsCompiler/DDLField.html#var$autoIncrement">$autoIncrement</a></li>
                    <li><a href="../MyObjectsCompiler/DDLField.html#var$data">$data</a></li>
                    <li><a href="../MyObjectsCompiler/DDLField.html#var$description">$description</a></li>
                    <li><a href="../MyObjectsCompiler/DDLField.html#var$foreignKey">$foreignKey</a></li>
                    <li><a href="../MyObjectsCompiler/DDLField.html#var$foreignObject">$foreignObject</a></li>
                    <li><a href="../MyObjectsCompiler/DDLField.html#var$foreignTable">$foreignTable</a></li>
                    <li><a href="../MyObjectsCompiler/DDLField.html#var$getterFunction">$getterFunction</a></li>
                    <li><a href="../MyObjectsCompiler/DDLField.html#var$name">$name</a></li>
                    <li><a href="../MyObjectsCompiler/DDLField.html#var$parent">$parent</a></li>
                    <li><a href="../MyObjectsCompiler/DDLField.html#var$primaryKey">$primaryKey</a></li>
                    <li><a href="../MyObjectsCompiler/DDLField.html#var$required">$required</a></li>
                    <li><a href="../MyObjectsCompiler/DDLField.html#var$setterFunction">$setterFunction</a></li>
                    <li><a href="../MyObjectsCompiler/DDLField.html#var$unique">$unique</a></li>
                  </ul>
        </td>
        
                <td valign="top" width="20%" class="class-overview">
        <p align="center" class="short-description"><strong><a href="#sec_methods">Methods</a></strong></p>
        <ul>
                    <li><a href="../MyObjectsCompiler/DDLField.html#method__construct">__construct</a></li>
                    <li><a href="../MyObjectsCompiler/DDLField.html#methodcreateXmlElement">createXmlElement</a></li>
                    <li><a href="../MyObjectsCompiler/DDLField.html#methodgetData">getData</a></li>
                    <li><a href="../MyObjectsCompiler/DDLField.html#methodgetDescription">getDescription</a></li>
                    <li><a href="../MyObjectsCompiler/DDLField.html#methodgetForeignClass">getForeignClass</a></li>
                    <li><a href="../MyObjectsCompiler/DDLField.html#methodgetForeignKey">getForeignKey</a></li>
                    <li><a href="../MyObjectsCompiler/DDLField.html#methodgetForeignObject">getForeignObject</a></li>
                    <li><a href="../MyObjectsCompiler/DDLField.html#methodgetForeignTable">getForeignTable</a></li>
                    <li><a href="../MyObjectsCompiler/DDLField.html#methodgetGetterFunction">getGetterFunction</a></li>
                    <li><a href="../MyObjectsCompiler/DDLField.html#methodgetName">getName</a></li>
                    <li><a href="../MyObjectsCompiler/DDLField.html#methodgetParent">getParent</a></li>
                    <li><a href="../MyObjectsCompiler/DDLField.html#methodgetSetterFunction">getSetterFunction</a></li>
                    <li><a href="../MyObjectsCompiler/DDLField.html#methodisAutoIncremented">isAutoIncremented</a></li>
                    <li><a href="../MyObjectsCompiler/DDLField.html#methodisForeignKey">isForeignKey</a></li>
                    <li><a href="../MyObjectsCompiler/DDLField.html#methodisPrimaryKey">isPrimaryKey</a></li>
                    <li><a href="../MyObjectsCompiler/DDLField.html#methodisRequired">isRequired</a></li>
                    <li><a href="../MyObjectsCompiler/DDLField.html#methodisUnique">isUnique</a></li>
                    <li><a href="../MyObjectsCompiler/DDLField.html#methodsetAutoIncrement">setAutoIncrement</a></li>
                    <li><a href="../MyObjectsCompiler/DDLField.html#methodsetData">setData</a></li>
                    <li><a href="../MyObjectsCompiler/DDLField.html#methodsetDescription">setDescription</a></li>
                    <li><a href="../MyObjectsCompiler/DDLField.html#methodsetForeignKey">setForeignKey</a></li>
                    <li><a href="../MyObjectsCompiler/DDLField.html#methodsetForeignObject">setForeignObject</a></li>
                    <li><a href="../MyObjectsCompiler/DDLField.html#methodsetForeignTable">setForeignTable</a></li>
                    <li><a href="../MyObjectsCompiler/DDLField.html#methodsetGetterFunction">setGetterFunction</a></li>
                    <li><a href="../MyObjectsCompiler/DDLField.html#methodsetName">setName</a></li>
                    <li><a href="../MyObjectsCompiler/DDLField.html#methodsetParent">setParent</a></li>
                    <li><a href="../MyObjectsCompiler/DDLField.html#methodsetPrimaryKey">setPrimaryKey</a></li>
                    <li><a href="../MyObjectsCompiler/DDLField.html#methodsetRequired">setRequired</a></li>
                    <li><a href="../MyObjectsCompiler/DDLField.html#methodsetSetterFunction">setSetterFunction</a></li>
                    <li><a href="../MyObjectsCompiler/DDLField.html#methodsetUnique">setUnique</a></li>
                    <li><a href="../MyObjectsCompiler/DDLField.html#methodtoSql">toSql</a></li>
                    <li><a href="../MyObjectsCompiler/DDLField.html#method__toString">__toString</a></li>
                  </ul>
        </td>
        
        </tr></table>
        <div class="top">[ <a href="#top">Top</a> ]</div>
    </div>
</div>




    <a name="sec-var-summary"></a>
    <div class="info-box">
        <div class="info-box-title">Property Summary</span></div>
        <div class="nav-bar">
            <a href="#sec-description">Class Overview</a> |
                                    <span class="disabled">Property Summary</span> | <a href="#sec-vars">Properties Detail</a>
                                                <a href="#sec-method-summary">Method Summary</a> | <a href="#sec-methods">Methods Detail</a>
                                                                </div>
        <div class="info-box-body">
            <div class="var-summary">
            <table border="0" cellspacing="0" cellpadding="0" class="var-summary">
                            <div class="var-title">
                    <tr><td class="var-title"><span class="var-type-summary">boolean</span>&nbsp;&nbsp;</td>
                    <td class="var-title"><a href="#$autoIncrement" title="details" class="var-name-summary">$autoIncrement</a>&nbsp;&nbsp;</td>
                    <td class="var-summary-description"></td></tr>
                </div>
                                <div class="var-title">
                    <tr><td class="var-title"><span class="var-type-summary"><a href="../MyObjectsCompiler/DDLData.html">DDLData</a></span>&nbsp;&nbsp;</td>
                    <td class="var-title"><a href="#$data" title="details" class="var-name-summary">$data</a>&nbsp;&nbsp;</td>
                    <td class="var-summary-description"></td></tr>
                </div>
                                <div class="var-title">
                    <tr><td class="var-title"><span class="var-type-summary">string</span>&nbsp;&nbsp;</td>
                    <td class="var-title"><a href="#$description" title="details" class="var-name-summary">$description</a>&nbsp;&nbsp;</td>
                    <td class="var-summary-description"></td></tr>
                </div>
                                <div class="var-title">
                    <tr><td class="var-title"><span class="var-type-summary">string</span>&nbsp;&nbsp;</td>
                    <td class="var-title"><a href="#$foreignKey" title="details" class="var-name-summary">$foreignKey</a>&nbsp;&nbsp;</td>
                    <td class="var-summary-description"></td></tr>
                </div>
                                <div class="var-title">
                    <tr><td class="var-title"><span class="var-type-summary">string</span>&nbsp;&nbsp;</td>
                    <td class="var-title"><a href="#$foreignObject" title="details" class="var-name-summary">$foreignObject</a>&nbsp;&nbsp;</td>
                    <td class="var-summary-description"></td></tr>
                </div>
                                <div class="var-title">
                    <tr><td class="var-title"><span class="var-type-summary">string</span>&nbsp;&nbsp;</td>
                    <td class="var-title"><a href="#$foreignTable" title="details" class="var-name-summary">$foreignTable</a>&nbsp;&nbsp;</td>
                    <td class="var-summary-description"></td></tr>
                </div>
                                <div class="var-title">
                    <tr><td class="var-title"><span class="var-type-summary">string</span>&nbsp;&nbsp;</td>
                    <td class="var-title"><a href="#$getterFunction" title="details" class="var-name-summary">$getterFunction</a>&nbsp;&nbsp;</td>
                    <td class="var-summary-description"></td></tr>
                </div>
                                <div class="var-title">
                    <tr><td class="var-title"><span class="var-type-summary">string</span>&nbsp;&nbsp;</td>
                    <td class="var-title"><a href="#$name" title="details" class="var-name-summary">$name</a>&nbsp;&nbsp;</td>
                    <td class="var-summary-description"></td></tr>
                </div>
                                <div class="var-title">
                    <tr><td class="var-title"><span class="var-type-summary"><a href="../MyObjectsCompiler/DDLTable.html">DDLTable</a></span>&nbsp;&nbsp;</td>
                    <td class="var-title"><a href="#$parent" title="details" class="var-name-summary">$parent</a>&nbsp;&nbsp;</td>
                    <td class="var-summary-description"></td></tr>
                </div>
                                <div class="var-title">
                    <tr><td class="var-title"><span class="var-type-summary">boolean</span>&nbsp;&nbsp;</td>
                    <td class="var-title"><a href="#$primaryKey" title="details" class="var-name-summary">$primaryKey</a>&nbsp;&nbsp;</td>
                    <td class="var-summary-description"></td></tr>
                </div>
                                <div class="var-title">
                    <tr><td class="var-title"><span class="var-type-summary">boolean</span>&nbsp;&nbsp;</td>
                    <td class="var-title"><a href="#$required" title="details" class="var-name-summary">$required</a>&nbsp;&nbsp;</td>
                    <td class="var-summary-description"></td></tr>
                </div>
                                <div class="var-title">
                    <tr><td class="var-title"><span class="var-type-summary">string</span>&nbsp;&nbsp;</td>
                    <td class="var-title"><a href="#$setterFunction" title="details" class="var-name-summary">$setterFunction</a>&nbsp;&nbsp;</td>
                    <td class="var-summary-description"></td></tr>
                </div>
                                <div class="var-title">
                    <tr><td class="var-title"><span class="var-type-summary">boolean</span>&nbsp;&nbsp;</td>
                    <td class="var-title"><a href="#$unique" title="details" class="var-name-summary">$unique</a>&nbsp;&nbsp;</td>
                    <td class="var-summary-description"></td></tr>
                </div>
                                </table>
            </div>
            <br /><div class="top">[ <a href="#top">Top</a> ]</div>
        </div>
    </div>

    <a name="sec-method-summary"></a>
    <div class="info-box">
        <div class="info-box-title">Method Summary</span></div>
        <div class="nav-bar">
            <a href="#sec-description">Class Overview</a> |
                                                                        <a href="#sec-var-summary">Properties Summary</a> | <a href="#sec-vars">Properties Detail</a>
                                                                    <span class="disabled">Method Summary</span> | <a href="#sec-methods">Methods Detail</a>
        </div>
        <div class="info-box-body">
            <div class="method-summary">
                <table border="0" cellspacing="0" cellpadding="0" class="method-summary">
                                <div class="method-definition">
                                            <tr><td class="method-definition"><span class="method-result">void</span>&nbsp;&nbsp;</td>
                                        <td class="method-definition"><a href="#__construct" title="details" class="method-name">__construct</a>()&nbsp;&nbsp;</td>
                    <td class="method-definition">Constructs a DDLField</td></tr>
                </div>
                                <div class="method-definition">
                                            <tr><td class="method-definition"><span class="method-result">void</span>&nbsp;&nbsp;</td>
                                        <td class="method-definition"><a href="#createXmlElement" title="details" class="method-name">createXmlElement</a>()&nbsp;&nbsp;</td>
                    <td class="method-definition">Creates the nodes describing this database on the supplied Xml document</td></tr>
                </div>
                                <div class="method-definition">
                                            <tr><td class="method-definition"><span class="method-result"><a href="../MyObjectsCompiler/DDLData.html">DDLData</a></span>&nbsp;&nbsp;</td>
                                        <td class="method-definition"><a href="#getData" title="details" class="method-name">getData</a>()&nbsp;&nbsp;</td>
                    <td class="method-definition">Returns the data model for this field</td></tr>
                </div>
                                <div class="method-definition">
                                            <tr><td class="method-definition"><span class="method-result">string</span>&nbsp;&nbsp;</td>
                                        <td class="method-definition"><a href="#getDescription" title="details" class="method-name">getDescription</a>()&nbsp;&nbsp;</td>
                    <td class="method-definition">Returns the description of this field</td></tr>
                </div>
                                <div class="method-definition">
                                            <tr><td class="method-definition"><span class="method-result">string</span>&nbsp;&nbsp;</td>
                                        <td class="method-definition"><a href="#getForeignClass" title="details" class="method-name">getForeignClass</a>()&nbsp;&nbsp;</td>
                    <td class="method-definition">Returns the class name of the foreign table</td></tr>
                </div>
                                <div class="method-definition">
                                            <tr><td class="method-definition"><span class="method-result">Foreign</span>&nbsp;&nbsp;</td>
                                        <td class="method-definition"><a href="#getForeignKey" title="details" class="method-name">getForeignKey</a>()&nbsp;&nbsp;</td>
                    <td class="method-definition">Returns the foreign key name defined in the foreign  class that this field is linked to.</td></tr>
                </div>
                                <div class="method-definition">
                                            <tr><td class="method-definition"><span class="method-result">string</span>&nbsp;&nbsp;</td>
                                        <td class="method-definition"><a href="#getForeignObject" title="details" class="method-name">getForeignObject</a>()&nbsp;&nbsp;</td>
                    <td class="method-definition">Returns the name of variable that will hold the foreign object name</td></tr>
                </div>
                                <div class="method-definition">
                                            <tr><td class="method-definition"><span class="method-result">string</span>&nbsp;&nbsp;</td>
                                        <td class="method-definition"><a href="#getForeignTable" title="details" class="method-name">getForeignTable</a>()&nbsp;&nbsp;</td>
                    <td class="method-definition">Returns the foreign table name of this field</td></tr>
                </div>
                                <div class="method-definition">
                                            <tr><td class="method-definition"><span class="method-result">string</span>&nbsp;&nbsp;</td>
                                        <td class="method-definition"><a href="#getGetterFunction" title="details" class="method-name">getGetterFunction</a>()&nbsp;&nbsp;</td>
                    <td class="method-definition">Returns the getter function name of this field</td></tr>
                </div>
                                <div class="method-definition">
                                            <tr><td class="method-definition"><span class="method-result">string</span>&nbsp;&nbsp;</td>
                                        <td class="method-definition"><a href="#getName" title="details" class="method-name">getName</a>()&nbsp;&nbsp;</td>
                    <td class="method-definition">Returns the name of this field</td></tr>
                </div>
                                <div class="method-definition">
                                            <tr><td class="method-definition"><span class="method-result"><a href="../MyObjectsCompiler/DDLTable.html">DDLTable</a></span>&nbsp;&nbsp;</td>
                                        <td class="method-definition"><a href="#getParent" title="details" class="method-name">getParent</a>()&nbsp;&nbsp;</td>
                    <td class="method-definition">Returns the parent Table</td></tr>
                </div>
                                <div class="method-definition">
                                            <tr><td class="method-definition"><span class="method-result">string</span>&nbsp;&nbsp;</td>
                                        <td class="method-definition"><a href="#getSetterFunction" title="details" class="method-name">getSetterFunction</a>()&nbsp;&nbsp;</td>
                    <td class="method-definition">Returns the setter function name of this field</td></tr>
                </div>
                                <div class="method-definition">
                                            <tr><td class="method-definition"><span class="method-result">boolean</span>&nbsp;&nbsp;</td>
                                        <td class="method-definition"><a href="#isAutoIncremented" title="details" class="method-name">isAutoIncremented</a>()&nbsp;&nbsp;</td>
                    <td class="method-definition">Checks if the field is auto incremented</td></tr>
                </div>
                                <div class="method-definition">
                                            <tr><td class="method-definition"><span class="method-result">boolean</span>&nbsp;&nbsp;</td>
                                        <td class="method-definition"><a href="#isForeignKey" title="details" class="method-name">isForeignKey</a>()&nbsp;&nbsp;</td>
                    <td class="method-definition">Checks if this is a foreign key</td></tr>
                </div>
                                <div class="method-definition">
                                            <tr><td class="method-definition"><span class="method-result">boolean</span>&nbsp;&nbsp;</td>
                                        <td class="method-definition"><a href="#isPrimaryKey" title="details" class="method-name">isPrimaryKey</a>()&nbsp;&nbsp;</td>
                    <td class="method-definition">Returns true if this field is the primary key</td></tr>
                </div>
                                <div class="method-definition">
                                            <tr><td class="method-definition"><span class="method-result">boolean</span>&nbsp;&nbsp;</td>
                                        <td class="method-definition"><a href="#isRequired" title="details" class="method-name">isRequired</a>()&nbsp;&nbsp;</td>
                    <td class="method-definition">Returns true if this field is a required field</td></tr>
                </div>
                                <div class="method-definition">
                                            <tr><td class="method-definition"><span class="method-result">boolean</span>&nbsp;&nbsp;</td>
                                        <td class="method-definition"><a href="#isUnique" title="details" class="method-name">isUnique</a>()&nbsp;&nbsp;</td>
                    <td class="method-definition">Returns true if this field is a unique field</td></tr>
                </div>
                                <div class="method-definition">
                                            <tr><td class="method-definition"><span class="method-result">void</span>&nbsp;&nbsp;</td>
                                        <td class="method-definition"><a href="#setAutoIncrement" title="details" class="method-name">setAutoIncrement</a>()&nbsp;&nbsp;</td>
                    <td class="method-definition">Sets if this field is an auto incremented primary key</td></tr>
                </div>
                                <div class="method-definition">
                                            <tr><td class="method-definition"><span class="method-result">void</span>&nbsp;&nbsp;</td>
                                        <td class="method-definition"><a href="#setData" title="details" class="method-name">setData</a>()&nbsp;&nbsp;</td>
                    <td class="method-definition">Sets the data model for this field</td></tr>
                </div>
                                <div class="method-definition">
                                            <tr><td class="method-definition"><span class="method-result">void</span>&nbsp;&nbsp;</td>
                                        <td class="method-definition"><a href="#setDescription" title="details" class="method-name">setDescription</a>()&nbsp;&nbsp;</td>
                    <td class="method-definition">Sets the description of this field</td></tr>
                </div>
                                <div class="method-definition">
                                            <tr><td class="method-definition"><span class="method-result">void</span>&nbsp;&nbsp;</td>
                                        <td class="method-definition"><a href="#setForeignKey" title="details" class="method-name">setForeignKey</a>()&nbsp;&nbsp;</td>
                    <td class="method-definition">Sets the foreign key name</td></tr>
                </div>
                                <div class="method-definition">
                                            <tr><td class="method-definition"><span class="method-result">void</span>&nbsp;&nbsp;</td>
                                        <td class="method-definition"><a href="#setForeignObject" title="details" class="method-name">setForeignObject</a>()&nbsp;&nbsp;</td>
                    <td class="method-definition">Sets the name of the variable that will hold the foreign object</td></tr>
                </div>
                                <div class="method-definition">
                                            <tr><td class="method-definition"><span class="method-result">void</span>&nbsp;&nbsp;</td>
                                        <td class="method-definition"><a href="#setForeignTable" title="details" class="method-name">setForeignTable</a>()&nbsp;&nbsp;</td>
                    <td class="method-definition">Sets the name of foreign table if this is a foreign key</td></tr>
                </div>
                                <div class="method-definition">
                                            <tr><td class="method-definition"><span class="method-result">void</span>&nbsp;&nbsp;</td>
                                        <td class="method-definition"><a href="#setGetterFunction" title="details" class="method-name">setGetterFunction</a>()&nbsp;&nbsp;</td>
                    <td class="method-definition">Sets the getter function of this method</td></tr>
                </div>
                                <div class="method-definition">
                                            <tr><td class="method-definition"><span class="method-result">void</span>&nbsp;&nbsp;</td>
                                        <td class="method-definition"><a href="#setName" title="details" class="method-name">setName</a>()&nbsp;&nbsp;</td>
                    <td class="method-definition">Sets the name of this field</td></tr>
                </div>
                                <div class="method-definition">
                                            <tr><td class="method-definition"><span class="method-result">void</span>&nbsp;&nbsp;</td>
                                        <td class="method-definition"><a href="#setParent" title="details" class="method-name">setParent</a>()&nbsp;&nbsp;</td>
                    <td class="method-definition">Sets the parent table of this field</td></tr>
                </div>
                                <div class="method-definition">
                                            <tr><td class="method-definition"><span class="method-result">void</span>&nbsp;&nbsp;</td>
                                        <td class="method-definition"><a href="#setPrimaryKey" title="details" class="method-name">setPrimaryKey</a>()&nbsp;&nbsp;</td>
                    <td class="method-definition">Sets if this field is the primary key</td></tr>
                </div>
                                <div class="method-definition">
                                            <tr><td class="method-definition"><span class="method-result">void</span>&nbsp;&nbsp;</td>
                                        <td class="method-definition"><a href="#setRequired" title="details" class="method-name">setRequired</a>()&nbsp;&nbsp;</td>
                    <td class="method-definition">Sets if this field is a required field</td></tr>
                </div>
                                <div class="method-definition">
                                            <tr><td class="method-definition"><span class="method-result">void</span>&nbsp;&nbsp;</td>
                                        <td class="method-definition"><a href="#setSetterFunction" title="details" class="method-name">setSetterFunction</a>()&nbsp;&nbsp;</td>
                    <td class="method-definition">Sets the setter function name of this field</td></tr>
                </div>
                                <div class="method-definition">
                                            <tr><td class="method-definition"><span class="method-result">void</span>&nbsp;&nbsp;</td>
                                        <td class="method-definition"><a href="#setUnique" title="details" class="method-name">setUnique</a>()&nbsp;&nbsp;</td>
                    <td class="method-definition">Sets if this field is a unique field</td></tr>
                </div>
                                <div class="method-definition">
                                            <tr><td class="method-definition"><span class="method-result">string</span>&nbsp;&nbsp;</td>
                                        <td class="method-definition"><a href="#toSql" title="details" class="method-name">toSql</a>()&nbsp;&nbsp;</td>
                    <td class="method-definition">Generates the sql representation of this field</td></tr>
                </div>
                                <div class="method-definition">
                                            <tr><td class="method-definition"><span class="method-result">string</span>&nbsp;&nbsp;</td>
                                        <td class="method-definition"><a href="#__toString" title="details" class="method-name">__toString</a>()&nbsp;&nbsp;</td>
                    <td class="method-definition">Returns the string representation of the field</td></tr>
                </div>
                                </table>
            </div>
            <br /><div class="top">[ <a href="#top">Top</a> ]</div>
        </div>
    </div>

    <a name="sec-vars"></a>
    <div class="info-box">
        <div class="info-box-title">Properties</div>
        <div class="nav-bar">
            <a href="#sec-description">Class Overview</a> |
                                                    <a href="#sec-var-summary">Property Summary</a> | <a href="#sec-vars">Properties Detail</a>
            
                            |
                                    <a href="#sec-method-summary">Method Summary</a> | <a href="#sec-methods">Methods Detail</a>
                                                </div>
        <div class="info-box-body">
            <a name="var$autoIncrement" id="$autoIncrement"><!-- --></A>
<div class="oddrow">

    <div class="var-header">
        <span class="var-title">
            <span class="var-type">boolean</span>&nbsp;&nbsp;
            <span class="var-name">$autoIncrement</span>
                        <span class="smalllinenumber">[line <a href="..//__filesource/fsource_MyObjectsCompiler__compilerDDL.php.html#a1343">1343</a>]</span>
        </span>
    </div>

        <strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>protected</td>
  </tr>
</table>
<br />


    
        <br />
    <div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="var$data" id="$data"><!-- --></A>
<div class="evenrow">

    <div class="var-header">
        <span class="var-title">
            <span class="var-type"><a href="../MyObjectsCompiler/DDLData.html">DDLData</a></span>&nbsp;&nbsp;
            <span class="var-name">$data</span>
                        <span class="smalllinenumber">[line <a href="..//__filesource/fsource_MyObjectsCompiler__compilerDDL.php.html#a1364">1364</a>]</span>
        </span>
    </div>

        <strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>protected</td>
  </tr>
</table>
<br />


    
        <br />
    <div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="var$description" id="$description"><!-- --></A>
<div class="oddrow">

    <div class="var-header">
        <span class="var-title">
            <span class="var-type">string</span>&nbsp;&nbsp;
            <span class="var-name">$description</span>
                        <span class="smalllinenumber">[line <a href="..//__filesource/fsource_MyObjectsCompiler__compilerDDL.php.html#a1369">1369</a>]</span>
        </span>
    </div>

        <strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>protected</td>
  </tr>
</table>
<br />


    
        <br />
    <div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="var$foreignKey" id="$foreignKey"><!-- --></A>
<div class="evenrow">

    <div class="var-header">
        <span class="var-title">
            <span class="var-type">string</span>&nbsp;&nbsp;
            <span class="var-name">$foreignKey</span>
                        <span class="smalllinenumber">[line <a href="..//__filesource/fsource_MyObjectsCompiler__compilerDDL.php.html#a1354">1354</a>]</span>
        </span>
    </div>

        <strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>protected</td>
  </tr>
</table>
<br />


    
        <br />
    <div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="var$foreignObject" id="$foreignObject"><!-- --></A>
<div class="oddrow">

    <div class="var-header">
        <span class="var-title">
            <span class="var-type">string</span>&nbsp;&nbsp;
            <span class="var-name">$foreignObject</span>
                        <span class="smalllinenumber">[line <a href="..//__filesource/fsource_MyObjectsCompiler__compilerDDL.php.html#a1359">1359</a>]</span>
        </span>
    </div>

        <strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>protected</td>
  </tr>
</table>
<br />


    
        <br />
    <div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="var$foreignTable" id="$foreignTable"><!-- --></A>
<div class="evenrow">

    <div class="var-header">
        <span class="var-title">
            <span class="var-type">string</span>&nbsp;&nbsp;
            <span class="var-name">$foreignTable</span>
                        <span class="smalllinenumber">[line <a href="..//__filesource/fsource_MyObjectsCompiler__compilerDDL.php.html#a1348">1348</a>]</span>
        </span>
    </div>

        <strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>protected</td>
  </tr>
</table>
<br />


    
        <br />
    <div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="var$getterFunction" id="$getterFunction"><!-- --></A>
<div class="oddrow">

    <div class="var-header">
        <span class="var-title">
            <span class="var-type">string</span>&nbsp;&nbsp;
            <span class="var-name">$getterFunction</span>
                        <span class="smalllinenumber">[line <a href="..//__filesource/fsource_MyObjectsCompiler__compilerDDL.php.html#a1379">1379</a>]</span>
        </span>
    </div>

        <strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>protected</td>
  </tr>
</table>
<br />


    
        <br />
    <div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="var$name" id="$name"><!-- --></A>
<div class="evenrow">

    <div class="var-header">
        <span class="var-title">
            <span class="var-type">string</span>&nbsp;&nbsp;
            <span class="var-name">$name</span>
                        <span class="smalllinenumber">[line <a href="..//__filesource/fsource_MyObjectsCompiler__compilerDDL.php.html#a1323">1323</a>]</span>
        </span>
    </div>

        <strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>protected</td>
  </tr>
</table>
<br />


    
        <br />
    <div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="var$parent" id="$parent"><!-- --></A>
<div class="oddrow">

    <div class="var-header">
        <span class="var-title">
            <span class="var-type"><a href="../MyObjectsCompiler/DDLTable.html">DDLTable</a></span>&nbsp;&nbsp;
            <span class="var-name">$parent</span>
                        <span class="smalllinenumber">[line <a href="..//__filesource/fsource_MyObjectsCompiler__compilerDDL.php.html#a1318">1318</a>]</span>
        </span>
    </div>

        <strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>protected</td>
  </tr>
</table>
<br />


    
        <br />
    <div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="var$primaryKey" id="$primaryKey"><!-- --></A>
<div class="evenrow">

    <div class="var-header">
        <span class="var-title">
            <span class="var-type">boolean</span>&nbsp;&nbsp;
            <span class="var-name">$primaryKey</span>
                        <span class="smalllinenumber">[line <a href="..//__filesource/fsource_MyObjectsCompiler__compilerDDL.php.html#a1338">1338</a>]</span>
        </span>
    </div>

        <strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>protected</td>
  </tr>
</table>
<br />


    
        <br />
    <div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="var$required" id="$required"><!-- --></A>
<div class="oddrow">

    <div class="var-header">
        <span class="var-title">
            <span class="var-type">boolean</span>&nbsp;&nbsp;
            <span class="var-name">$required</span>
                        <span class="smalllinenumber">[line <a href="..//__filesource/fsource_MyObjectsCompiler__compilerDDL.php.html#a1328">1328</a>]</span>
        </span>
    </div>

        <strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>protected</td>
  </tr>
</table>
<br />


    
        <br />
    <div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="var$setterFunction" id="$setterFunction"><!-- --></A>
<div class="evenrow">

    <div class="var-header">
        <span class="var-title">
            <span class="var-type">string</span>&nbsp;&nbsp;
            <span class="var-name">$setterFunction</span>
                        <span class="smalllinenumber">[line <a href="..//__filesource/fsource_MyObjectsCompiler__compilerDDL.php.html#a1374">1374</a>]</span>
        </span>
    </div>

        <strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>protected</td>
  </tr>
</table>
<br />


    
        <br />
    <div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="var$unique" id="$unique"><!-- --></A>
<div class="oddrow">

    <div class="var-header">
        <span class="var-title">
            <span class="var-type">boolean</span>&nbsp;&nbsp;
            <span class="var-name">$unique</span>
                        <span class="smalllinenumber">[line <a href="..//__filesource/fsource_MyObjectsCompiler__compilerDDL.php.html#a1333">1333</a>]</span>
        </span>
    </div>

        <strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>protected</td>
  </tr>
</table>
<br />


    
        <br />
    <div class="top">[ <a href="#top">Top</a> ]</div>
</div>
        </div>
    </div>

    <a name="sec-methods"></a>
    <div class="info-box">
        <div class="info-box-title">Methods</div>
        <div class="nav-bar">
            <a href="#sec-description">Class Overview</a> |
                                                    |
                                    <a href="#sec-var-summary">Property Summary</a> | <a href="#sec-vars">Properties Detail</a>
                                                                    | <a href="#sec-method-summary">Method Summary</a> | <span class="disabled">Methods Detail</span>
                    </div>
        <div class="info-box-body">
            <a name='method_detail'></a>
<a name="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">

<div class="method-header">
    <span class="method-title">Constructor __construct</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="..//__filesource/fsource_MyObjectsCompiler__compilerDDL.php.html#a1388">1388</a>]</span>
</div>
<br />

    <div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
        <code>void __construct(
DDLTable
$parent,  string
$name&nbsp;
)</code>
    </td></tr></table>
    </td></tr></table><br /></div>

    <p align="center" class="short-description"><strong>Constructs a DDLField
</strong></p>

            <strong>Parameters:</strong><br />
            <table border="0" cellspacing="0" cellpadding="0">
                    <tr><td class="indent">
                <span class="var-type"><a href="../MyObjectsCompiler/DDLTable.html">DDLTable</a></span>&nbsp;&nbsp;</td>
                <td>
                <span class="var-name">$parent:&nbsp;</span></td>
                <td>
                <span class="var-description"> The table of this field</span>            </td></tr>
                    <tr><td class="indent">
                <span class="var-type">string</span>&nbsp;&nbsp;</td>
                <td>
                <span class="var-name">$name:&nbsp;</span></td>
                <td>
                <span class="var-description"> Name of the field</span>            </td></tr>
                </table>

    <br />
    <strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
<br />


    
        <br />
    <div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodcreateXmlElement" id="createXmlElement"><!-- --></a>
<div class="oddrow">

<div class="method-header">
    <span class="method-title">createXmlElement</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="..//__filesource/fsource_MyObjectsCompiler__compilerDDL.php.html#a1720">1720</a>]</span>
</div>
<br />

    <div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
        <code>void createXmlElement(
DOMDocument
$doc,  DOMElement
$table&nbsp;
)</code>
    </td></tr></table>
    </td></tr></table><br /></div>

    <p align="center" class="short-description"><strong>Creates the nodes describing this database on the supplied Xml document
</strong></p>

            <strong>Parameters:</strong><br />
            <table border="0" cellspacing="0" cellpadding="0">
                    <tr><td class="indent">
                <span class="var-type">DOMDocumend</span>&nbsp;&nbsp;</td>
                <td>
                <span class="var-name">$doc:&nbsp;</span></td>
                <td>
                <span class="var-description"> The Xml document object that will be used</span>            </td></tr>
                    <tr><td class="indent">
                <span class="var-type">DOMElement</span>&nbsp;&nbsp;</td>
                <td>
                <span class="var-name">$table:&nbsp;</span></td>
                <td>
                <span class="var-description"> Parent node in xml object</span>            </td></tr>
                </table>

    <br />
    <strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
<br />


    
        <br />
    <div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodgetData" id="getData"><!-- --></a>
<div class="evenrow">

<div class="method-header">
    <span class="method-title">getData</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="..//__filesource/fsource_MyObjectsCompiler__compilerDDL.php.html#a1453">1453</a>]</span>
</div>
<br />

    <div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
        <code><a href="../MyObjectsCompiler/DDLData.html">DDLData</a> getData(
)</code>
    </td></tr></table>
    </td></tr></table><br /></div>

    <p align="center" class="short-description"><strong>Returns the data model for this field
</strong></p>

    <br />
    <strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Return:</strong>&nbsp;&nbsp;</td><td>data model for this field</td>
  </tr>
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
<br />


    
        <br />
    <div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodgetDescription" id="getDescription"><!-- --></a>
<div class="oddrow">

<div class="method-header">
    <span class="method-title">getDescription</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="..//__filesource/fsource_MyObjectsCompiler__compilerDDL.php.html#a1654">1654</a>]</span>
</div>
<br />

    <div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
        <code>string getDescription(
)</code>
    </td></tr></table>
    </td></tr></table><br /></div>

    <p align="center" class="short-description"><strong>Returns the description of this field
</strong></p>

    <br />
    <strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Return:</strong>&nbsp;&nbsp;</td><td>Description of this field</td>
  </tr>
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
<br />


    
        <br />
    <div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodgetForeignClass" id="getForeignClass"><!-- --></a>
<div class="evenrow">

<div class="method-header">
    <span class="method-title">getForeignClass</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="..//__filesource/fsource_MyObjectsCompiler__compilerDDL.php.html#a1576">1576</a>]</span>
</div>
<br />

    <div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
        <code>string getForeignClass(
)</code>
    </td></tr></table>
    </td></tr></table><br /></div>

    <p align="center" class="short-description"><strong>Returns the class name of the foreign table
</strong></p>

    <br />
    <strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Return:</strong>&nbsp;&nbsp;</td><td>Class name of the foreign table</td>
  </tr>
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
<br />


    
        <br />
    <div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodgetForeignKey" id="getForeignKey"><!-- --></a>
<div class="oddrow">

<div class="method-header">
    <span class="method-title">getForeignKey</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="..//__filesource/fsource_MyObjectsCompiler__compilerDDL.php.html#a1594">1594</a>]</span>
</div>
<br />

    <div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
        <code>Foreign getForeignKey(
)</code>
    </td></tr></table>
    </td></tr></table><br /></div>

    <p align="center" class="short-description"><strong>Returns the foreign key name defined in the foreign  class that this field is linked to.
</strong></p>

    <br />
    <strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Return:</strong>&nbsp;&nbsp;</td><td>key name defined in the foreign table</td>
  </tr>
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
<br />


    
        <br />
    <div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodgetForeignObject" id="getForeignObject"><!-- --></a>
<div class="evenrow">

<div class="method-header">
    <span class="method-title">getForeignObject</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="..//__filesource/fsource_MyObjectsCompiler__compilerDDL.php.html#a1635">1635</a>]</span>
</div>
<br />

    <div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
        <code>string getForeignObject(
)</code>
    </td></tr></table>
    </td></tr></table><br /></div>

    <p align="center" class="short-description"><strong>Returns the name of variable that will hold the foreign object name
</strong></p>

    <br />
    <strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Return:</strong>&nbsp;&nbsp;</td><td>Variable name for the foreign object</td>
  </tr>
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
<br />


    
        <br />
    <div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodgetForeignTable" id="getForeignTable"><!-- --></a>
<div class="oddrow">

<div class="method-header">
    <span class="method-title">getForeignTable</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="..//__filesource/fsource_MyObjectsCompiler__compilerDDL.php.html#a1567">1567</a>]</span>
</div>
<br />

    <div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
        <code>string getForeignTable(
)</code>
    </td></tr></table>
    </td></tr></table><br /></div>

    <p align="center" class="short-description"><strong>Returns the foreign table name of this field
</strong></p>

    <br />
    <strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Return:</strong>&nbsp;&nbsp;</td><td>Foreign table name</td>
  </tr>
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
<br />


    
        <br />
    <div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodgetGetterFunction" id="getGetterFunction"><!-- --></a>
<div class="evenrow">

<div class="method-header">
    <span class="method-title">getGetterFunction</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="..//__filesource/fsource_MyObjectsCompiler__compilerDDL.php.html#a1701">1701</a>]</span>
</div>
<br />

    <div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
        <code>string getGetterFunction(
)</code>
    </td></tr></table>
    </td></tr></table><br /></div>

    <p align="center" class="short-description"><strong>Returns the getter function name of this field
</strong></p>

    <br />
    <strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Return:</strong>&nbsp;&nbsp;</td><td>Getter function name</td>
  </tr>
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
<br />


    
        <br />
    <div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodgetName" id="getName"><!-- --></a>
<div class="oddrow">

<div class="method-header">
    <span class="method-title">getName</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="..//__filesource/fsource_MyObjectsCompiler__compilerDDL.php.html#a1472">1472</a>]</span>
</div>
<br />

    <div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
        <code>string getName(
)</code>
    </td></tr></table>
    </td></tr></table><br /></div>

    <p align="center" class="short-description"><strong>Returns the name of this field
</strong></p>

    <br />
    <strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Return:</strong>&nbsp;&nbsp;</td><td>Name of the field</td>
  </tr>
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
<br />


    
        <br />
    <div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodgetParent" id="getParent"><!-- --></a>
<div class="evenrow">

<div class="method-header">
    <span class="method-title">getParent</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="..//__filesource/fsource_MyObjectsCompiler__compilerDDL.php.html#a1434">1434</a>]</span>
</div>
<br />

    <div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
        <code><a href="../MyObjectsCompiler/DDLTable.html">DDLTable</a> getParent(
)</code>
    </td></tr></table>
    </td></tr></table><br /></div>

    <p align="center" class="short-description"><strong>Returns the parent Table
</strong></p>

    <br />
    <strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Return:</strong>&nbsp;&nbsp;</td><td>The parent table</td>
  </tr>
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
<br />


    
        <br />
    <div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodgetSetterFunction" id="getSetterFunction"><!-- --></a>
<div class="oddrow">

<div class="method-header">
    <span class="method-title">getSetterFunction</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="..//__filesource/fsource_MyObjectsCompiler__compilerDDL.php.html#a1682">1682</a>]</span>
</div>
<br />

    <div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
        <code>string getSetterFunction(
)</code>
    </td></tr></table>
    </td></tr></table><br /></div>

    <p align="center" class="short-description"><strong>Returns the setter function name of this field
</strong></p>

    <br />
    <strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Return:</strong>&nbsp;&nbsp;</td><td>Setter function name</td>
  </tr>
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
<br />


    
        <br />
    <div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodisAutoIncremented" id="isAutoIncremented"><!-- --></a>
<div class="evenrow">

<div class="method-header">
    <span class="method-title">isAutoIncremented</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="..//__filesource/fsource_MyObjectsCompiler__compilerDDL.php.html#a1539">1539</a>]</span>
</div>
<br />

    <div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
        <code>boolean isAutoIncremented(
)</code>
    </td></tr></table>
    </td></tr></table><br /></div>

    <p align="center" class="short-description"><strong>Checks if the field is auto incremented
</strong></p>

    <br />
    <strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Return:</strong>&nbsp;&nbsp;</td><td>True if the field is auto incremented</td>
  </tr>
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
<br />


    
        <br />
    <div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodisForeignKey" id="isForeignKey"><!-- --></a>
<div class="oddrow">

<div class="method-header">
    <span class="method-title">isForeignKey</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="..//__filesource/fsource_MyObjectsCompiler__compilerDDL.php.html#a1663">1663</a>]</span>
</div>
<br />

    <div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
        <code>boolean isForeignKey(
)</code>
    </td></tr></table>
    </td></tr></table><br /></div>

    <p align="center" class="short-description"><strong>Checks if this is a foreign key
</strong></p>

    <br />
    <strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Return:</strong>&nbsp;&nbsp;</td><td>Returns true if this is a foreign key</td>
  </tr>
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
<br />


    
        <br />
    <div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodisPrimaryKey" id="isPrimaryKey"><!-- --></a>
<div class="evenrow">

<div class="method-header">
    <span class="method-title">isPrimaryKey</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="..//__filesource/fsource_MyObjectsCompiler__compilerDDL.php.html#a1548">1548</a>]</span>
</div>
<br />

    <div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
        <code>boolean isPrimaryKey(
)</code>
    </td></tr></table>
    </td></tr></table><br /></div>

    <p align="center" class="short-description"><strong>Returns true if this field is the primary key
</strong></p>

    <br />
    <strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Return:</strong>&nbsp;&nbsp;</td><td>True if the field is the primary key</td>
  </tr>
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
<br />


    
        <br />
    <div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodisRequired" id="isRequired"><!-- --></a>
<div class="oddrow">

<div class="method-header">
    <span class="method-title">isRequired</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="..//__filesource/fsource_MyObjectsCompiler__compilerDDL.php.html#a1491">1491</a>]</span>
</div>
<br />

    <div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
        <code>boolean isRequired(
)</code>
    </td></tr></table>
    </td></tr></table><br /></div>

    <p align="center" class="short-description"><strong>Returns true if this field is a required field
</strong></p>

    <br />
    <strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Return:</strong>&nbsp;&nbsp;</td><td>True if the field is required</td>
  </tr>
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
<br />


    
        <br />
    <div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodisUnique" id="isUnique"><!-- --></a>
<div class="evenrow">

<div class="method-header">
    <span class="method-title">isUnique</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="..//__filesource/fsource_MyObjectsCompiler__compilerDDL.php.html#a1510">1510</a>]</span>
</div>
<br />

    <div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
        <code>boolean isUnique(
)</code>
    </td></tr></table>
    </td></tr></table><br /></div>

    <p align="center" class="short-description"><strong>Returns true if this field is a unique field
</strong></p>

    <br />
    <strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Return:</strong>&nbsp;&nbsp;</td><td>True if the field is unique</td>
  </tr>
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
<br />


    
        <br />
    <div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodsetAutoIncrement" id="setAutoIncrement"><!-- --></a>
<div class="oddrow">

<div class="method-header">
    <span class="method-title">setAutoIncrement</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="..//__filesource/fsource_MyObjectsCompiler__compilerDDL.php.html#a1530">1530</a>]</span>
</div>
<br />

    <div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
        <code>void setAutoIncrement(
boolean
$flag&nbsp;
)</code>
    </td></tr></table>
    </td></tr></table><br /></div>

    <p align="center" class="short-description"><strong>Sets if this field is an auto incremented primary key
</strong></p>

            <strong>Parameters:</strong><br />
            <table border="0" cellspacing="0" cellpadding="0">
                    <tr><td class="indent">
                <span class="var-type">boolean</span>&nbsp;&nbsp;</td>
                <td>
                <span class="var-name">$flag:&nbsp;</span></td>
                <td>
                <span class="var-description"> Should be passed true if this field is auto incremented</span>            </td></tr>
                </table>

    <br />
    <strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
<br />


    
        <br />
    <div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodsetData" id="setData"><!-- --></a>
<div class="evenrow">

<div class="method-header">
    <span class="method-title">setData</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="..//__filesource/fsource_MyObjectsCompiler__compilerDDL.php.html#a1444">1444</a>]</span>
</div>
<br />

    <div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
        <code>void setData(
DDLData
$data&nbsp;
)</code>
    </td></tr></table>
    </td></tr></table><br /></div>

    <p align="center" class="short-description"><strong>Sets the data model for this field
</strong></p>

            <strong>Parameters:</strong><br />
            <table border="0" cellspacing="0" cellpadding="0">
                    <tr><td class="indent">
                <span class="var-type"><a href="../MyObjectsCompiler/DDLData.html">DDLData</a></span>&nbsp;&nbsp;</td>
                <td>
                <span class="var-name">$data:&nbsp;</span></td>
                <td>
                <span class="var-description"> Datamodel for the field</span>            </td></tr>
                </table>

    <br />
    <strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
<br />


    
        <br />
    <div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodsetDescription" id="setDescription"><!-- --></a>
<div class="oddrow">

<div class="method-header">
    <span class="method-title">setDescription</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="..//__filesource/fsource_MyObjectsCompiler__compilerDDL.php.html#a1645">1645</a>]</span>
</div>
<br />

    <div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
        <code>void setDescription(
string
$description&nbsp;
)</code>
    </td></tr></table>
    </td></tr></table><br /></div>

    <p align="center" class="short-description"><strong>Sets the description of this field
</strong></p>

            <strong>Parameters:</strong><br />
            <table border="0" cellspacing="0" cellpadding="0">
                    <tr><td class="indent">
                <span class="var-type">string</span>&nbsp;&nbsp;</td>
                <td>
                <span class="var-name">$description:&nbsp;</span></td>
                <td>
                <span class="var-description"> Description for this field</span>            </td></tr>
                </table>

    <br />
    <strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
<br />


    
        <br />
    <div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodsetForeignKey" id="setForeignKey"><!-- --></a>
<div class="evenrow">

<div class="method-header">
    <span class="method-title">setForeignKey</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="..//__filesource/fsource_MyObjectsCompiler__compilerDDL.php.html#a1615">1615</a>]</span>
</div>
<br />

    <div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
        <code>void setForeignKey(
string
$foreignKey&nbsp;
)</code>
    </td></tr></table>
    </td></tr></table><br /></div>

    <p align="center" class="short-description"><strong>Sets the foreign key name
</strong></p>

            <strong>Parameters:</strong><br />
            <table border="0" cellspacing="0" cellpadding="0">
                    <tr><td class="indent">
                <span class="var-type">string</span>&nbsp;&nbsp;</td>
                <td>
                <span class="var-name">$foreignKey:&nbsp;</span></td>
                <td>
                <span class="var-description"> Name of foreign tables key</span>            </td></tr>
                </table>

    <br />
    <strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
<br />


    
        <br />
    <div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodsetForeignObject" id="setForeignObject"><!-- --></a>
<div class="oddrow">

<div class="method-header">
    <span class="method-title">setForeignObject</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="..//__filesource/fsource_MyObjectsCompiler__compilerDDL.php.html#a1626">1626</a>]</span>
</div>
<br />

    <div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
        <code>void setForeignObject(
string
$name&nbsp;
)</code>
    </td></tr></table>
    </td></tr></table><br /></div>

    <p align="center" class="short-description"><strong>Sets the name of the variable that will hold the foreign object
</strong></p>

            <strong>Parameters:</strong><br />
            <table border="0" cellspacing="0" cellpadding="0">
                    <tr><td class="indent">
                <span class="var-type">string</span>&nbsp;&nbsp;</td>
                <td>
                <span class="var-name">$name:&nbsp;</span></td>
                <td>
                <span class="var-description"> Name of variable</span>            </td></tr>
                </table>

    <br />
    <strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
<br />


    
        <br />
    <div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodsetForeignTable" id="setForeignTable"><!-- --></a>
<div class="evenrow">

<div class="method-header">
    <span class="method-title">setForeignTable</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="..//__filesource/fsource_MyObjectsCompiler__compilerDDL.php.html#a1558">1558</a>]</span>
</div>
<br />

    <div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
        <code>void setForeignTable(
string
$table&nbsp;
)</code>
    </td></tr></table>
    </td></tr></table><br /></div>

    <p align="center" class="short-description"><strong>Sets the name of foreign table if this is a foreign key
</strong></p>

            <strong>Parameters:</strong><br />
            <table border="0" cellspacing="0" cellpadding="0">
                    <tr><td class="indent">
                <span class="var-type">string</span>&nbsp;&nbsp;</td>
                <td>
                <span class="var-name">$table:&nbsp;</span></td>
                <td>
                <span class="var-description"> Name of foreign table</span>            </td></tr>
                </table>

    <br />
    <strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
<br />


    
        <br />
    <div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodsetGetterFunction" id="setGetterFunction"><!-- --></a>
<div class="oddrow">

<div class="method-header">
    <span class="method-title">setGetterFunction</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="..//__filesource/fsource_MyObjectsCompiler__compilerDDL.php.html#a1692">1692</a>]</span>
</div>
<br />

    <div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
        <code>void setGetterFunction(
string
$function&nbsp;
)</code>
    </td></tr></table>
    </td></tr></table><br /></div>

    <p align="center" class="short-description"><strong>Sets the getter function of this method
</strong></p>

            <strong>Parameters:</strong><br />
            <table border="0" cellspacing="0" cellpadding="0">
                    <tr><td class="indent">
                <span class="var-type">string</span>&nbsp;&nbsp;</td>
                <td>
                <span class="var-name">$function:&nbsp;</span></td>
                <td>
                <span class="var-description"> Name of the getter function</span>            </td></tr>
                </table>

    <br />
    <strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
<br />


    
        <br />
    <div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodsetName" id="setName"><!-- --></a>
<div class="evenrow">

<div class="method-header">
    <span class="method-title">setName</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="..//__filesource/fsource_MyObjectsCompiler__compilerDDL.php.html#a1463">1463</a>]</span>
</div>
<br />

    <div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
        <code>void setName(
string
$name&nbsp;
)</code>
    </td></tr></table>
    </td></tr></table><br /></div>

    <p align="center" class="short-description"><strong>Sets the name of this field
</strong></p>

            <strong>Parameters:</strong><br />
            <table border="0" cellspacing="0" cellpadding="0">
                    <tr><td class="indent">
                <span class="var-type">string</span>&nbsp;&nbsp;</td>
                <td>
                <span class="var-name">$name:&nbsp;</span></td>
                <td>
                <span class="var-description"> Name of this field</span>            </td></tr>
                </table>

    <br />
    <strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
<br />


    
        <br />
    <div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodsetParent" id="setParent"><!-- --></a>
<div class="oddrow">

<div class="method-header">
    <span class="method-title">setParent</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="..//__filesource/fsource_MyObjectsCompiler__compilerDDL.php.html#a1425">1425</a>]</span>
</div>
<br />

    <div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
        <code>void setParent(
DDLTable
$table&nbsp;
)</code>
    </td></tr></table>
    </td></tr></table><br /></div>

    <p align="center" class="short-description"><strong>Sets the parent table of this field
</strong></p>

            <strong>Parameters:</strong><br />
            <table border="0" cellspacing="0" cellpadding="0">
                    <tr><td class="indent">
                <span class="var-type"><a href="../MyObjectsCompiler/DDLTable.html">DDLTable</a></span>&nbsp;&nbsp;</td>
                <td>
                <span class="var-name">$table:&nbsp;</span></td>
                <td>
                <span class="var-description"> Parent table of the field</span>            </td></tr>
                </table>

    <br />
    <strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
<br />


    
        <br />
    <div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodsetPrimaryKey" id="setPrimaryKey"><!-- --></a>
<div class="evenrow">

<div class="method-header">
    <span class="method-title">setPrimaryKey</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="..//__filesource/fsource_MyObjectsCompiler__compilerDDL.php.html#a1520">1520</a>]</span>
</div>
<br />

    <div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
        <code>void setPrimaryKey(
boolean
$flag&nbsp;
)</code>
    </td></tr></table>
    </td></tr></table><br /></div>

    <p align="center" class="short-description"><strong>Sets if this field is the primary key
</strong></p>

            <strong>Parameters:</strong><br />
            <table border="0" cellspacing="0" cellpadding="0">
                    <tr><td class="indent">
                <span class="var-type">boolean</span>&nbsp;&nbsp;</td>
                <td>
                <span class="var-name">$flag:&nbsp;</span></td>
                <td>
                <span class="var-description"> Should be passed true if this field is the primary key</span>            </td></tr>
                </table>

    <br />
    <strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
<br />


    
        <br />
    <div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodsetRequired" id="setRequired"><!-- --></a>
<div class="oddrow">

<div class="method-header">
    <span class="method-title">setRequired</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="..//__filesource/fsource_MyObjectsCompiler__compilerDDL.php.html#a1482">1482</a>]</span>
</div>
<br />

    <div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
        <code>void setRequired(
boolean
$flag&nbsp;
)</code>
    </td></tr></table>
    </td></tr></table><br /></div>

    <p align="center" class="short-description"><strong>Sets if this field is a required field
</strong></p>

            <strong>Parameters:</strong><br />
            <table border="0" cellspacing="0" cellpadding="0">
                    <tr><td class="indent">
                <span class="var-type">boolean</span>&nbsp;&nbsp;</td>
                <td>
                <span class="var-name">$flag:&nbsp;</span></td>
                <td>
                <span class="var-description"> Should be passed true if this field is a required field</span>            </td></tr>
                </table>

    <br />
    <strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
<br />


    
        <br />
    <div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodsetSetterFunction" id="setSetterFunction"><!-- --></a>
<div class="evenrow">

<div class="method-header">
    <span class="method-title">setSetterFunction</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="..//__filesource/fsource_MyObjectsCompiler__compilerDDL.php.html#a1673">1673</a>]</span>
</div>
<br />

    <div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
        <code>void setSetterFunction(
string
$function&nbsp;
)</code>
    </td></tr></table>
    </td></tr></table><br /></div>

    <p align="center" class="short-description"><strong>Sets the setter function name of this field
</strong></p>

            <strong>Parameters:</strong><br />
            <table border="0" cellspacing="0" cellpadding="0">
                    <tr><td class="indent">
                <span class="var-type">string</span>&nbsp;&nbsp;</td>
                <td>
                <span class="var-name">$function:&nbsp;</span></td>
                <td>
                <span class="var-description"> Name of the setter function</span>            </td></tr>
                </table>

    <br />
    <strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
<br />


    
        <br />
    <div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodsetUnique" id="setUnique"><!-- --></a>
<div class="oddrow">

<div class="method-header">
    <span class="method-title">setUnique</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="..//__filesource/fsource_MyObjectsCompiler__compilerDDL.php.html#a1501">1501</a>]</span>
</div>
<br />

    <div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
        <code>void setUnique(
boolean
$flag&nbsp;
)</code>
    </td></tr></table>
    </td></tr></table><br /></div>

    <p align="center" class="short-description"><strong>Sets if this field is a unique field
</strong></p>

            <strong>Parameters:</strong><br />
            <table border="0" cellspacing="0" cellpadding="0">
                    <tr><td class="indent">
                <span class="var-type">boolean</span>&nbsp;&nbsp;</td>
                <td>
                <span class="var-name">$flag:&nbsp;</span></td>
                <td>
                <span class="var-description"> Should be passed true if this field is a unique field</span>            </td></tr>
                </table>

    <br />
    <strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
<br />


    
        <br />
    <div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodtoSql" id="toSql"><!-- --></a>
<div class="evenrow">

<div class="method-header">
    <span class="method-title">toSql</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="..//__filesource/fsource_MyObjectsCompiler__compilerDDL.php.html#a1398">1398</a>]</span>
</div>
<br />

    <div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
        <code>string toSql(
)</code>
    </td></tr></table>
    </td></tr></table><br /></div>

    <p align="center" class="short-description"><strong>Generates the sql representation of this field
</strong></p>

    <br />
    <strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Return:</strong>&nbsp;&nbsp;</td><td>Sql representation of this field</td>
  </tr>
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
<br />


    
        <br />
    <div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="method__toString" id="__toString"><!-- --></a>
<div class="oddrow">

<div class="method-header">
    <span class="method-title">__toString</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="..//__filesource/fsource_MyObjectsCompiler__compilerDDL.php.html#a1710">1710</a>]</span>
</div>
<br />

    <div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
        <code>string __toString(
)</code>
    </td></tr></table>
    </td></tr></table><br /></div>

    <p align="center" class="short-description"><strong>Returns the string representation of the field
</strong></p>

    <br />
    <strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Return:</strong>&nbsp;&nbsp;</td><td>Name of field and the parent table</td>
  </tr>
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
<br />


    
        <br />
    <div class="top">[ <a href="#top">Top</a> ]</div>
</div>
        </div>
    </div>


        <div class="credit">
            <hr class="separator" />
            Documentation generated on Tue,   7 Dec 2004 20:30:07 +0200 by <a href="http://www.phpdoc.org">phpDocumentor 1.3.0RC3</a>
          </div>
      </td></tr></table>
    </td>
  </tr>
</table>

</body>
</html>


Other Development Tools Scripts:

WebMaster Resources Home

©RingsWorld.com