W3cubDocs

/Drupal 8

public function Schema::dropField

public Schema::dropField($table, $field)

Drop a field.

Parameters

$table: The table to be altered.

$field: The field to be dropped.

Return value

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

Overrides Schema::dropField

File

core/lib/Drupal/Core/Database/Driver/sqlite/Schema.php, line 491

Class

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

Namespace

Drupal\Core\Database\Driver\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]);

  // Handle possible primary key changes.
  if (isset($new_schema['primary key']) && ($key = array_search($field, $new_schema['primary key'])) !== FALSE) {
    unset($new_schema['primary key'][$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;
}

© 2001–2016 by the original authors
Licensed under the GNU General Public License, version 2 and later.
Drupal is a registered trademark of Dries Buytaert.
https://api.drupal.org/api/drupal/core!lib!Drupal!Core!Database!Driver!sqlite!Schema.php/function/Schema::dropField/8.1.x