PHP Class RainLab\Builder\Classes\TableMigrationCodeGenerator

Author: Alexey Bobkov, Samuel Georges
Inheritance: extends RainLab\Builder\Classes\BaseModel
显示文件 Open project: rainlab/builder-plugin Class Usage Examples

Protected Properties

Property Type Description
$eol
$indent

Public Methods

Method Description
createOrUpdateTable ( Doctrine\DBAL\Schema\Table $updatedTable, Doctrine\DBAL\Schema\Table $existingTable, string $newTableName ) : string | boolean Generates code for creating or updating a database table.
dropTable ( Doctrine\DBAL\Schema\Table $existingTable ) : string Generates code for dropping a database table.
wrapMigrationCode ( string $scriptFilename, string $code, RainLab\Builder\Classes\PluginCode $pluginCodeObj ) : October\Rain\Parse\Bracket Wrap migration's up() and down() functions into a complete migration class declaration

Protected Methods

Method Description
applyMethodIncrements ( $method, $column )
findPrimaryKeyIndex ( $indexes, $table )
formatLengthParameters ( $column, $method )
generateBooleanMethod ( $methodName, $value )
generateBooleanString ( $value )
generateColumnCode ( $columnData, $mode )
generateColumnDrop ( $column )
generateColumnMethodCall ( $column )
generateColumnRemoveCode ( $name )
generateColumnRenameCode ( $fromName, $toName )
generateCreateOrUpdateCode ( $tableDiff, $isNewTable, $newOrUpdatedTable )
generateCreateOrUpdateDownCode ( $tableDiff, $isNewTable, $newOrUpdatedTable )
generateCreateOrUpdateUpCode ( $tableDiff, $isNewTable, $newOrUpdatedTable )
generateDefault ( $column, $changeMode, $columnData, $forceFlagsChange )
generateDefaultMethodCall ( $default, $column )
generateDropDownCode ( $table )
generateDropUpCode ( $table )
generateIndexDrop ( $index )
generateMigrationCode ( $upCode, $downCode )
generateNullable ( $column, $changeMode, $columnData, $forceFlagsChange )
generatePrimaryKeyCode ( $index )
generatePrimaryKeyDrop ( $table )
generateSchemaTableMethodEnd ( )
generateSchemaTableMethodStart ( $tableName, $isNewTable )
generateTableDropCode ( $name )
generateTableRenameCode ( $fromName, $toName )
generateUnsigned ( $column, $changeMode, $columnData, $forceFlagsChange )
getChangedOrRemovedPrimaryKey ( $tableDiff )
implodeColumnList ( $columnNames )
indent ( $str )
indexHasAutoincrementColumns ( $index, $table )
makeTabs ( $str )
quoteParameter ( $str )
tableHasNameOrColumnChanges ( $tableDiff, $columnChangesOnly = false )
tableHasPrimaryKeyChanges ( $tableDiff )

Method Details

applyMethodIncrements() protected method

protected applyMethodIncrements ( $method, $column )

createOrUpdateTable() public method

Generates code for creating or updating a database table.
public createOrUpdateTable ( Doctrine\DBAL\Schema\Table $updatedTable, Doctrine\DBAL\Schema\Table $existingTable, string $newTableName ) : string | boolean
$updatedTable Doctrine\DBAL\Schema\Table Specifies the updated table schema.
$existingTable Doctrine\DBAL\Schema\Table Specifies the existing table schema, if applicable.
$newTableName string An updated name of the theme.
return string | boolean Returns the migration up() and down() methods code. Returns false if there the table was not changed.

dropTable() public method

Generates code for dropping a database table.
public dropTable ( Doctrine\DBAL\Schema\Table $existingTable ) : string
$existingTable Doctrine\DBAL\Schema\Table Specifies the existing table schema.
return string Returns the migration up() and down() methods code.

findPrimaryKeyIndex() protected method

protected findPrimaryKeyIndex ( $indexes, $table )

formatLengthParameters() protected method

protected formatLengthParameters ( $column, $method )

generateBooleanMethod() protected method

protected generateBooleanMethod ( $methodName, $value )

generateBooleanString() protected method

protected generateBooleanString ( $value )

generateColumnCode() protected method

protected generateColumnCode ( $columnData, $mode )

generateColumnDrop() protected method

protected generateColumnDrop ( $column )

generateColumnMethodCall() protected method

protected generateColumnMethodCall ( $column )

generateColumnRemoveCode() protected method

protected generateColumnRemoveCode ( $name )

generateColumnRenameCode() protected method

protected generateColumnRenameCode ( $fromName, $toName )

generateCreateOrUpdateCode() protected method

protected generateCreateOrUpdateCode ( $tableDiff, $isNewTable, $newOrUpdatedTable )

generateCreateOrUpdateDownCode() protected method

protected generateCreateOrUpdateDownCode ( $tableDiff, $isNewTable, $newOrUpdatedTable )

generateCreateOrUpdateUpCode() protected method

protected generateCreateOrUpdateUpCode ( $tableDiff, $isNewTable, $newOrUpdatedTable )

generateDefault() protected method

protected generateDefault ( $column, $changeMode, $columnData, $forceFlagsChange )

generateDefaultMethodCall() protected method

protected generateDefaultMethodCall ( $default, $column )

generateDropDownCode() protected method

protected generateDropDownCode ( $table )

generateDropUpCode() protected method

protected generateDropUpCode ( $table )

generateIndexDrop() protected method

protected generateIndexDrop ( $index )

generateMigrationCode() protected method

protected generateMigrationCode ( $upCode, $downCode )

generateNullable() protected method

protected generateNullable ( $column, $changeMode, $columnData, $forceFlagsChange )

generatePrimaryKeyCode() protected method

protected generatePrimaryKeyCode ( $index )

generatePrimaryKeyDrop() protected method

protected generatePrimaryKeyDrop ( $table )

generateSchemaTableMethodEnd() protected method

generateSchemaTableMethodStart() protected method

protected generateSchemaTableMethodStart ( $tableName, $isNewTable )

generateTableDropCode() protected method

protected generateTableDropCode ( $name )

generateTableRenameCode() protected method

protected generateTableRenameCode ( $fromName, $toName )

generateUnsigned() protected method

protected generateUnsigned ( $column, $changeMode, $columnData, $forceFlagsChange )

getChangedOrRemovedPrimaryKey() protected method

protected getChangedOrRemovedPrimaryKey ( $tableDiff )

implodeColumnList() protected method

protected implodeColumnList ( $columnNames )

indent() protected method

protected indent ( $str )

indexHasAutoincrementColumns() protected method

protected indexHasAutoincrementColumns ( $index, $table )

makeTabs() protected method

protected makeTabs ( $str )

quoteParameter() protected method

protected quoteParameter ( $str )

tableHasNameOrColumnChanges() protected method

protected tableHasNameOrColumnChanges ( $tableDiff, $columnChangesOnly = false )

tableHasPrimaryKeyChanges() protected method

protected tableHasPrimaryKeyChanges ( $tableDiff )

wrapMigrationCode() public method

Wrap migration's up() and down() functions into a complete migration class declaration
public wrapMigrationCode ( string $scriptFilename, string $code, RainLab\Builder\Classes\PluginCode $pluginCodeObj ) : October\Rain\Parse\Bracket
$scriptFilename string Specifies the migration script file name
$code string Specifies the migration code
$pluginCodeObj RainLab\Builder\Classes\PluginCode The plugin code object
return October\Rain\Parse\Bracket

Property Details

$eol protected_oe property

protected $eol

$indent protected_oe property

protected $indent