Class

MysqlPlatform

class MysqlPlatform extends DefaultPlatform

MySql PropelPlatformInterface implementation.

Methods

__construct(PDO $con = null)

Default constructor.

from DefaultPlatform
setConnection(PDO $con = null)

Set the database connection to use for this Platform class.

from DefaultPlatform
PDO getConnection()

Returns the database connection to use for this Platform class.

from DefaultPlatform
setGeneratorConfig(GeneratorConfigInterface $generatorConfig)

Sets the GeneratorConfig to use in the parsing.

string getDatabaseType()

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

from DefaultPlatform
int getMaxColumnNameLength()

Returns the max column length supported by the db.

string getNativeIdMethod()

Returns the native IdMethod (sequence|identity)

from DefaultPlatform
isNativeIdMethodAutoIncrement()

from DefaultPlatform
Domain getDomainForType(string $propelType)

Returns the db specific domain for a propelType.

from DefaultPlatform
string getNullString($notNull)

from DefaultPlatform
The getAutoIncrement()

string getSequenceName(Table $table)

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

from DefaultPlatform
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

from DefaultPlatform
string getColumnListDDL($columns, $delimiter = ',')

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

from DefaultPlatform
string getPrimaryKeyName(Table $table)

Returns the name of a table primary key

from DefaultPlatform
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.

from DefaultPlatform
string getAddIndicesDDL(Table $table)

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

from DefaultPlatform
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.

from DefaultPlatform
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)

from DefaultPlatform
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

from DefaultPlatform
string getModifyTableColumnsDDL(PropelTableDiff $tableDiff)

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

from DefaultPlatform
string getModifyTablePrimaryKeyDDL(PropelTableDiff $tableDiff)

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

from DefaultPlatform
string getModifyTableIndicesDDL(PropelTableDiff $tableDiff)

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

from DefaultPlatform
string getModifyTableForeignKeysDDL(PropelTableDiff $tableDiff)

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

from DefaultPlatform
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

from DefaultPlatform
string getAddColumnsDDL($columns)

Builds the DDL SQL to add 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.

from DefaultPlatform
string quote(string $text)

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

from DefaultPlatform
string quoteIdentifier(string $text)

MySQL documentation says that identifiers cannot contain '.'.

setIdentifierQuoting($enabled = true)

from DefaultPlatform
getIdentifierQuoting()

from DefaultPlatform
boolean supportsNativeDeleteTrigger()

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

boolean supportsInsertNullPk()

Whether RDBMS supports INSERT null values in autoincremented primary keys

from DefaultPlatform
boolean hasStreamBlobImpl()

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

from DefaultPlatform
boolean supportsSchemas()

boolean supportsMigrations()

from DefaultPlatform
boolean supportsVarcharWithoutSize()

Wether RDBMS supports VARCHAR without explicit size

from DefaultPlatform
mixed getBooleanString($b)

Returns the boolean value for the RDBMS.

from DefaultPlatform
getPhpArrayString($stringValue)

from DefaultPlatform
string getTimestampFormatter()

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

string getTimeFormatter()

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

from DefaultPlatform
string getDateFormatter()

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

from DefaultPlatform
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.

from DefaultPlatform
getDefaultFKOnDeleteBehavior()

getDefaultFKOnUpdateBehavior()

setTableEngineKeyword(string $tableEngineKeyword)

Setter for the tableEngineKeyword property

string getTableEngineKeyword()

Getter for the tableEngineKeyword property

setDefaultTableEngine(string $defaultTableEngine)

Setter for the defaultTableEngine property

string getDefaultTableEngine()

Getter for the defaultTableEngine property

supportsForeignKeys(Table $table)

string getChangeColumnDDL($fromColumn, $toColumn)

Builds the DDL SQL to change a column

getAddColumnDDLBits(Column $column)

string disconnectedEscapeText(string $text)

Escape the string for RDBMS.

Details

in DefaultPlatform at line 49
public __construct(PDO $con = null)

Default constructor.

Parameters

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

in DefaultPlatform at line 62
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.

in DefaultPlatform at line 72
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 53
public setGeneratorConfig(GeneratorConfigInterface $generatorConfig)

Sets the GeneratorConfig to use in the parsing.

Parameters

GeneratorConfigInterface $generatorConfig

in DefaultPlatform at line 136
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 108
public int getMaxColumnNameLength()

Returns the max column length supported by the db.

Return Value

int The max column length

in DefaultPlatform at line 159
public string getNativeIdMethod()

Returns the native IdMethod (sequence|identity)

Return Value

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

in DefaultPlatform at line 164
public isNativeIdMethodAutoIncrement()

in DefaultPlatform at line 177
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

in DefaultPlatform at line 190
public string getNullString($notNull)

Parameters

$notNull

Return Value

string The RDBMS-specific SQL fragment for NULL or NOT NULL.

at line 103
public The getAutoIncrement()

Return Value

The RDBMS-specific SQL fragment for autoincrement.

in DefaultPlatform at line 213
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 132
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 145
public string getBeginDDL()

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

Return Value

string

at line 154
public string getEndDDL()

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

Return Value

string

at line 301
public string getDropTableDDL(Table $table)

Builds the DDL SQL to drop a table

Parameters

Table $table

Return Value

string

at line 189
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 308
public string getColumnDDL(Column $col)

Builds the DDL SQL for a Column object.

Parameters

Column $col

Return Value

string

in DefaultPlatform at line 362
public string getColumnDefaultValueDDL(Column $col)

Returns the SQL for the default value of a Column object

Parameters

Column $col

Return Value

string

in DefaultPlatform at line 408
public string getColumnListDDL($columns, $delimiter = ',')

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

Parameters

$columns
$delimiter

Return Value

string

in DefaultPlatform at line 426
public string getPrimaryKeyName(Table $table)

Returns the name of a table primary key

Parameters

Table $table

Return Value

string

at line 167
public string getPrimaryKeyDDL(Table $table)

Returns the SQL for the primary key of a Table object

Parameters

Table $table

Return Value

string

at line 405
public string getDropPrimaryKeyDDL(Table $table)

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

Parameters

Table $table

Return Value

string

in DefaultPlatform at line 471
public string getAddPrimaryKeyDDL(Table $table)

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

Parameters

Table $table

Return Value

string

in DefaultPlatform at line 490
public string getAddIndicesDDL(Table $table)

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

Parameters

Table $table

Return Value

string

at line 423
public string getAddIndexDDL(Index $index)

Builds the DDL SQL to add an Index.

Parameters

Index $index

Return Value

string

at line 444
public string getDropIndexDDL(Index $index)

Builds the DDL SQL to drop an Index.

Parameters

Index $index

Return Value

string

at line 461
public string getIndexDDL(Index $index)

Builds the DDL SQL for an Index object.

Parameters

Index $index

Return Value

string

at line 483
public string getUniqueDDL(Unique $unique)

Builds the DDL SQL for a Unique constraint object.

Parameters

Unique $unique

Return Value

string

in DefaultPlatform at line 568
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 491
public string getAddForeignKeyDDL(ForeignKey $fk)

Builds the DDL SQL to add a foreign key.

Parameters

ForeignKey $fk

Return Value

string

at line 514
public string getDropForeignKeyDDL(ForeignKey $fk)

Builds the DDL SQL to drop a foreign key.

Parameters

ForeignKey $fk

Return Value

string

at line 505
public string getForeignKeyDDL(ForeignKey $fk)

Builds the DDL SQL for a ForeignKey object.

Parameters

ForeignKey $fk

Return Value

string

in DefaultPlatform at line 653
public getCommentLineDDL($comment)

Parameters

$comment

at line 529
public getCommentBlockDDL($comment)

Parameters

$comment

at line 546
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 576
public string getRenameTableDDL($fromTableName, $toTableName)

Builds the DDL SQL to rename a table

Parameters

$fromTableName
$toTableName

Return Value

string

in DefaultPlatform at line 731
public string getModifyTableDDL(PropelTableDiff $tableDiff)

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

Parameters

PropelTableDiff $tableDiff

Return Value

string

in DefaultPlatform at line 796
public string getModifyTableColumnsDDL(PropelTableDiff $tableDiff)

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

Parameters

PropelTableDiff $tableDiff

Return Value

string

in DefaultPlatform at line 825
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

in DefaultPlatform at line 843
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

in DefaultPlatform at line 870
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 593
public string getRemoveColumnDDL(Column $column)

Builds the DDL SQL to remove a column

Parameters

Column $column

Return Value

string

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

Builds the DDL SQL to rename a column

Parameters

$fromColumn
$toColumn

Return Value

string

at line 620
public string getModifyColumnDDL(PropelColumnDiff $columnDiff)

Builds the DDL SQL to modify a column

Parameters

PropelColumnDiff $columnDiff

Return Value

string

at line 648
public string getModifyColumnsDDL($columnDiffs)

Builds the DDL SQL to modify a list of columns

Parameters

$columnDiffs

Return Value

string

in DefaultPlatform at line 982
public string getAddColumnDDL(Column $column)

Builds the DDL SQL to remove a column

Parameters

Column $column

Return Value

string

at line 688
public string getAddColumnsDDL($columns)

Builds the DDL SQL to add a list of columns

Parameters

$columns

Return Value

string

at line 721
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

in DefaultPlatform at line 1042
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

in DefaultPlatform at line 1054
public string quote(string $text)

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

Parameters

string $text

Return Value

string

at line 752
public string quoteIdentifier(string $text)

MySQL documentation says that identifiers cannot contain '.'.

Thus it should be safe to split the string by '.' and quote each part individually to allow for a .

or
. syntax.

Parameters

string $text the identifier

Return Value

string the quoted identifier

in DefaultPlatform at line 1090
public setIdentifierQuoting($enabled = true)

Parameters

$enabled

in DefaultPlatform at line 1095
public getIdentifierQuoting()

at line 113
public boolean supportsNativeDeleteTrigger()

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

ON DELETE CASCADE).

Return Value

boolean

in DefaultPlatform at line 1115
public boolean supportsInsertNullPk()

Whether RDBMS supports INSERT null values in autoincremented primary keys

Return Value

boolean

in DefaultPlatform at line 1125
public boolean hasStreamBlobImpl()

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

Return Value

boolean

at line 716
public boolean supportsSchemas()

Return Value

boolean

See also

Platform::supportsSchemas()

in DefaultPlatform at line 1141
public boolean supportsMigrations()

Return Value

boolean

See also

Platform::supportsMigrations()

in DefaultPlatform at line 1147
public boolean supportsVarcharWithoutSize()

Wether RDBMS supports VARCHAR without explicit size

Return Value

boolean

in DefaultPlatform at line 1165
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

in DefaultPlatform at line 1172
public getPhpArrayString($stringValue)

Parameters

$stringValue

at line 757
public string getTimestampFormatter()

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

Return Value

string

in DefaultPlatform at line 1208
public string getTimeFormatter()

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

Return Value

string

in DefaultPlatform at line 1218
public string getDateFormatter()

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

Return Value

string

at line 762
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

in DefaultPlatform at line 1264
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: $this->id = $con->lastInsertId();

Parameters

$columnValueMutator
$connectionVariableName
$sequenceName
$tab

at line 779
public getDefaultFKOnDeleteBehavior()

at line 784
public getDefaultFKOnUpdateBehavior()

at line 68
public setTableEngineKeyword(string $tableEngineKeyword)

Setter for the tableEngineKeyword property

Parameters

string $tableEngineKeyword

at line 78
public string getTableEngineKeyword()

Getter for the tableEngineKeyword property

Return Value

string

at line 88
public setDefaultTableEngine(string $defaultTableEngine)

Setter for the defaultTableEngine property

Parameters

string $defaultTableEngine

at line 98
public string getDefaultTableEngine()

Getter for the defaultTableEngine property

Return Value

string

at line 118
public supportsForeignKeys(Table $table)

Parameters

Table $table

at line 630
public string getChangeColumnDDL($fromColumn, $toColumn)

Builds the DDL SQL to change a column

Parameters

$fromColumn
$toColumn

Return Value

string

at line 658
public getAddColumnDDLBits(Column $column)

Parameters

Column $column

at line 733
public string disconnectedEscapeText(string $text)

Escape the string for RDBMS.

Parameters

string $text

Return Value

string