You are here

public function Schema::fieldSetDefault in Drupal 8

Same name in this branch
  1. 8 core/lib/Drupal/Core/Database/Schema.php \Drupal\Core\Database\Schema::fieldSetDefault()
  2. 8 core/lib/Drupal/Core/Database/Driver/sqlite/Schema.php \Drupal\Core\Database\Driver\sqlite\Schema::fieldSetDefault()
  3. 8 core/lib/Drupal/Core/Database/Driver/pgsql/Schema.php \Drupal\Core\Database\Driver\pgsql\Schema::fieldSetDefault()
  4. 8 core/lib/Drupal/Core/Database/Driver/mysql/Schema.php \Drupal\Core\Database\Driver\mysql\Schema::fieldSetDefault()

Set the default value for a field.

Parameters

$table: The table to be altered.

$field: The field to be altered.

$default: Default value to be set. NULL for 'default NULL'.

Throws

\Drupal\Core\Database\SchemaObjectDoesNotExistException If the specified table or field doesn't exist.

Overrides Schema::fieldSetDefault

Deprecated

in drupal:8.7.0 and is removed from drupal:9.0.0. Instead, call ::changeField() passing a full field specification.

See also

::changeField()

File

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

Class

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

Namespace

Drupal\Core\Database\Driver\sqlite

Code

public function fieldSetDefault($table, $field, $default) {
  @trigger_error('fieldSetDefault() is deprecated in drupal:8.7.0 and will be removed before drupal:9.0.0. Instead, call ::changeField() passing a full field specification. See https://www.drupal.org/node/2999035', E_USER_DEPRECATED);
  if (!$this
    ->fieldExists($table, $field)) {
    throw new SchemaObjectDoesNotExistException("Cannot set default value of field '{$table}.{$field}': field doesn't exist.");
  }
  $old_schema = $this
    ->introspectSchema($table);
  $new_schema = $old_schema;
  $new_schema['fields'][$field]['default'] = $default;
  $this
    ->alterTable($table, $old_schema, $new_schema);
}