Propel API
Class

DefaultPlatform

class DefaultPlatform implements PropelPlatformInterface

Default implementation for the Platform interface.

Methods

__construct(PDO $con = null)

Default constructor.
setConnection(PDO $con = null)

Set the database connection to use for this Platform class.
PDO getConnection()

Returns the database connection to use for this Platform class.
setGeneratorConfig(GeneratorConfigInterface $config)

Sets the GeneratorConfig to use in the parsing.
string getDatabaseType()

Returns the short name of the database type that this platform represents.
int getMaxColumnNameLength()

Returns the max column length supported by the db.
string getNativeIdMethod()

Returns the native IdMethod (sequence|identity)
isNativeIdMethodAutoIncrement()

Domain getDomainForType(string $propelType)

Returns the db specific domain for a propelType.
string getNullString($notNull)

The getAutoIncrement()

string getSequenceName(Table $table)

Gets the name to use for creating a sequence for a table.
string getAddTablesDDL(Database $database)

Builds the DDL SQL to add the tables of a database together with index and foreign keys
string getBeginDDL()

Gets the requests to execute at the beginning of a DDL file
string getEndDDL()

Gets the requests to execute at the end of a DDL file
string getDropTableDDL(Table $table)

Builds the DDL SQL to drop a table
string getAddTableDDL(Table $table)

Builds the DDL SQL to add a table without index and foreign keys
string getColumnDDL(Column $col)

Builds the DDL SQL for a Column object.
string getColumnDefaultValueDDL(Column $col)

Returns the SQL for the default value of a Column object
string getColumnListDDL($columns, $delimiter = ',')

Creates a delimiter-delimited string list of column names, quoted using quoteIdentifier().
string getPrimaryKeyName(Table $table)

Returns the name of a table primary key
string getPrimaryKeyDDL(Table $table)

Returns the SQL for the primary key of a Table object
string getDropPrimaryKeyDDL(Table $table)

Builds the DDL SQL to drop the primary key of a table.
string getAddPrimaryKeyDDL(Table $table)

Builds the DDL SQL to add the primary key of a table.
string getAddIndicesDDL(Table $table)

Builds the DDL SQL to add the indices of a table.
string getAddIndexDDL(Index $index)

Builds the DDL SQL to add an Index.
string getDropIndexDDL(Index $index)

Builds the DDL SQL to drop an Index.
string getIndexDDL(Index $index)

Builds the DDL SQL for an Index object.
string getUniqueDDL(Unique $unique)

Builds the DDL SQL for a Unique constraint object.
string getAddForeignKeysDDL(Table $table)

Builds the DDL SQL to add the foreign keys of a table.
string getAddForeignKeyDDL(ForeignKey $fk)

Builds the DDL SQL to add a foreign key.
string getDropForeignKeyDDL(ForeignKey $fk)

Builds the DDL SQL to drop a foreign key.
string getForeignKeyDDL(ForeignKey $fk)

Builds the DDL SQL for a ForeignKey object.
getCommentLineDDL($comment)

getCommentBlockDDL($comment)

string getModifyDatabaseDDL(PropelDatabaseDiff $databaseDiff)

Builds the DDL SQL to modify a database based on a PropelDatabaseDiff instance
string getRenameTableDDL($fromTableName, $toTableName)

Builds the DDL SQL to rename a table
string getModifyTableDDL(PropelTableDiff $tableDiff)

Builds the DDL SQL to alter a table based on a PropelTableDiff instance
string getModifyTableColumnsDDL(PropelTableDiff $tableDiff)

Builds the DDL SQL to alter a table based on a PropelTableDiff instance
string getModifyTablePrimaryKeyDDL(PropelTableDiff $tableDiff)

Builds the DDL SQL to alter a table's primary key based on a PropelTableDiff instance
string getModifyTableIndicesDDL(PropelTableDiff $tableDiff)

Builds the DDL SQL to alter a table's indices based on a PropelTableDiff instance
string getModifyTableForeignKeysDDL(PropelTableDiff $tableDiff)

Builds the DDL SQL to alter a table's foreign keys based on a PropelTableDiff instance
string getRemoveColumnDDL(Column $column)

Builds the DDL SQL to remove a column
string getRenameColumnDDL($fromColumn, $toColumn)

Builds the DDL SQL to rename a column
string getModifyColumnDDL(PropelColumnDiff $columnDiff)

Builds the DDL SQL to modify a column
string getModifyColumnsDDL($columnDiffs)

Builds the DDL SQL to modify a list of columns
string getAddColumnDDL(Column $column)

Builds the DDL SQL to remove a column
string getAddColumnsDDL($columns)

Builds the DDL SQL to remove a list of columns
boolean hasSize(string $sqlType)

Returns if the RDBMS-specific SQL type has a size attribute.
boolean hasScale(string $sqlType)

Returns if the RDBMS-specific SQL type has a scale attribute.
string quote(string $text)

Quote and escape needed characters in the string for unerlying RDBMS.
string quoteIdentifier(string $text)

Quotes identifiers used in database SQL.
setIdentifierQuoting($enabled = true)

getIdentifierQuoting()

boolean supportsNativeDeleteTrigger()

Whether RDBMS supports native ON DELETE triggers (e.g.
boolean supportsInsertNullPk()

Whether RDBMS supports INSERT null values in autoincremented primary keys
boolean hasStreamBlobImpl()

Whether the underlying PDO driver for this platform returns BLOB columns as streams (instead of strings).
supportsSchemas()

supportsMigrations()

supportsVarcharWithoutSize()

mixed getBooleanString($b)

Returns the boolean value for the RDBMS.
getPhpArrayString($stringValue)

string getTimestampFormatter()

Gets the preferred timestamp formatter for setting date/time values.
string getTimeFormatter()

Gets the preferred time formatter for setting date/time values.
string getDateFormatter()

Gets the preferred date formatter for setting date/time values.
getColumnBindingPHP($column, $identifier, $columnValueAccessor, $tab = ' ')

Get the PHP snippet for binding a value to a column.
getIdentifierPhp($columnValueMutator, $connectionVariableName = '$con', $sequenceName = '', $tab = ' ')

Get the PHP snippet for getting a Pk from the database.

Details

at line 48
public __construct(PDO $con = null)

Default constructor.

Parameters

PDO $con Optional database connection to use in this platform.

at line 58
public setConnection(PDO $con = null)

Set the database connection to use for this Platform class.

Parameters

PDO $con Database connection to use in this platform.

at line 67
public PDO getConnection()

Returns the database connection to use for this Platform class.

Return Value

PDO The database connection or NULL if none has been set.

at line 77
public setGeneratorConfig(GeneratorConfigInterface $config)

Sets the GeneratorConfig to use in the parsing.

Parameters

GeneratorConfigInterface $config

at line 128
public string getDatabaseType()

Returns the short name of the database type that this platform represents.

For example MysqlPlatform->getDatabaseType() returns 'mysql'.

Return Value

string

at line 141
public int getMaxColumnNameLength()

Returns the max column length supported by the db.

Return Value

int The max column length

at line 151
public string getNativeIdMethod()

Returns the native IdMethod (sequence|identity)

Return Value

string The native IdMethod (PropelPlatformInterface:IDENTITY, PropelPlatformInterface::SEQUENCE).

at line 156
public isNativeIdMethodAutoIncrement()

at line 168
public Domain getDomainForType(string $propelType)

Returns the db specific domain for a propelType.

Parameters

string $propelType the Propel type name.

Return Value

Domain The db specific domain.

Exceptions

EngineException

at line 181
public string getNullString($notNull)

Parameters

$notNull

Return Value

string The RDBMS-specific SQL fragment for <code>NULL</code> or <code>NOT NULL</code>.

at line 189
public The getAutoIncrement()

Return Value

The RDBMS-specific SQL fragment for autoincrement.

at line 204
public string getSequenceName(Table $table)

Gets the name to use for creating a sequence for a table.

This will create a new name or use one specified in an id-method-parameter
tag, if specified.

Parameters

Table $table

Return Value

string Sequence name for this table.

at line 234
public string getAddTablesDDL(Database $database)

Builds the DDL SQL to add the tables of a database together with index and foreign keys

Parameters

Database $database

Return Value

string

at line 254
public string getBeginDDL()

Gets the requests to execute at the beginning of a DDL file

Return Value

string

at line 263
public string getEndDDL()

Gets the requests to execute at the end of a DDL file

Return Value

string

at line 271
public string getDropTableDDL(Table $table)

Builds the DDL SQL to drop a table

Parameters

Table $table

Return Value

string

at line 284
public string getAddTableDDL(Table $table)

Builds the DDL SQL to add a table without index and foreign keys

Parameters

Table $table

Return Value

string

at line 323
public string getColumnDDL(Column $col)

Builds the DDL SQL for a Column object.

Parameters

Column $col

Return Value

string

at line 354
public string getColumnDefaultValueDDL(Column $col)

Returns the SQL for the default value of a Column object

Parameters

Column $col

Return Value

string

at line 398
public string getColumnListDDL($columns, $delimiter = ',')

Creates a delimiter-delimited string list of column names, quoted using quoteIdentifier().

Parameters

$columns
$delimiter

Return Value

string

at line 415
public string getPrimaryKeyName(Table $table)

Returns the name of a table primary key

Parameters

Table $table

Return Value

string

at line 426
public string getPrimaryKeyDDL(Table $table)

Returns the SQL for the primary key of a Table object

Parameters

Table $table

Return Value

string

at line 439
public string getDropPrimaryKeyDDL(Table $table)

Builds the DDL SQL to drop the primary key of a table.

Parameters

Table $table

Return Value

string

at line 457
public string getAddPrimaryKeyDDL(Table $table)

Builds the DDL SQL to add the primary key of a table.

Parameters

Table $table

Return Value

string

at line 475
public string getAddIndicesDDL(Table $table)

Builds the DDL SQL to add the indices of a table.

Parameters

Table $table

Return Value

string

at line 491
public string getAddIndexDDL(Index $index)

Builds the DDL SQL to add an Index.

Parameters

Index $index

Return Value

string

at line 511
public string getDropIndexDDL(Index $index)

Builds the DDL SQL to drop an Index.

Parameters

Index $index

Return Value

string

at line 528
public string getIndexDDL(Index $index)

Builds the DDL SQL for an Index object.

Parameters

Index $index

Return Value

string

at line 543
public string getUniqueDDL(Unique $unique)

Builds the DDL SQL for a Unique constraint object.

Parameters

Unique $unique

Return Value

string

at line 554
public string getAddForeignKeysDDL(Table $table)

Builds the DDL SQL to add the foreign keys of a table.

Parameters

Table $table

Return Value

string

at line 570
public string getAddForeignKeyDDL(ForeignKey $fk)

Builds the DDL SQL to add a foreign key.

Parameters

ForeignKey $fk

Return Value

string

at line 591
public string getDropForeignKeyDDL(ForeignKey $fk)

Builds the DDL SQL to drop a foreign key.

Parameters

ForeignKey $fk

Return Value

string

at line 610
public string getForeignKeyDDL(ForeignKey $fk)

Builds the DDL SQL for a ForeignKey object.

Parameters

ForeignKey $fk

Return Value

string

at line 636
public getCommentLineDDL($comment)

Parameters

$comment

at line 644
public getCommentBlockDDL($comment)

Parameters

$comment

at line 661
public string getModifyDatabaseDDL(PropelDatabaseDiff $databaseDiff)

Builds the DDL SQL to modify a database based on a PropelDatabaseDiff instance

Parameters

PropelDatabaseDiff $databaseDiff

Return Value

string

at line 695
public string getRenameTableDDL($fromTableName, $toTableName)

Builds the DDL SQL to rename a table

Parameters

$fromTableName
$toTableName

Return Value

string

at line 713
public string getModifyTableDDL(PropelTableDiff $tableDiff)

Builds the DDL SQL to alter a table based on a PropelTableDiff instance

Parameters

PropelTableDiff $tableDiff

Return Value

string

at line 778
public string getModifyTableColumnsDDL(PropelTableDiff $tableDiff)

Builds the DDL SQL to alter a table based on a PropelTableDiff instance

Parameters

PropelTableDiff $tableDiff

Return Value

string

at line 807
public string getModifyTablePrimaryKeyDDL(PropelTableDiff $tableDiff)

Builds the DDL SQL to alter a table's primary key based on a PropelTableDiff instance

Parameters

PropelTableDiff $tableDiff

Return Value

string

at line 825
public string getModifyTableIndicesDDL(PropelTableDiff $tableDiff)

Builds the DDL SQL to alter a table's indices based on a PropelTableDiff instance

Parameters

PropelTableDiff $tableDiff

Return Value

string

at line 852
public string getModifyTableForeignKeysDDL(PropelTableDiff $tableDiff)

Builds the DDL SQL to alter a table's foreign keys based on a PropelTableDiff instance

Parameters

PropelTableDiff $tableDiff

Return Value

string

at line 878
public string getRemoveColumnDDL(Column $column)

Builds the DDL SQL to remove a column

Parameters

Column $column

Return Value

string

at line 894
public string getRenameColumnDDL($fromColumn, $toColumn)

Builds the DDL SQL to rename a column

Parameters

$fromColumn
$toColumn

Return Value

string

at line 912
public string getModifyColumnDDL(PropelColumnDiff $columnDiff)

Builds the DDL SQL to modify a column

Parameters

PropelColumnDiff $columnDiff

Return Value

string

at line 930
public string getModifyColumnsDDL($columnDiffs)

Builds the DDL SQL to modify a list of columns

Parameters

$columnDiffs

Return Value

string

at line 963
public string getAddColumnDDL(Column $column)

Builds the DDL SQL to remove a column

Parameters

Column $column

Return Value

string

at line 980
public string getAddColumnsDDL($columns)

Builds the DDL SQL to remove a list of columns

Parameters

$columns

Return Value

string

at line 1013
public boolean hasSize(string $sqlType)

Returns if the RDBMS-specific SQL type has a size attribute.

Parameters

string $sqlType the SQL type

Return Value

boolean True if the type has a size attribute

at line 1024
public boolean hasScale(string $sqlType)

Returns if the RDBMS-specific SQL type has a scale attribute.

Parameters

string $sqlType the SQL type

Return Value

boolean True if the type has a scale attribute

at line 1034
public string quote(string $text)

Quote and escape needed characters in the string for unerlying RDBMS.

Parameters

string $text

Return Value

string

at line 1062
public string quoteIdentifier(string $text)

Quotes identifiers used in database SQL.

Parameters

string $text

Return Value

string Quoted identifier.

at line 1067
public setIdentifierQuoting($enabled = true)

Parameters

$enabled

at line 1072
public getIdentifierQuoting()

at line 1081
public boolean supportsNativeDeleteTrigger()

Whether RDBMS supports native ON DELETE triggers (e.g.

ON DELETE CASCADE).

Return Value

boolean

at line 1090
public boolean supportsInsertNullPk()

Whether RDBMS supports INSERT null values in autoincremented primary keys

Return Value

boolean

at line 1099
public boolean hasStreamBlobImpl()

Whether the underlying PDO driver for this platform returns BLOB columns as streams (instead of strings).

Return Value

boolean

at line 1107
public supportsSchemas()

See also

Platform::supportsSchemas()

at line 1115
public supportsMigrations()

See also

Platform::supportsMigrations()

at line 1121
public supportsVarcharWithoutSize()

at line 1137
public mixed getBooleanString($b)

Returns the boolean value for the RDBMS.

This value should match the boolean value that is set
when using Propel's PreparedStatement::setBoolean().

This function is used to set default column values when building
SQL.

Parameters

$b

Return Value

mixed

at line 1144
public getPhpArrayString($stringValue)

Parameters

$stringValue

at line 1169
public string getTimestampFormatter()

Gets the preferred timestamp formatter for setting date/time values.

Return Value

string

at line 1178
public string getTimeFormatter()

Gets the preferred time formatter for setting date/time values.

Return Value

string

at line 1187
public string getDateFormatter()

Gets the preferred date formatter for setting date/time values.

Return Value

string

at line 1197
public getColumnBindingPHP($column, $identifier, $columnValueAccessor, $tab = ' ')

Get the PHP snippet for binding a value to a column.

Warning: duplicates logic from DBAdapter::bindValue().
Any code modification here must be ported there.

Parameters

$column
$identifier
$columnValueAccessor
$tab

at line 1233
public getIdentifierPhp($columnValueMutator, $connectionVariableName = '$con', $sequenceName = '', $tab = ' ')

Get the PHP snippet for getting a Pk from the database.

Warning: duplicates logic from DBAdapter::getId().
Any code modification here must be ported there.

Typical output:
<code>
$this->id = $con->lastInsertId();
</code>

Parameters

$columnValueMutator
$connectionVariableName
$sequenceName
$tab