function Schema::dropField

Same name in this branch
  1. 10 core/modules/mysql/src/Driver/Database/mysql/Schema.php \Drupal\mysql\Driver\Database\mysql\Schema::dropField()
  2. 10 core/modules/pgsql/src/Driver/Database/pgsql/Schema.php \Drupal\pgsql\Driver\Database\pgsql\Schema::dropField()
  3. 10 core/tests/fixtures/database_drivers/module/core_fake/src/Driver/Database/CoreFakeWithAllCustomClasses/Schema.php \Drupal\core_fake\Driver\Database\CoreFakeWithAllCustomClasses\Schema::dropField()
  4. 10 core/lib/Drupal/Core/Database/Schema.php \Drupal\Core\Database\Schema::dropField()
Same name and namespace in other branches
  1. 9 core/modules/sqlite/src/Driver/Database/sqlite/Schema.php \Drupal\sqlite\Driver\Database\sqlite\Schema::dropField()
  2. 9 core/modules/mysql/src/Driver/Database/mysql/Schema.php \Drupal\mysql\Driver\Database\mysql\Schema::dropField()
  3. 9 core/modules/pgsql/src/Driver/Database/pgsql/Schema.php \Drupal\pgsql\Driver\Database\pgsql\Schema::dropField()
  4. 9 core/tests/fixtures/database_drivers/module/corefake/src/Driver/Database/corefakeWithAllCustomClasses/Schema.php \Drupal\corefake\Driver\Database\corefakeWithAllCustomClasses\Schema::dropField()
  5. 9 core/lib/Drupal/Core/Database/Schema.php \Drupal\Core\Database\Schema::dropField()
  6. 8.9.x core/lib/Drupal/Core/Database/Driver/sqlite/Schema.php \Drupal\Core\Database\Driver\sqlite\Schema::dropField()
  7. 8.9.x core/lib/Drupal/Core/Database/Driver/mysql/Schema.php \Drupal\Core\Database\Driver\mysql\Schema::dropField()
  8. 8.9.x core/lib/Drupal/Core/Database/Driver/pgsql/Schema.php \Drupal\Core\Database\Driver\pgsql\Schema::dropField()
  9. 8.9.x core/lib/Drupal/Core/Database/Schema.php \Drupal\Core\Database\Schema::dropField()
  10. 11.x core/modules/sqlite/src/Driver/Database/sqlite/Schema.php \Drupal\sqlite\Driver\Database\sqlite\Schema::dropField()
  11. 11.x core/modules/mysql/src/Driver/Database/mysql/Schema.php \Drupal\mysql\Driver\Database\mysql\Schema::dropField()
  12. 11.x core/modules/pgsql/src/Driver/Database/pgsql/Schema.php \Drupal\pgsql\Driver\Database\pgsql\Schema::dropField()
  13. 11.x core/lib/Drupal/Core/Database/Schema.php \Drupal\Core\Database\Schema::dropField()

Drop a field.

Parameters

$table: The table to be altered.

$field: The field to be dropped.

Return value

bool TRUE if the field was successfully dropped, FALSE if there was no field by that name to begin with.

Overrides Schema::dropField

File

core/modules/sqlite/src/Driver/Database/sqlite/Schema.php, line 566

Class

Schema
SQLite implementation of \Drupal\Core\Database\Schema.

Namespace

Drupal\sqlite\Driver\Database\sqlite

Code

public function dropField($table, $field) {
  if (!$this->fieldExists($table, $field)) {
    return FALSE;
  }
  $old_schema = $this->introspectSchema($table);
  $new_schema = $old_schema;
  unset($new_schema['fields'][$field]);
  // Drop the primary key if the field to drop is part of it. This is
  // consistent with the behavior on PostgreSQL.
  // @see \Drupal\mysql\Driver\Database\mysql\Schema::dropField()
  if (isset($new_schema['primary key']) && in_array($field, $new_schema['primary key'], TRUE)) {
    unset($new_schema['primary key']);
  }
  // Handle possible index changes.
  foreach ($new_schema['indexes'] as $index => $fields) {
    foreach ($fields as $key => $field_name) {
      if ($field_name == $field) {
        unset($new_schema['indexes'][$index][$key]);
      }
    }
    // If this index has no more fields then remove it.
    if (empty($new_schema['indexes'][$index])) {
      unset($new_schema['indexes'][$index]);
    }
  }
  $this->alterTable($table, $old_schema, $new_schema);
  return TRUE;
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.