Propel API
Class

DataModelBuilder

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 159
public __construct(Table $table)

Creates new instance of DataModelBuilder subclass.

Parameters

Table $table The Table which we are using to build [OM, DDL, etc.].

at line 168
public PeerBuilder getPeerBuilder()

Returns new or existing Peer builder class for this table.

Return Value

PeerBuilder

at line 180
public Pluralizer getPluralizer()

Returns new or existing Pluralizer class.

Return Value

Pluralizer

at line 192
public PeerBuilder getStubPeerBuilder()

Returns new or existing stub Peer builder class for this table.

Return Value

PeerBuilder

at line 204
public ObjectBuilder getObjectBuilder()

Returns new or existing Object builder class for this table.

Return Value

ObjectBuilder

at line 216
public ObjectBuilder getStubObjectBuilder()

Returns new or existing stub Object builder class for this table.

Return Value

ObjectBuilder

at line 228
public ObjectBuilder getQueryBuilder()

Returns new or existing Query builder class for this table.

Return Value

ObjectBuilder

at line 240
public ObjectBuilder getStubQueryBuilder()

Returns new or existing stub Query builder class for this table.

Return Value

ObjectBuilder

at line 252
public ObjectBuilder getTableMapBuilder()

Returns new or existing Object builder class for this table.

Return Value

ObjectBuilder

at line 264
public ObjectBuilder getInterfaceBuilder()

Returns new or existing stub Interface builder class for this table.

Return Value

ObjectBuilder

at line 276
public ObjectBuilder getMultiExtendObjectBuilder()

Returns new or existing stub child object builder class for this table.

Return Value

ObjectBuilder

at line 288
public ObjectBuilder getNodeBuilder()

Returns new or existing node Object builder class for this table.

Return Value

ObjectBuilder

at line 300
public PeerBuilder getNodePeerBuilder()

Returns new or existing node Peer builder class for this table.

Return Value

PeerBuilder

at line 312
public ObjectBuilder getStubNodeBuilder()

Returns new or existing stub node Object builder class for this table.

Return Value

ObjectBuilder

at line 324
public PeerBuilder getStubNodePeerBuilder()

Returns new or existing stub node Peer builder class for this table.

Return Value

PeerBuilder

at line 336
public ObjectBuilder getNestedSetBuilder()

Returns new or existing nested set object builder class for this table.

Return Value

ObjectBuilder

at line 348
public PeerBuilder getNestedSetPeerBuilder()

Returns new or existing nested set Peer builder class for this table.

Return Value

PeerBuilder

at line 360
public DataSQLBuilder getDataSQLBuilder()

Returns new or existing data sql builder class for this table.

Return Value

DataSQLBuilder

at line 375
public DataModelBuilder getNewBuilder(Table $table, string $classname)

Gets a new data model builder class for specified table and classname.

Parameters

Table $table
string $classname The class of builder

Return Value

DataModelBuilder

at line 391
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.

Parameters

Table $table

Return Value

PeerBuilder

at line 405
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.

Parameters

Table $table

Return Value

PeerBuilder

at line 419
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.

Parameters

Table $table

Return Value

ObjectBuilder

at line 433
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.

Parameters

Table $table

Return Value

ObjectBuilder

at line 447
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.

Parameters

Table $table

Return Value

QueryBuilder

at line 461
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.

Parameters

Table $table

Return Value

QueryBuilder

at line 470
public ObjectBuilder getNewQueryInheritanceBuilder($child)

Returns new Query Inheritance builder class for this table.

Parameters

$child

Return Value

ObjectBuilder

at line 481
public ObjectBuilder getNewStubQueryInheritanceBuilder($child)

Returns new stub Query Inheritance builder class for this table.

Parameters

$child

Return Value

ObjectBuilder

at line 493
public GeneratorConfig getGeneratorConfig()

Gets the GeneratorConfig object.

Return Value

GeneratorConfig

at line 504
public string getBuildProperty(string $name)

Get a specific [name transformed] build property.

Parameters

string $name

Return Value

string

at line 517
public setGeneratorConfig(GeneratorConfigInterface $v)

Sets the GeneratorConfig object.

Parameters

GeneratorConfigInterface $v

at line 526
public setTable(Table $table)

Sets the table for this builder.

Parameters

Table $table

at line 535
public Table getTable()

Returns the current Table object.

Return Value

Table

at line 544
public PropelPlatformInterface getPlatform()

Convenience method to returns the Platform class for this table (database).

Return Value

PropelPlatformInterface

at line 560
public setPlatform(PropelPlatformInterface $platform)

Platform setter

Parameters

PropelPlatformInterface $platform

at line 569
public Database getDatabase()

Convenience method to returns the database for current table.

Return Value

Database

at line 589
public array getWarnings()

Gets array of warning messages.

Return Value

array string[]

at line 604
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.

Parameters

string $text The text to quote.

Return Value

string Quoted text.

at line 617
public string prefixClassname($identifier)

Returns the name of the current class being built, with a possible prefix.

Parameters

$identifier

Return Value

string

See also

OMBuilder#getClassname()