Propel API
Class

DataSQLBuilder

abstract class DataSQLBuilder extends DataModelBuilder

Baseclass for SQL data dump SQL building classes.

Methods

__construct(Table $table)

Creates new instance of DataModelBuilder subclass.

from DataModelBuilder
PeerBuilder getPeerBuilder()

Returns new or existing Peer builder class for this table.

from DataModelBuilder
Pluralizer getPluralizer()

Returns new or existing Pluralizer class.

from DataModelBuilder
PeerBuilder getStubPeerBuilder()

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

from DataModelBuilder
ObjectBuilder getObjectBuilder()

Returns new or existing Object builder class for this table.

from DataModelBuilder
ObjectBuilder getStubObjectBuilder()

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

from DataModelBuilder
ObjectBuilder getQueryBuilder()

Returns new or existing Query builder class for this table.

from DataModelBuilder
ObjectBuilder getStubQueryBuilder()

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

from DataModelBuilder
ObjectBuilder getTableMapBuilder()

Returns new or existing Object builder class for this table.

from DataModelBuilder
ObjectBuilder getInterfaceBuilder()

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

from DataModelBuilder
ObjectBuilder getMultiExtendObjectBuilder()

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

from DataModelBuilder
ObjectBuilder getNodeBuilder()

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

from DataModelBuilder
PeerBuilder getNodePeerBuilder()

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

from DataModelBuilder
ObjectBuilder getStubNodeBuilder()

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

from DataModelBuilder
PeerBuilder getStubNodePeerBuilder()

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

from DataModelBuilder
ObjectBuilder getNestedSetBuilder()

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

from DataModelBuilder
PeerBuilder getNestedSetPeerBuilder()

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

from DataModelBuilder
DataSQLBuilder getDataSQLBuilder()

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

from DataModelBuilder
DataModelBuilder getNewBuilder(Table $table, string $classname)

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

from DataModelBuilder
PeerBuilder getNewPeerBuilder(Table $table)

Convenience method to return a NEW Peer class builder instance.

from DataModelBuilder
PeerBuilder getNewStubPeerBuilder(Table $table)

Convenience method to return a NEW Peer stub class builder instance.

from DataModelBuilder
ObjectBuilder getNewObjectBuilder(Table $table)

Convenience method to return a NEW Object class builder instance.

from DataModelBuilder
ObjectBuilder getNewStubObjectBuilder(Table $table)

Convenience method to return a NEW Object stub class builder instance.

from DataModelBuilder
QueryBuilder getNewQueryBuilder(Table $table)

Convenience method to return a NEW query class builder instance.

from DataModelBuilder
QueryBuilder getNewStubQueryBuilder(Table $table)

Convenience method to return a NEW query stub class builder instance.

from DataModelBuilder
ObjectBuilder getNewQueryInheritanceBuilder($child)

Returns new Query Inheritance builder class for this table.

from DataModelBuilder
ObjectBuilder getNewStubQueryInheritanceBuilder($child)

Returns new stub Query Inheritance builder class for this table.

from DataModelBuilder
GeneratorConfig getGeneratorConfig()

Gets the GeneratorConfig object.

from DataModelBuilder
string getBuildProperty(string $name)

Get a specific [name transformed] build property.

from DataModelBuilder
setGeneratorConfig(GeneratorConfigInterface $v)

Sets the GeneratorConfig object.

from DataModelBuilder
setTable(Table $table)

Sets the table for this builder.

from DataModelBuilder
Table getTable()

Returns the current Table object.

from DataModelBuilder
PropelPlatformInterface getPlatform()

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

from DataModelBuilder
setPlatform(PropelPlatformInterface $platform)

Platform setter

from DataModelBuilder
Database getDatabase()

Convenience method to returns the database for current table.

from DataModelBuilder
array getWarnings()

Gets array of warning messages.

from DataModelBuilder
string quoteIdentifier(string $text)

Wraps call to Platform->quoteIdentifier() with a check to see whether quoting is enabled.

from DataModelBuilder
string prefixClassname($identifier)

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

from DataModelBuilder
static  reset()

Perform any reset between runs of this builder.

static string getDatabaseStartSql()

Gets any SQL to place at the start of all the row inserts.

static string getDatabaseEndSql()

Gets any SQL to place at the end of all the row inserts.

string getTableStartSql()

Gets any SQL to place before row inserts for a new table.

string getTableEndSql()

Gets any SQL to place at the end of row inserts for a table.

string buildRowSql(DataRow $row)

The main method in this class, returns the SQL for INSERTing data into a row.

string getTimestampSql(string $value)

Gets a representation of a timestamp value suitable for use in a SQL statement.

Details

in DataModelBuilder 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.].

in DataModelBuilder at line 168
public PeerBuilder getPeerBuilder()

Returns new or existing Peer builder class for this table.

Return Value

PeerBuilder

in DataModelBuilder at line 180
public Pluralizer getPluralizer()

Returns new or existing Pluralizer class.

Return Value

Pluralizer

in DataModelBuilder at line 192
public PeerBuilder getStubPeerBuilder()

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

Return Value

PeerBuilder

in DataModelBuilder at line 204
public ObjectBuilder getObjectBuilder()

Returns new or existing Object builder class for this table.

Return Value

ObjectBuilder

in DataModelBuilder at line 216
public ObjectBuilder getStubObjectBuilder()

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

Return Value

ObjectBuilder

in DataModelBuilder at line 228
public ObjectBuilder getQueryBuilder()

Returns new or existing Query builder class for this table.

Return Value

ObjectBuilder

in DataModelBuilder at line 240
public ObjectBuilder getStubQueryBuilder()

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

Return Value

ObjectBuilder

in DataModelBuilder at line 252
public ObjectBuilder getTableMapBuilder()

Returns new or existing Object builder class for this table.

Return Value

ObjectBuilder

in DataModelBuilder at line 264
public ObjectBuilder getInterfaceBuilder()

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

Return Value

ObjectBuilder

in DataModelBuilder at line 276
public ObjectBuilder getMultiExtendObjectBuilder()

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

Return Value

ObjectBuilder

in DataModelBuilder at line 288
public ObjectBuilder getNodeBuilder()

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

Return Value

ObjectBuilder

in DataModelBuilder at line 300
public PeerBuilder getNodePeerBuilder()

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

Return Value

PeerBuilder

in DataModelBuilder at line 312
public ObjectBuilder getStubNodeBuilder()

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

Return Value

ObjectBuilder

in DataModelBuilder at line 324
public PeerBuilder getStubNodePeerBuilder()

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

Return Value

PeerBuilder

in DataModelBuilder at line 336
public ObjectBuilder getNestedSetBuilder()

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

Return Value

ObjectBuilder

in DataModelBuilder at line 348
public PeerBuilder getNestedSetPeerBuilder()

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

Return Value

PeerBuilder

in DataModelBuilder at line 360
public DataSQLBuilder getDataSQLBuilder()

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

Return Value

DataSQLBuilder

in DataModelBuilder 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

in 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

in DataModelBuilder 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

in DataModelBuilder 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

in DataModelBuilder 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

in DataModelBuilder 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

in DataModelBuilder 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

in DataModelBuilder at line 470
public ObjectBuilder getNewQueryInheritanceBuilder($child)

Returns new Query Inheritance builder class for this table.

Parameters

$child

Return Value

ObjectBuilder

in DataModelBuilder at line 481
public ObjectBuilder getNewStubQueryInheritanceBuilder($child)

Returns new stub Query Inheritance builder class for this table.

Parameters

$child

Return Value

ObjectBuilder

in DataModelBuilder at line 493
public GeneratorConfig getGeneratorConfig()

Gets the GeneratorConfig object.

Return Value

GeneratorConfig

in DataModelBuilder at line 504
public string getBuildProperty(string $name)

Get a specific [name transformed] build property.

Parameters

string $name

Return Value

string

in DataModelBuilder at line 517
public setGeneratorConfig(GeneratorConfigInterface $v)

Sets the GeneratorConfig object.

Parameters

GeneratorConfigInterface $v

in DataModelBuilder at line 526
public setTable(Table $table)

Sets the table for this builder.

Parameters

Table $table

in DataModelBuilder at line 535
public Table getTable()

Returns the current Table object.

Return Value

Table

in DataModelBuilder at line 544
public PropelPlatformInterface getPlatform()

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

in DataModelBuilder at line 560
public setPlatform(PropelPlatformInterface $platform)

Platform setter

Parameters

PropelPlatformInterface $platform

in DataModelBuilder at line 569
public Database getDatabase()

Convenience method to returns the database for current table.

Return Value

Database

in DataModelBuilder at line 589
public array getWarnings()

Gets array of warning messages.

Return Value

array string[]

in DataModelBuilder 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.

in DataModelBuilder 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()

at line 28
static public reset()

Perform any reset between runs of this builder.

This can be used, for example, to clear any stored start/end SQL.

at line 38
static public string getDatabaseStartSql()

Gets any SQL to place at the start of all the row inserts.

Return Value

string

at line 48
static public string getDatabaseEndSql()

Gets any SQL to place at the end of all the row inserts.

Return Value

string

at line 58
public string getTableStartSql()

Gets any SQL to place before row inserts for a new table.

Return Value

string

at line 68
public string getTableEndSql()

Gets any SQL to place at the end of row inserts for a table.

Return Value

string

at line 78
public string buildRowSql(DataRow $row)

The main method in this class, returns the SQL for INSERTing data into a row.

Parameters

DataRow $row The row to process.

Return Value

string

at line 248
public string getTimestampSql(string $value)

Gets a representation of a timestamp value suitable for use in a SQL statement.

Parameters

string $value

Return Value

string