Table

class Table extends ScopedElement implements IDMethod

Constants

DEBUG

Enables some debug printing.

Methods

value	getNamespace() Get the value of the namespace.	from ScopedElement
	setNamespace(v $v) Set the value of the namespace.	from ScopedElement
value	getPackage() Get the value of package.	from ScopedElement
	setPackage(v $v) Set the value of package.	from ScopedElement
value	getSchema() Get the value of schema.	from ScopedElement
	setSchema(v $v) Set the value of schema.	from ScopedElement
	__construct(string $name = null) Constructs a table object with a name
	setupObject() Sets up the Rule object based on the attributes that were passed to loadFromXML().
string	getBuildProperty(string $key) get a build property for the database this table belongs to
	applyBehaviors() Execute behavior table modifiers
	doFinalInitialization() <p>A hook for the SAX XML parser to call when this table has been fully loaded from the XML, and all nested elements have been processed.</p>
	addExtraIndices() Adds extra indices for reverse foreign keys This is required for MySQL databases, and is called from Database::doFinalInitialization()
string	getColumnList(array $columns, string $delim = ',') Creates a delimiter-delimited string list of column names
	doNaming() Names composing objects which haven't yet been named.
The	getBaseClass() Gets the value of base class for classes produced from this table.
	setBaseClass(v $v) Set the value of baseClass.
value	getBasePeer() Get the value of basePeer.
	setBasePeer(v $v) Set the value of basePeer.
Column	addColumn($data) A utility function to create a new column from attrib and add it to this table.
	removeColumn(Column|string $col) Removed a column from the table
	adjustColumnPositions()
Validator	addValidator(mixed $data) Add a validator to this table.
	removeValidatorForColumn(string $columnName) Removes validators based on a column name
	addForeignKey($fkdata) A utility function to create a new foreign key from attrib and add it to this table.
Column	getChildrenColumn() Gets the column that subclasses of the class representing this table can be produced from.
array	getChildrenNames() Get the subclasses that can be created from this table.
	addReferrer(ForeignKey $fk) Adds the foreign key from another table that refers to this table.
	getReferrers() Get list of references to this table.
	setupReferrers($throwErrors = false) Browses the foreign keys and creates referrers for the foreign table.
	getCrossFks()
	setContainsForeignPK($b) Set whether this table contains a foreign PK
	getContainsForeignPK() Determine if this table contains a foreign PK
	getForeignTableNames() A list of tables referenced by foreign keys in this table
	requiresTransactionInPostgres() Return true if the column requires a transaction in Postgres
	addIdMethodParameter($impdata) A utility function to create a new id method parameter from attrib or object and add it to this table.
	removeIndex(string $name) Removed a index from the table
bool	hasIndex(string $name) check if the table has a index by name
	addIndex($idxdata) Adds a new index to the index list and set the parent table of the column to the current table
	addUnique($unqdata) Adds a new Unique to the Unique list and set the parent table of the column to the current table
GeneratorConfig	getGeneratorConfig() Retrieves the configuration object, filled by build.properties
Behavior	addBehavior($bdata) Adds a new Behavior to the table
Array	getBehaviors() Get the table behaviors
Array	getEarlyBehaviors() Get the early table behaviors
boolean	hasBehavior(string $name) check if the table has a behavior by name
Behavior	getBehavior(string $name) Get one table behavior by name
boolean	hasAdditionalBuilders() Check whether one of the table behaviors offer an additional builder
array	getAdditionalBuilders() Get the additional builders provided by the table behaviors
	getName() Get the name of the Table
	getDescription() Get the description for the Table
	hasDescription() Whether the Table has a description
	setDescription(newDescription $newDescription) Set the description for the Table
string	getPhpName() Get name to use in PHP sources
	setPhpName(string $phpName) Set name to use in PHP sources
	buildPhpName($name)
string	getStudlyPhpName() Get studly version of PHP name.
	getCommonName() Get the name without schema
	setCommonName($v) Set the common name of the table (without schema)
	setDefaultStringFormat(string $defaultStringFormat) Set the default string format for ActiveRecord objects in this Table.
string	getDefaultStringFormat() Get the default string format for ActiveRecord objects in this Table, or the one for the whole database if not set.
string	getIdMethod() Get the method for generating pk's [HL] changing behavior so that Database default method is returned if no method has been specified for the table.
boolean	isAllowPkInsert() Whether we allow to insert primary keys on tables with idMethod=native
	setIdMethod($idMethod) Set the method for generating pk's
boolean	isSkipSql() Skip generating sql for this table (in the event it should not be created from scratch).
boolan	isReadOnly() Is table read-only, in which case only accessors (and relationship setters) will be created.
	setSkipSql(boolean $v) Set whether this table should have its creation sql generated.
boolean	isReloadOnInsert() Whether to force object to reload on INSERT.
boolean	isReloadOnUpdate() Whether to force object to reload on UPDATE.
value	getAlias() PhpName of om object this entry references.
value	isAlias() Is this table specified in the schema or is there just a foreign key reference to it.
	setAlias(v $v) Set whether this table specified in the schema or is there just a foreign key reference to it.
value	getInterface() Interface which objects for this table will implement
	setInterface(v $v) Interface which objects for this table will implement
value	isAbstract() When a table is abstract, it marks the business object class that is generated as being abstract.
	setAbstract(v $v) When a table is abstract, it marks the business object class that is generated as being abstract.
array	getColumns() Returns an Array containing all the columns in the table
	getNumColumns() Utility method to get the number of columns in this table
	getNumLazyLoadColumns() Utility method to get the number of columns in this table
boolean	hasEnumColumns() Checks whether one of the columns is of type ENUM
array	getValidators() Returns an Array containing all the validators in the table
array	getForeignKeys() Returns an Array containing all the FKs in the table.
	getIdMethodParameters() Returns a Collection of parameters relevant for the chosen id generation method.
array	getIndices() Returns an Array containing all the FKs in the table
array	getUnices() Returns an Array containing all the UKs in the table
boolean	hasColumn(Column|string $col, boolean $caseInsensitive = false) Check whether the table has a column.
Column	getColumn(string $name, boolean $caseInsensitive = false) Return the column with the specified name.
Column	getColumnByPhpName($phpName) Returns a specified column.
array	getForeignKeysReferencingTable($tablename) Get all the foreign keys from this table to the specified table.
array	getColumnForeignKeys($colname) Return the foreign keys that includes col in it's list of local columns.
boolean	containsColumn(Column|string $col) Check whether the table has a column.
	setDatabase(Database $db) Set the database that contains this table.
Database	getDatabase() Get the database that contains this table.
boolean	isForReferenceOnly() Flag to determine if code/sql gets created for this table.
	setForReferenceOnly(boolean $v) Flag to determine if code/sql gets created for this table.
valur	treeMode() Flag to determine if tree node class should be generated for this table.
	setTreeMode(v $v) Flag to determine if tree node class should be generated for this table.
	appendXml(DOMNode $node) Appends XML nodes to passed-in DOMNode.
array	getPrimaryKey() Returns the collection of Columns which make up the single primary key for this table.
boolean	hasPrimaryKey() Determine whether this table has a primary key.
boolean	hasCompositePrimaryKey() Determine whether this table has a composite primary key.
	getFirstPrimaryKeyColumn() Get the first column of the primary key.
boolean	hasAutoIncrementPrimaryKey() Determine whether this table has any auto-increment primary key(s).
Column	getAutoIncrementPrimaryKey() Gets the auto increment PK
A	printPrimaryKey() Returns all parts of the primary key, separated by commas.
boolean	getIsCrossRef() Gets the crossRef status for this foreign key
	setIsCrossRef(boolean $isCrossRef) Sets a crossref status for this foreign key.
Boolean	hasForeignKeys() Returns whether the table has foreign keys or not.
Boolean	hasCrossForeignKeys() Returns whether the table has cross foreign keys or not.
string	getNonPrefixedName()

Details

in ScopedElement at line 71

public value getNamespace()

in ScopedElement at line 80

public setNamespace(v $v)

in ScopedElement at line 96

public value getPackage()

in ScopedElement at line 105

public setPackage(v $v)

in ScopedElement at line 118

public value getSchema()

in ScopedElement at line 127

public setSchema(v $v)

at line 309

public __construct(string $name = null)

at line 333

public setupObject()

at line 374

public string getBuildProperty(string $key)

at line 382

public applyBehaviors()

at line 400

public doFinalInitialization()

at line 466

public addExtraIndices()

at line 575

public string getColumnList(array $columns, string $delim = ',')

at line 592

public doNaming()

at line 657

public The getBaseClass()

at line 672

public setBaseClass(v $v)

at line 681

public value getBasePeer()

at line 696

public setBasePeer(v $v)

at line 709

public Column addColumn($data)

at line 745

public removeColumn(Column|string $col)

at line 762

public adjustColumnPositions()

at line 782

public Validator addValidator(mixed $data)

at line 810

public removeValidatorForColumn(string $columnName)

at line 823

public addForeignKey($fkdata)

at line 852

public Column getChildrenColumn()

at line 861

public array getChildrenNames()

at line 879

public addReferrer(ForeignKey $fk)

at line 890

public getReferrers()

at line 901

public setupReferrers($throwErrors = false)

at line 970

public getCrossFks()

at line 987

public setContainsForeignPK($b)

at line 995

public getContainsForeignPK()

at line 1003

public getForeignTableNames()

at line 1015

public requiresTransactionInPostgres()

at line 1024

public addIdMethodParameter($impdata)

at line 1048

public removeIndex(string $name)

at line 1066

public bool hasIndex(string $name)

at line 1080

public addIndex($idxdata)

at line 1101

public addUnique($unqdata)

at line 1123

public GeneratorConfig getGeneratorConfig()

at line 1132

public Behavior addBehavior($bdata)

at line 1153

public Array getBehaviors()

at line 1162

public Array getEarlyBehaviors()

at line 1180

public boolean hasBehavior(string $name)

at line 1191

public Behavior getBehavior(string $name)

at line 1202

public boolean hasAdditionalBuilders()

at line 1218

public array getAdditionalBuilders()

at line 1231

public getName()

at line 1244

public getDescription()

at line 1252

public hasDescription()

at line 1262

public setDescription(newDescription $newDescription)

at line 1271

public string getPhpName()

at line 1292

public setPhpName(string $phpName)

at line 1297

public buildPhpName($name)

at line 1309

public string getStudlyPhpName()

at line 1323

public getCommonName()

at line 1331

public setCommonName($v)

at line 1341

public setDefaultStringFormat(string $defaultStringFormat)

at line 1352

public string getDefaultStringFormat()

at line 1368

public string getIdMethod()

at line 1383

public boolean isAllowPkInsert()

at line 1392

public setIdMethod($idMethod)

at line 1402

public boolean isSkipSql()

at line 1412

public boolan isReadOnly()

at line 1421

public setSkipSql(boolean $v)

at line 1430

public boolean isReloadOnInsert()

at line 1439

public boolean isReloadOnUpdate()

at line 1448

public value getAlias()

at line 1458

public value isAlias()

at line 1468

public setAlias(v $v)

at line 1477

public value getInterface()

at line 1486

public setInterface(v $v)

at line 1499

public value isAbstract()

at line 1513

public setAbstract(v $v)

at line 1522

public array getColumns()

at line 1530

public getNumColumns()

at line 1538

public getNumLazyLoadColumns()

at line 1554

public boolean hasEnumColumns()

at line 1570

public array getValidators()

at line 1579

public array getForeignKeys()

at line 1588

public getIdMethodParameters()

at line 1597

public array getIndices()

at line 1606

public array getUnices()

at line 1618

public boolean hasColumn(Column|string $col, boolean $caseInsensitive = false)

at line 1637

public Column getColumn(string $name, boolean $caseInsensitive = false)

at line 1654

public Column getColumnByPhpName($phpName)

at line 1667

public array getForeignKeysReferencingTable($tablename)

at line 1686

public array getColumnForeignKeys($colname)

at line 1704

public boolean containsColumn(Column|string $col)

at line 1714

public setDatabase(Database $db)

at line 1724

public Database getDatabase()

at line 1734

public boolean isForReferenceOnly()

at line 1744

public setForReferenceOnly(boolean $v)

at line 1753

public valur treeMode()

at line 1762

public setTreeMode(v $v)

at line 1772

public appendXml(DOMNode $node)

at line 1883

public array getPrimaryKey()

at line 1900

public boolean hasPrimaryKey()

at line 1910

public boolean hasCompositePrimaryKey()

at line 1919

public getFirstPrimaryKeyColumn()

at line 1933

public boolean hasAutoIncrementPrimaryKey()

at line 1952

public Column getAutoIncrementPrimaryKey()

at line 1972

public A printPrimaryKey()

at line 1981

public boolean getIsCrossRef()

at line 1990

public setIsCrossRef(boolean $isCrossRef)

at line 2019

public Boolean hasForeignKeys()

at line 2028

public Boolean hasCrossForeignKeys()

at line 2036

public string getNonPrefixedName()