/**
* Creates a column replacement, which has a quoted name.
*
* @param Column $column
*
* @return Column
*/
private function createColumnReplacement(Column $column)
{
$columnConfig = $column->toArray();
$columnConfig['platformOptions'] = $column->getPlatformOptions();
$columnConfig['customSchemaOptions'] = $column->getCustomSchemaOptions();
return new Column($this->platform->quoteIdentifier($column->getName()), $column->getType(), $columnConfig);
}
/**
* @group DBAL-42
*/
public function testColumnComment()
{
$column = new Column("bar", Type::getType('string'));
$this->assertNull($column->getComment());
$column->setComment("foo");
$this->assertEquals("foo", $column->getComment());
$columnArray = $column->toArray();
$this->assertArrayHasKey('comment', $columnArray);
$this->assertEquals('foo', $columnArray['comment']);
}
/**
* Maps only needed definitions defined as __CLASS__ properties
* @param Column $column
*/
public function __construct(Column $column)
{
foreach ($column->toArray() as $type => $value) {
if (array_key_exists($type, get_class_vars(__CLASS__))) {
if ($value instanceof Type) {
$this->{$type} = $value->getName();
continue;
}
$this->{$type} = $value;
}
}
return $this;
}
/**
* Returns the SQL clause for creating a column in a table alteration.
*
* @param Column $column The column to add.
*
* @return string
*/
protected function getAlterTableAddColumnClause(Column $column)
{
return 'ADD ' . $this->getColumnDeclarationSQL($column->getQuotedName($this), $column->toArray());
}
/**
* Set the renamed columns on the table diff.
*
* @param \Doctrine\DBAL\Schema\TableDiff $tableDiff
* @param \Illuminate\Support\Fluent $command
* @param \Doctrine\DBAL\Schema\Column $column
* @return \Doctrine\DBAL\Schema\TableDiff
*/
protected function setRenamedColumns(TableDiff $tableDiff, Fluent $command, Column $column)
{
$newColumn = new Column($command->to, $column->getType(), $column->toArray());
$tableDiff->renamedColumns = array($command->from => $newColumn);
return $tableDiff;
}
/**
* Returns the SQL clause for adding a default constraint in an ALTER TABLE statement.
*
* @param string $tableName The name of the table to generate the clause for.
* @param Column $column The column to generate the clause for.
*
* @return string
*/
private function getAlterTableAddDefaultConstraintClause($tableName, Column $column)
{
$columnDef = $column->toArray();
$columnDef['name'] = $column->getQuotedName($this);
return 'ADD' . $this->getDefaultConstraintDeclarationSQL($tableName, $columnDef);
}
/**
* Returns the difference between the fields $field1 and $field2.
*
* If there are differences this method returns $field2, otherwise the
* boolean false.
*
* @param \Doctrine\DBAL\Schema\Column $column1
* @param \Doctrine\DBAL\Schema\Column $column2
*
* @return array
*/
public function diffColumn(Column $column1, Column $column2)
{
$properties1 = $column1->toArray();
$properties2 = $column2->toArray();
$changedProperties = array();
foreach (array('type', 'notnull', 'unsigned', 'autoincrement') as $property) {
if ($properties1[$property] != $properties2[$property]) {
$changedProperties[] = $property;
}
}
if ($properties1['default'] != $properties2['default'] || null === $properties1['default'] && null !== $properties2['default'] || null === $properties2['default'] && null !== $properties1['default']) {
$changedProperties[] = 'default';
}
if ($properties1['type'] instanceof Types\StringType && !$properties1['type'] instanceof Types\GuidType || $properties1['type'] instanceof Types\BinaryType) {
// check if value of length is set at all, default value assumed otherwise.
$length1 = $properties1['length'] ?: 255;
$length2 = $properties2['length'] ?: 255;
if ($length1 != $length2) {
$changedProperties[] = 'length';
}
if ($properties1['fixed'] != $properties2['fixed']) {
$changedProperties[] = 'fixed';
}
} elseif ($properties1['type'] instanceof Types\DecimalType) {
if (($properties1['precision'] ?: 10) != ($properties2['precision'] ?: 10)) {
$changedProperties[] = 'precision';
}
if ($properties1['scale'] != $properties2['scale']) {
$changedProperties[] = 'scale';
}
}
// A null value and an empty string are actually equal for a comment so they should not trigger a change.
if ($properties1['comment'] !== $properties2['comment'] && !(null === $properties1['comment'] && '' === $properties2['comment']) && !(null === $properties2['comment'] && '' === $properties1['comment'])) {
$changedProperties[] = 'comment';
}
$customOptions1 = $column1->getCustomSchemaOptions();
$customOptions2 = $column2->getCustomSchemaOptions();
// Remove option-as-object
foreach ($customOptions2 as $k => $v) {
if (is_object($v)) {
unset($customOptions2[$k]);
}
}
foreach (array_merge(array_keys($customOptions1), array_keys($customOptions2)) as $key) {
if (!array_key_exists($key, $properties1) || !array_key_exists($key, $properties2)) {
$changedProperties[] = $key;
} elseif ($properties1[$key] !== $properties2[$key]) {
$changedProperties[] = $key;
}
}
$platformOptions1 = $column1->getPlatformOptions();
$platformOptions2 = $column2->getPlatformOptions();
foreach (array_keys(array_intersect_key($platformOptions1, $platformOptions2)) as $key) {
if ($properties1[$key] !== $properties2[$key]) {
$changedProperties[] = $key;
}
}
return array_unique($changedProperties);
}
/**
* Returns the difference between the fields $field1 and $field2.
*
* If there are differences this method returns $field2, otherwise the
* boolean false.
*
* @param \Doctrine\DBAL\Schema\Column $column1
* @param \Doctrine\DBAL\Schema\Column $column2
*
* @return array
*/
public function diffColumn(Column $column1, Column $column2)
{
$properties1 = $column1->toArray();
$properties2 = $column2->toArray();
$changedProperties = array();
foreach (array('type', 'notnull', 'unsigned', 'autoincrement') as $property) {
if ($properties1[$property] != $properties2[$property]) {
$changedProperties[] = $property;
}
}
if ($properties1['default'] != $properties2['default'] || null === $properties1['default'] && null !== $properties2['default'] || null === $properties2['default'] && null !== $properties1['default']) {
$changedProperties[] = 'default';
}
if ($properties1['type'] instanceof Types\StringType || $properties1['type'] instanceof Types\BinaryType) {
// check if value of length is set at all, default value assumed otherwise.
$length1 = $properties1['length'] ?: 255;
$length2 = $properties2['length'] ?: 255;
if ($length1 != $length2) {
$changedProperties[] = 'length';
}
if ($properties1['fixed'] != $properties2['fixed']) {
$changedProperties[] = 'fixed';
}
} elseif ($properties1['type'] instanceof Types\DecimalType) {
if (($properties1['precision'] ?: 10) != ($properties2['precision'] ?: 10)) {
$changedProperties[] = 'precision';
}
if ($properties1['scale'] != $properties2['scale']) {
$changedProperties[] = 'scale';
}
}
// only allow to delete comment if its set to '' not to null.
if ($properties1['comment'] !== null && $properties1['comment'] != $properties2['comment']) {
$changedProperties[] = 'comment';
}
$customOptions1 = $column1->getCustomSchemaOptions();
$customOptions2 = $column2->getCustomSchemaOptions();
foreach (array_merge(array_keys($customOptions1), array_keys($customOptions2)) as $key) {
if (!array_key_exists($key, $properties1) || !array_key_exists($key, $properties2)) {
$changedProperties[] = $key;
} elseif ($properties1[$key] !== $properties2[$key]) {
$changedProperties[] = $key;
}
}
$platformOptions1 = $column1->getPlatformOptions();
$platformOptions2 = $column2->getPlatformOptions();
foreach (array_keys(array_intersect_key($platformOptions1, $platformOptions2)) as $key) {
if ($properties1[$key] !== $properties2[$key]) {
$changedProperties[] = $key;
}
}
return array_unique($changedProperties);
}
/**
* Accept a column in a table
*
* @param Table $table a table object
* @param Column $column a column object
*
* @return void
*/
public function acceptColumn(Table $table, Column $column)
{
$this->schemaArray['tables'][$table->getName()]['columns'][$column->getName()] = $column->toArray();
$this->schemaArray['tables'][$table->getName()]['columns'][$column->getName()]['type'] = $column->getType()->getName();
}
