TableDiff
in package
Table Diff.
Tags
Table of Contents
- $addedColumns : array<string|int, Column>
- All added fields.
- $addedForeignKeys : array<string|int, ForeignKeyConstraint>
- All added foreign key definitions
- $addedIndexes : array<string|int, Index>
- All added indexes.
- $changedColumns : array<string|int, ColumnDiff>
- All changed fields.
- $changedForeignKeys : array<string|int, ForeignKeyConstraint>
- All changed foreign keys
- $changedIndexes : array<string|int, Index>
- All changed indexes.
- $fromTable : Table
- $name : string
- $newName : string|bool
- $removedColumns : array<string|int, Column>
- All removed fields.
- $removedForeignKeys : array<string|int, ForeignKeyConstraint>
- All removed foreign keys
- $removedIndexes : array<string|int, Index>
- All removed indexes
- $renamedColumns : array<string|int, Column>
- Columns that are only renamed from key to column instance name.
- $renamedIndexes : array<string|int, Index>
- Indexes that are only renamed but are identical otherwise.
- __construct() : mixed
- Constructs an TableDiff object.
- getName() : Identifier
- getNewName() : Identifier|bool
Properties
$addedColumns
All added fields.
public
array<string|int, Column>
$addedColumns
$addedForeignKeys
All added foreign key definitions
public
array<string|int, ForeignKeyConstraint>
$addedForeignKeys
= array()
$addedIndexes
All added indexes.
public
array<string|int, Index>
$addedIndexes
= array()
$changedColumns
All changed fields.
public
array<string|int, ColumnDiff>
$changedColumns
= array()
$changedForeignKeys
All changed foreign keys
public
array<string|int, ForeignKeyConstraint>
$changedForeignKeys
= array()
$changedIndexes
All changed indexes.
public
array<string|int, Index>
$changedIndexes
= array()
$fromTable
public
Table
$fromTable
$name
public
string
$name
= null
$newName
public
string|bool
$newName
= false
$removedColumns
All removed fields.
public
array<string|int, Column>
$removedColumns
= array()
$removedForeignKeys
All removed foreign keys
public
array<string|int, ForeignKeyConstraint>
$removedForeignKeys
= array()
$removedIndexes
All removed indexes
public
array<string|int, Index>
$removedIndexes
= array()
$renamedColumns
Columns that are only renamed from key to column instance name.
public
array<string|int, Column>
$renamedColumns
= array()
$renamedIndexes
Indexes that are only renamed but are identical otherwise.
public
array<string|int, Index>
$renamedIndexes
= array()
Methods
__construct()
Constructs an TableDiff object.
public
__construct(string $tableName[, array<string|int, Column> $addedColumns = array() ][, array<string|int, ColumnDiff> $changedColumns = array() ][, array<string|int, Column> $removedColumns = array() ][, array<string|int, Index> $addedIndexes = array() ][, array<string|int, Index> $changedIndexes = array() ][, array<string|int, Index> $removedIndexes = array() ][, Table|null $fromTable = null ]) : mixed
Parameters
- $tableName : string
- $addedColumns : array<string|int, Column> = array()
- $changedColumns : array<string|int, ColumnDiff> = array()
- $removedColumns : array<string|int, Column> = array()
- $addedIndexes : array<string|int, Index> = array()
- $changedIndexes : array<string|int, Index> = array()
- $removedIndexes : array<string|int, Index> = array()
- $fromTable : Table|null = null
Return values
mixed —getName()
public
getName(AbstractPlatform $platform) : Identifier
Parameters
- $platform : AbstractPlatform
-
The platform to use for retrieving this table diff's name.
Return values
Identifier —getNewName()
public
getNewName() : Identifier|bool