Propel API
Class

OraclePlatform

class OraclePlatform extends DefaultPlatform

Oracle 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(GeneratorConfig $config)

Sets the GeneratorConfig to use in the parsing.

from DefaultPlatform
string getDatabaseType()

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

from DefaultPlatform
getMaxColumnNameLength()

getNativeIdMethod()

isNativeIdMethodAutoIncrement()

from DefaultPlatform
Domain getDomainForType(string $propelType)

Returns the db specific domain for a propelType.

from DefaultPlatform
string getNullString($notNull)

from DefaultPlatform
getAutoIncrement()

string getSequenceName(Table $table)

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

from DefaultPlatform
getAddTablesDDL(Database $database)

getBeginDDL()

string getEndDDL()

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

from DefaultPlatform
getDropTableDDL(Table $table)

getAddTableDDL(Table $table)

string getColumnDDL(Column $col)

Builds the DDL SQL for a Column object.

from DefaultPlatform
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
getPrimaryKeyName(Table $table)

getPrimaryKeyDDL(Table $table)

string getDropPrimaryKeyDDL(Table $table)

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

from DefaultPlatform
getAddPrimaryKeyDDL(Table $table)

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.

from DefaultPlatform
string getIndexDDL(Index $index)

Builds the DDL SQL for an Index object.

from DefaultPlatform
getUniqueDDL(Unique $unique)

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.

from DefaultPlatform
string getDropForeignKeyDDL(ForeignKey $fk)

Builds the DDL SQL to drop a foreign key.

from DefaultPlatform
getForeignKeyDDL(ForeignKey $fk)

getCommentLineDDL($comment)

from DefaultPlatform
getCommentBlockDDL($comment)

from DefaultPlatform
string getModifyDatabaseDDL(PropelDatabaseDiff $databaseDiff)

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

from DefaultPlatform
string getRenameTableDDL($fromTableName, $toTableName)

Builds the DDL SQL to rename a table

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

from DefaultPlatform
string getRenameColumnDDL($fromColumn, $toColumn)

Builds the DDL SQL to rename a column

from DefaultPlatform
string getModifyColumnDDL(PropelColumnDiff $columnDiff)

Builds the DDL SQL to modify a column

from DefaultPlatform
string getModifyColumnsDDL($columnDiffs)

Builds the DDL SQL to modify a list of columns

from DefaultPlatform
string getAddColumnDDL(Column $column)

Builds the DDL SQL to remove a column

from DefaultPlatform
string getAddColumnsDDL($columns)

Builds the DDL SQL to remove a list of columns

from DefaultPlatform
boolean hasSize(string $sqlType)

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

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

from DefaultPlatform
quoteIdentifier($text)

setIdentifierQuoting($enabled = true)

from DefaultPlatform
getIdentifierQuoting()

from DefaultPlatform
supportsNativeDeleteTrigger()

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).

supportsSchemas()

supportsMigrations()

from DefaultPlatform
supportsVarcharWithoutSize()

from DefaultPlatform
mixed getBooleanString($b)

Returns the boolean value for the RDBMS.

from DefaultPlatform
getTimestampFormatter()

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.

getAddSequencesDDL(Table $table)

string generateBlockStorage(Table|Index $object, bool $isPrimaryKey = false)

Generate oracle block storage

Details

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

Default constructor.

Parameters

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

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

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

in DefaultPlatform at line 77
public setGeneratorConfig(GeneratorConfig $config)

Sets the GeneratorConfig to use in the parsing.

Parameters

GeneratorConfig $config

in DefaultPlatform at line 127
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 56
public getMaxColumnNameLength()

at line 61
public getNativeIdMethod()

in DefaultPlatform at line 154
public isNativeIdMethodAutoIncrement()

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

in DefaultPlatform at line 177
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 66
public getAutoIncrement()

in DefaultPlatform at line 200
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 84
public getAddTablesDDL(Database $database)

Parameters

Database $database

at line 76
public getBeginDDL()

in DefaultPlatform at line 258
public string getEndDDL()

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

Return Value

string

at line 160
public getDropTableDDL(Table $table)

Parameters

Table $table

at line 104
public getAddTableDDL(Table $table)

Parameters

Table $table

in DefaultPlatform at line 317
public string getColumnDDL(Column $col)

Builds the DDL SQL for a Column object.

Parameters

Column $col

Return Value

string

in DefaultPlatform at line 345
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 381
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 173
public getPrimaryKeyName(Table $table)

Parameters

Table $table

at line 181
public getPrimaryKeyDDL(Table $table)

Parameters

Table $table

in DefaultPlatform at line 420
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 140
public getAddPrimaryKeyDDL(Table $table)

Parameters

Table $table

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

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

Parameters

Table $table

Return Value

string

at line 317
public string getAddIndexDDL(Index $index)

Builds the DDL SQL to add an Index.

Parameters

Index $index

Return Value

string

in DefaultPlatform at line 488
public string getDropIndexDDL(Index $index)

Builds the DDL SQL to drop an Index.

Parameters

Index $index

Return Value

string

in DefaultPlatform at line 504
public string getIndexDDL(Index $index)

Builds the DDL SQL for an Index object.

Parameters

Index $index

Return Value

string

at line 193
public getUniqueDDL(Unique $unique)

Parameters

Unique $unique

in DefaultPlatform at line 530
public string getAddForeignKeysDDL(Table $table)

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

Parameters

Table $table

Return Value

string

in DefaultPlatform at line 545
public string getAddForeignKeyDDL(ForeignKey $fk)

Builds the DDL SQL to add a foreign key.

Parameters

ForeignKey $fk

Return Value

string

in DefaultPlatform at line 565
public string getDropForeignKeyDDL(ForeignKey $fk)

Builds the DDL SQL to drop a foreign key.

Parameters

ForeignKey $fk

Return Value

string

at line 201
public getForeignKeyDDL(ForeignKey $fk)

Parameters

ForeignKey $fk

in DefaultPlatform at line 609
public getCommentLineDDL($comment)

Parameters

$comment

in DefaultPlatform at line 616
public getCommentBlockDDL($comment)

Parameters

$comment

in DefaultPlatform at line 632
public string getModifyDatabaseDDL(PropelDatabaseDiff $databaseDiff)

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

Parameters

PropelDatabaseDiff $databaseDiff

Return Value

string

in DefaultPlatform at line 666
public string getRenameTableDDL($fromTableName, $toTableName)

Builds the DDL SQL to rename a table

Parameters

$fromTableName
$toTableName

Return Value

string

in DefaultPlatform at line 683
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 748
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 777
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 795
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 822
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

in DefaultPlatform at line 848
public string getRemoveColumnDDL(Column $column)

Builds the DDL SQL to remove a column

Parameters

Column $column

Return Value

string

in DefaultPlatform at line 863
public string getRenameColumnDDL($fromColumn, $toColumn)

Builds the DDL SQL to rename a column

Parameters

$fromColumn
$toColumn

Return Value

string

in DefaultPlatform at line 880
public string getModifyColumnDDL(PropelColumnDiff $columnDiff)

Builds the DDL SQL to modify a column

Parameters

PropelColumnDiff $columnDiff

Return Value

string

in DefaultPlatform at line 897
public string getModifyColumnsDDL($columnDiffs)

Builds the DDL SQL to modify a list of columns

Parameters

$columnDiffs

Return Value

string

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

Builds the DDL SQL to remove a column

Parameters

Column $column

Return Value

string

in DefaultPlatform at line 945
public string getAddColumnsDDL($columns)

Builds the DDL SQL to remove a list of columns

Parameters

$columns

Return Value

string

in DefaultPlatform at line 977
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 988
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 998
public string quote(string $text)

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

Parameters

string $text

Return Value

string

at line 232
public quoteIdentifier($text)

Parameters

$text

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

Parameters

$enabled

in DefaultPlatform at line 1036
public getIdentifierQuoting()

at line 71
public supportsNativeDeleteTrigger()

in DefaultPlatform at line 1054
public boolean supportsInsertNullPk()

Whether RDBMS supports INSERT null values in autoincremented primary keys

Return Value

boolean

at line 227
public boolean hasStreamBlobImpl()

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

Return Value

boolean

at line 248
public supportsSchemas()

See also

Platform::supportsSchemas()

in DefaultPlatform at line 1079
public supportsMigrations()

See also

Platform::supportsMigrations()

in DefaultPlatform at line 1085
public supportsVarcharWithoutSize()

in DefaultPlatform at line 1101
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 237
public getTimestampFormatter()

in DefaultPlatform at line 1120
public string getTimeFormatter()

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

Return Value

string

in DefaultPlatform at line 1129
public string getDateFormatter()

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

Return Value

string

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

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

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

Parameters

$column
$identifier
$columnValueAccessor
$tab

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

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

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

Parameters

$columnValueMutator
$connectionVariableName
$sequenceName
$tab

at line 147
public getAddSequencesDDL(Table $table)

Parameters

Table $table

at line 261
public string generateBlockStorage(Table|Index $object, bool $isPrimaryKey = false)

Generate oracle block storage

Parameters

Table|Index $object object with vendor parameters
bool $isPrimaryKey is a primary key vendor part

Return Value

string oracle vendor sql part