Propel\Generator\Model\Table

class Table extends ScopedMappingModel implements IdMethod

Methods

	__construct(string $name = null) Constructs a table object with a name
string	getNamespace() Returns the namespace.	from ScopedMappingModel
	setNamespace(string $namespace) Sets the namespace.	from ScopedMappingModel
boolean	isAbsoluteNamespace(string $namespace) Returns whether or not the namespace is absolute.	from ScopedMappingModel
string	getPackage() Returns the package name.	from ScopedMappingModel
	setPackage(string $package) Sets the package name.	from ScopedMappingModel
string	getSchema() Returns the schema name.	from ScopedMappingModel
	setSchema(string $schema) Sets the schema name.	from ScopedMappingModel
	setupObject()
string	getBuildProperty(string $key) Returns a build property value for the database this table belongs to.
	applyBehaviors() Executes 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 $delimiter = ',') Returns a delimiter-delimited string list of column names.
	doNaming() Names composing objects which haven't yet been named.
string	getBaseClass() Returns the name of the base class used for superclass of all objects of this table.
	setBaseClass(string $class) Sets the base class name.
Column	addColumn(Column|array $col) Adds a new column to the table.
	removeColumn(Column|string $column) Removes a column from the table.
	adjustColumnPositions()
ForeignKey	addForeignKey(ForeignKey|array $fkdata) Adds a new foreign key to this table.
Column	getChildrenColumn() Returns the column that subclasses the class representing this table can be produced from.
array	getChildrenNames() Returns the subclasses that can be created from this table.
	addReferrer(ForeignKey $fk) Adds the foreign key from another table that refers to this table.
array	getReferrers() Returns the list of references to this table.
	setupReferrers(boolean $throwErrors = false) Browses the foreign keys and creates referrers for the foreign table.
array	getCrossFks() Returns the list of cross foreign keys.
boolean	setContainsForeignPK($b) Sets whether or not this table contains a foreign primary key.
boolean	getContainsForeignPK() Returns whether or not this table contains a foreign primary key.
array	getForeignTableNames() Returns the list of tables referenced by foreign keys in this table.
boolean	requiresTransactionInPostgres() Return true if the column requires a transaction in Postgres.
	addIdMethodParameter(IdMethodParameter $idMethodParameter) Adds a new parameter for the strategy that generates primary keys.
	removeIndex(string $name) Removes a index from the table.
bool	hasIndex(string $name) Checks if the table has a index by name.
Index	addIndex(Index $index) Adds a new index to the indices list and set the parent table of the column to the current table.
Unique	addUnique(Unique $unique) Adds a new Unique index to the list of unique indices 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() Returns the list of 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() Returns whether or not the table behaviors offer additional builders.
Array	getEarlyBehaviors() Get the early table behaviors
array	getAdditionalBuilders() Returns the list of additional builders provided by the table behaviors.
string	getName() Returns the full table name (including schema name when possible).
string	getDescription() Returns the table description.
boolean	hasDescription() Returns whether or not the table has a description.
	setDescription(string $description) Sets the table description.
string	getPhpName() Returns the name to use in PHP sources.
	setPhpName(string $phpName) Sets the name to use in PHP sources.
string	getStudlyPhpName() Returns the studly version of PHP name.
string	getCommonName() Returns the common name (without schema name).
	setCommonName(string $name) Sets the table common name (without schema name).
	setDefaultStringFormat(string $format) Sets the default string format for ActiveRecord objects in this table.
string	getDefaultStringFormat() Returns the default string format for ActiveRecord objects in this table, or the one for the whole database if not set.
string	getIdMethod() Returns the method strategy for generating primary keys.
boolean	isAllowPkInsert() Returns whether we allow to insert primary keys on tables with native id method.
	setIdMethod(string $idMethod) Sets the method strategy for generating primary keys.
boolean	isSkipSql() Returns whether or not Propel has to skip DDL SQL generation for this table (in the event it should not be created from scratch).
	setSkipSql(boolean $skip) Sets whether or not this table should have its SQL DDL code generated.
boolean	isReadOnly() Returns whether or not this table is read-only.
boolean	isReloadOnInsert() Whether to force object to reload on INSERT.
boolean	isReloadOnUpdate() Returns whether or not to force object to reload on UPDATE.
string	getAlias() Returns the PHP name of an active record object this entry references.
boolean	isAlias() Returns whether or not this table is specified in the schema or if there is just a foreign key reference to it.
	setAlias(string $alias) Sets whether or not this table is specified in the schema or if there is just a foreign key reference to it.
string	getInterface() Returns the interface objects of this table will implement.
	setInterface(string $interface) Sets the interface objects of this table will implement.
boolean	isAbstract() Returns whether or not a table is abstract, it marks the business object class that is generated as being abstract.
	setAbstract(boolean $isAbstract) Sets whether or not a table is abstract, it marks the business object class that is generated as being abstract.
Column[]	getColumns() Returns an array containing all Column objects in the table.
integer	getNumColumns() Returns the number of columns in this table.
integer	getNumLazyLoadColumns() Returns the number of lazy loaded columns in this table.
boolean	hasEnumColumns() Returns whether or not one of the columns is of type ENUM.
array	getForeignKeys() Returns the list of all foreign keys.
	getIdMethodParameters() Returns a Collection of parameters relevant for the chosen id generation method.
array	getIndices() Returns the list of all indices of this table.
array	getUnices() Returns the list of all unique indices of this table.
boolean	hasColumn(Column|string $column, boolean $caseInsensitive = false) Returns whether or not the table has a column.
Column	getColumn(string $name, boolean $caseInsensitive = false) Returns the Column object with the specified name.
Column	getColumnByPhpName(string $phpName) Returns a specified column by its php name.
array	getForeignKeysReferencingTable(string $tableName) Returns all foreign keys from this table that reference the table passed in argument.
array	getColumnForeignKeys(string $column) Returns the foreign keys that include column in it's list of local columns.
	setDatabase(Database $database) Set the database that contains this table.
Database	getDatabase() Get the database that contains this table.
PlatformInterface	getPlatform() Returns the Database platform.
boolean	isForReferenceOnly() Returns whether or not code and SQL must be created for this table.
	setForReferenceOnly(boolean $v) Returns whether or not to determine if code/sql gets created for this table.
	appendXml(DOMNode $node) Appends XML nodes to passed-in DOMNode.
Column[]	getPrimaryKey() Returns the collection of Columns which make up the single primary key for this table.
boolean	hasPrimaryKey() Returns whether or not this table has a primary key.
boolean	hasCompositePrimaryKey() Returns whether or not this table has a composite primary key.
Column	getFirstPrimaryKeyColumn() Returns the first primary key column.
boolean	hasAutoIncrementPrimaryKey() Returns whether or not this table has any auto-increment primary keys.
Column	getAutoIncrementPrimaryKey() Returns the auto incremented primary key.
boolean	getIsCrossRef() Returns whether or not there is a cross reference status for this foreign key.
boolean	isCrossRef() Alias for Table::getIsCrossRef.
	setIsCrossRef(boolean $isCrossRef) Sets a cross reference status for this foreign key.
boolean	hasForeignKeys() Returns whether or not the table has foreign keys.
boolean	hasCrossForeignKeys() Returns whether the table has cross foreign keys or not.

Details

at line 71

public __construct(string $name = null)

in ScopedMappingModel at line 57

public string getNamespace()

in ScopedMappingModel at line 67

public setNamespace(string $namespace)

in ScopedMappingModel at line 90

public boolean isAbsoluteNamespace(string $namespace)

in ScopedMappingModel at line 100

public string getPackage()

in ScopedMappingModel at line 110

public setPackage(string $package)

in ScopedMappingModel at line 125

public string getSchema()

in ScopedMappingModel at line 135

public setSchema(string $schema)

at line 118

public setupObject()

at line 162

public string getBuildProperty(string $key)

at line 171

public applyBehaviors()

at line 189

public doFinalInitialization()

at line 251

public addExtraIndices()

at line 361

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

at line 378

public doNaming()

at line 438

public string getBaseClass()

at line 456

public setBaseClass(string $class)

at line 467

public Column addColumn(Column|array $col)

at line 506

public removeColumn(Column|string $column)

at line 539

public adjustColumnPositions()

at line 554

public ForeignKey addForeignKey(ForeignKey|array $fkdata)

at line 581

public Column getChildrenColumn()

at line 591

public array getChildrenNames()

at line 611

public addReferrer(ForeignKey $fk)

at line 621

public array getReferrers()

at line 634

public setupReferrers(boolean $throwErrors = false)

at line 707

public array getCrossFks()

at line 726

public boolean setContainsForeignPK($b)

at line 736

public boolean getContainsForeignPK()

at line 746

public array getForeignTableNames()

at line 756

public boolean requiresTransactionInPostgres()

at line 766

public addIdMethodParameter(IdMethodParameter $idMethodParameter)

at line 787

public removeIndex(string $name)

at line 805

public bool hasIndex(string $name)

at line 823

public Index addIndex(Index $index)

at line 847

public Unique addUnique(Unique $unique)

at line 868

public GeneratorConfig getGeneratorConfig()

at line 878

public Behavior addBehavior($bdata)

at line 900

public array getBehaviors()

at line 911

public boolean hasBehavior(string $name)

at line 922

public Behavior getBehavior(string $name)

at line 932

public boolean hasAdditionalBuilders()

at line 947

public Array getEarlyBehaviors()

at line 964

public array getAdditionalBuilders()

at line 979

public string getName()

at line 997

public string getDescription()

at line 1007

public boolean hasDescription()

at line 1017

public setDescription(string $description)

at line 1028

public string getPhpName()

at line 1046

public setPhpName(string $phpName)

at line 1068

public string getStudlyPhpName()

at line 1078

public string getCommonName()

at line 1088

public setCommonName(string $name)

at line 1101

public setDefaultStringFormat(string $format)

at line 1119

public string getDefaultStringFormat()

at line 1136

public string getIdMethod()

at line 1147

public boolean isAllowPkInsert()

at line 1157

public setIdMethod(string $idMethod)

at line 1168

public boolean isSkipSql()

at line 1178

public setSkipSql(boolean $skip)

at line 1189

public boolean isReadOnly()

at line 1198

public boolean isReloadOnInsert()

at line 1208

public boolean isReloadOnUpdate()

at line 1218

public string getAlias()

at line 1229

public boolean isAlias()

at line 1240

public setAlias(string $alias)

at line 1250

public string getInterface()

at line 1260

public setInterface(string $interface)

at line 1273

public boolean isAbstract()

at line 1286

public setAbstract(boolean $isAbstract)

at line 1296

public Column[] getColumns()

at line 1306

public integer getNumColumns()

at line 1316

public integer getNumLazyLoadColumns()

at line 1333

public boolean hasEnumColumns()

at line 1349

public array getForeignKeys()

at line 1358

public getIdMethodParameters()

at line 1368

public array getIndices()

at line 1378

public array getUnices()

at line 1390

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

at line 1410

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

at line 1429

public Column getColumnByPhpName(string $phpName)

at line 1445

public array getForeignKeysReferencingTable(string $tableName)

at line 1467

public array getColumnForeignKeys(string $column)

at line 1484

public setDatabase(Database $database)

at line 1494

public Database getDatabase()

at line 1504

public PlatformInterface getPlatform()

at line 1516

public boolean isForReferenceOnly()

at line 1526

public setForReferenceOnly(boolean $v)

at line 1536

public appendXml(DOMNode $node)

at line 1634

public Column[] getPrimaryKey()

at line 1651

public boolean hasPrimaryKey()

at line 1661

public boolean hasCompositePrimaryKey()

at line 1673

public Column getFirstPrimaryKeyColumn()

at line 1687

public boolean hasAutoIncrementPrimaryKey()

at line 1697

public Column getAutoIncrementPrimaryKey()

at line 1714

public boolean getIsCrossRef()

at line 1724

public boolean isCrossRef()

at line 1734

public setIsCrossRef(boolean $isCrossRef)

at line 1744

public boolean hasForeignKeys()

at line 1754

public boolean hasCrossForeignKeys()