You are here

public function DateTimeItem::storageSettingsForm in Drupal 8

Same name and namespace in other branches
  1. 9 core/modules/datetime/src/Plugin/Field/FieldType/DateTimeItem.php \Drupal\datetime\Plugin\Field\FieldType\DateTimeItem::storageSettingsForm()

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

array The form definition for the field settings.

Overrides FieldItemBase::storageSettingsForm

1 call to DateTimeItem::storageSettingsForm()
DateRangeItem::storageSettingsForm in core/modules/datetime_range/src/Plugin/Field/FieldType/DateRangeItem.php
Returns a form for the storage-level settings.
1 method overrides DateTimeItem::storageSettingsForm()
DateRangeItem::storageSettingsForm in core/modules/datetime_range/src/Plugin/Field/FieldType/DateRangeItem.php
Returns a form for the storage-level settings.

File

core/modules/datetime/src/Plugin/Field/FieldType/DateTimeItem.php, line 84

Class

DateTimeItem
Plugin implementation of the 'datetime' field type.

Namespace

Drupal\datetime\Plugin\Field\FieldType

Code

public function storageSettingsForm(array &$form, FormStateInterface $form_state, $has_data) {
  $element = [];
  $element['datetime_type'] = [
    '#type' => 'select',
    '#title' => t('Date type'),
    '#description' => t('Choose the type of date to create.'),
    '#default_value' => $this
      ->getSetting('datetime_type'),
    '#options' => [
      static::DATETIME_TYPE_DATETIME => t('Date and time'),
      static::DATETIME_TYPE_DATE => t('Date only'),
    ],
    '#disabled' => $has_data,
  ];
  return $element;
}