abstract class DataModelBuilder
This is the base class for any builder class that is using the data model.
This could be extended by classes that build SQL DDL, PHP classes, configuration files, input forms, etc.
The GeneratorConfig needs to be set on this class in order for the builders to be able to access the propel generator build properties. You should be safe if you always use the GeneratorConfig to get a configured builder class anyway.
Methods
__construct(Table $table)
Creates new instance of DataModelBuilder subclass. |
||
PeerBuilder |
getPeerBuilder()
Returns new or existing Peer builder class for this table. |
|
Pluralizer |
getPluralizer()
Returns new or existing Pluralizer class. |
|
PeerBuilder |
getStubPeerBuilder()
Returns new or existing stub Peer builder class for this table. |
|
ObjectBuilder |
getObjectBuilder()
Returns new or existing Object builder class for this table. |
|
ObjectBuilder |
getStubObjectBuilder()
Returns new or existing stub Object builder class for this table. |
|
ObjectBuilder |
getQueryBuilder()
Returns new or existing Query builder class for this table. |
|
ObjectBuilder |
getStubQueryBuilder()
Returns new or existing stub Query builder class for this table. |
|
ObjectBuilder |
getTableMapBuilder()
Returns new or existing Object builder class for this table. |
|
ObjectBuilder |
getInterfaceBuilder()
Returns new or existing stub Interface builder class for this table. |
|
ObjectBuilder |
getMultiExtendObjectBuilder()
Returns new or existing stub child object builder class for this table. |
|
ObjectBuilder |
getNodeBuilder()
Returns new or existing node Object builder class for this table. |
|
PeerBuilder |
getNodePeerBuilder()
Returns new or existing node Peer builder class for this table. |
|
ObjectBuilder |
getStubNodeBuilder()
Returns new or existing stub node Object builder class for this table. |
|
PeerBuilder |
getStubNodePeerBuilder()
Returns new or existing stub node Peer builder class for this table. |
|
ObjectBuilder |
getNestedSetBuilder()
Returns new or existing nested set object builder class for this table. |
|
PeerBuilder |
getNestedSetPeerBuilder()
Returns new or existing nested set Peer builder class for this table. |
|
DataSQLBuilder |
getDataSQLBuilder()
Returns new or existing data sql builder class for this table. |
|
DataModelBuilder |
getNewBuilder(Table $table, string $classname)
Gets a new data model builder class for specified table and classname. |
|
PeerBuilder |
getNewPeerBuilder(Table $table)
Convenience method to return a NEW Peer class builder instance. |
|
PeerBuilder |
getNewStubPeerBuilder(Table $table)
Convenience method to return a NEW Peer stub class builder instance. |
|
ObjectBuilder |
getNewObjectBuilder(Table $table)
Convenience method to return a NEW Object class builder instance. |
|
ObjectBuilder |
getNewStubObjectBuilder(Table $table)
Convenience method to return a NEW Object stub class builder instance. |
|
QueryBuilder |
getNewQueryBuilder(Table $table)
Convenience method to return a NEW query class builder instance. |
|
QueryBuilder |
getNewStubQueryBuilder(Table $table)
Convenience method to return a NEW query stub class builder instance. |
|
ObjectBuilder |
getNewQueryInheritanceBuilder($child)
Returns new Query Inheritance builder class for this table. |
|
ObjectBuilder |
getNewStubQueryInheritanceBuilder($child)
Returns new stub Query Inheritance builder class for this table. |
|
GeneratorConfig |
getGeneratorConfig()
Gets the GeneratorConfig object. |
|
string |
getBuildProperty(string $name)
Get a specific [name transformed] build property. |
|
setGeneratorConfig(GeneratorConfigInterface $v)
Sets the GeneratorConfig object. |
||
setTable(Table $table)
Sets the table for this builder. |
||
Table |
getTable()
Returns the current Table object. |
|
PropelPlatformInterface |
getPlatform()
Convenience method to returns the Platform class for this table (database). |
|
setPlatform(PropelPlatformInterface $platform)
Platform setter |
||
Database |
getDatabase()
Convenience method to returns the database for current table. |
|
array |
getWarnings()
Gets array of warning messages. |
|
string |
quoteIdentifier(string $text)
Wraps call to Platform->quoteIdentifier() with a check to see whether quoting is enabled. |
|
string |
prefixClassname($identifier)
Returns the name of the current class being built, with a possible prefix. |
Details
at line 180
public
__construct(Table $table)
Creates new instance of DataModelBuilder subclass.
at line 190
public PeerBuilder
getPeerBuilder()
Returns new or existing Peer builder class for this table.
at line 204
public Pluralizer
getPluralizer()
Returns new or existing Pluralizer class.
at line 218
public PeerBuilder
getStubPeerBuilder()
Returns new or existing stub Peer builder class for this table.
at line 232
public ObjectBuilder
getObjectBuilder()
Returns new or existing Object builder class for this table.
at line 246
public ObjectBuilder
getStubObjectBuilder()
Returns new or existing stub Object builder class for this table.
at line 260
public ObjectBuilder
getQueryBuilder()
Returns new or existing Query builder class for this table.
at line 274
public ObjectBuilder
getStubQueryBuilder()
Returns new or existing stub Query builder class for this table.
at line 288
public ObjectBuilder
getTableMapBuilder()
Returns new or existing Object builder class for this table.
at line 302
public ObjectBuilder
getInterfaceBuilder()
Returns new or existing stub Interface builder class for this table.
at line 316
public ObjectBuilder
getMultiExtendObjectBuilder()
Returns new or existing stub child object builder class for this table.
at line 330
public ObjectBuilder
getNodeBuilder()
Returns new or existing node Object builder class for this table.
at line 344
public PeerBuilder
getNodePeerBuilder()
Returns new or existing node Peer builder class for this table.
at line 358
public ObjectBuilder
getStubNodeBuilder()
Returns new or existing stub node Object builder class for this table.
at line 372
public PeerBuilder
getStubNodePeerBuilder()
Returns new or existing stub node Peer builder class for this table.
at line 386
public ObjectBuilder
getNestedSetBuilder()
Returns new or existing nested set object builder class for this table.
at line 400
public PeerBuilder
getNestedSetPeerBuilder()
Returns new or existing nested set Peer builder class for this table.
at line 414
public DataSQLBuilder
getDataSQLBuilder()
Returns new or existing data sql builder class for this table.
at line 431
public DataModelBuilder
getNewBuilder(Table $table, string $classname)
Gets a new data model builder class for specified table and classname.
at line 449
public PeerBuilder
getNewPeerBuilder(Table $table)
Convenience method to return a NEW Peer class builder instance.
This is used very frequently from the peer and object builders to get a peer builder for a RELATED table.
at line 464
public PeerBuilder
getNewStubPeerBuilder(Table $table)
Convenience method to return a NEW Peer stub class builder instance.
This is used from the peer and object builders to get a peer builder for a RELATED table.
at line 479
public ObjectBuilder
getNewObjectBuilder(Table $table)
Convenience method to return a NEW Object class builder instance.
This is used very frequently from the peer and object builders to get an object builder for a RELATED table.
at line 494
public ObjectBuilder
getNewStubObjectBuilder(Table $table)
Convenience method to return a NEW Object stub class builder instance.
This is used from the query builders to get an object builder for a RELATED table.
at line 509
public QueryBuilder
getNewQueryBuilder(Table $table)
Convenience method to return a NEW query class builder instance.
This is used from the query builders to get a query builder for a RELATED table.
at line 524
public QueryBuilder
getNewStubQueryBuilder(Table $table)
Convenience method to return a NEW query stub class builder instance.
This is used from the query builders to get a query builder for a RELATED table.
at line 534
public ObjectBuilder
getNewQueryInheritanceBuilder($child)
Returns new Query Inheritance builder class for this table.
at line 547
public ObjectBuilder
getNewStubQueryInheritanceBuilder($child)
Returns new stub Query Inheritance builder class for this table.
at line 560
public GeneratorConfig
getGeneratorConfig()
Gets the GeneratorConfig object.
at line 572
public string
getBuildProperty(string $name)
Get a specific [name transformed] build property.
at line 586
public
setGeneratorConfig(GeneratorConfigInterface $v)
Sets the GeneratorConfig object.
at line 596
public
setTable(Table $table)
Sets the table for this builder.
at line 606
public Table
getTable()
Returns the current Table object.
at line 616
public PropelPlatformInterface
getPlatform()
Convenience method to returns the Platform class for this table (database).
at line 633
public
setPlatform(PropelPlatformInterface $platform)
Platform setter
at line 643
public Database
getDatabase()
Convenience method to returns the database for current table.
at line 665
public array
getWarnings()
Gets array of warning messages.
at line 681
public string
quoteIdentifier(string $text)
Wraps call to Platform->quoteIdentifier() with a check to see whether quoting is enabled.
All subclasses should call this quoteIdentifier() method rather than calling the Platform method directly. This method is used by both DataSQLBuilder and DDLBuilder, and potentially in the OM builders also, which is why it is defined in this class.
at line 696
public string
prefixClassname($identifier)
Returns the name of the current class being built, with a possible prefix.