FieldStorageConfigInterface::setSettings

public FieldStorageConfigInterface::setSettings(array $settings)

Sets field storage settings.

Note that the method does not unset existing settings not specified in the incoming $settings array.

For example:

// Given these are the default settings.
$storage_definition->getSettings() === [
  'fruit' => 'apple',
  'season' => 'summer',
];
// Change only the 'fruit' setting.
$storage_definition->setSettings(['fruit' => 'banana']);
// The 'season' setting persists unchanged.
$storage_definition->getSettings() === [
  'fruit' => 'banana',
  'season' => 'summer',
];

For clarity, it is preferred to use setSetting() if not all available settings are supplied.

Parameters

array $settings: The array of storage settings.

Return value

$this

File

core/modules/field/src/FieldStorageConfigInterface.php, line 123

Class

FieldStorageConfigInterface: Provides an interface defining a field storage entity.

Namespace

Drupal\field

Code

1	`public` `function` `setSettings(array` `$settings);`

Links:

https://api.drupal.org/api/drupal/core%21modules%21field%21src%21FieldStorageConfigInterface.php/function/FieldStorageConfigInterface%3A%3AsetSettings/8.2.x

doc_Drupal

2025-01-10 15:47:30

Comments