W3cubDocs

/Drupal 8

public function FieldItemBase::storageSettingsForm

public FieldItemBase::storageSettingsForm(array &$form, FormStateInterface $form_state, $has_data)

Returns a form for the storage-level settings.

Invoked from \Drupal\field_ui\Form\FieldStorageConfigEditForm to allow administrators to configure storage-level settings.

Field storage might reject settings changes that affect the field storage schema if the storage already has data. When the $has_data parameter is TRUE, the form should not allow changing the settings that take part in the schema() method. It is recommended to set #access to FALSE on the corresponding elements.

Parameters

array $form: The form where the settings form is being included in.

\Drupal\Core\Form\FormStateInterface $form_state: The form state of the (entire) configuration form.

bool $has_data: TRUE if the field already has data, FALSE if not.

Return value

The form definition for the field settings.

Overrides FieldItemInterface::storageSettingsForm

File

core/lib/Drupal/Core/Field/FieldItemBase.php, line 219

Class

FieldItemBase
An entity field item.

Namespace

Drupal\Core\Field

Code

public function storageSettingsForm(array &$form, FormStateInterface $form_state, $has_data) {
  return array();
}

© 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!Field!FieldItemBase.php/function/FieldItemBase::storageSettingsForm/8.1.x