You are here

public function SerialItem::storageSettingsForm in Serial Field 8

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

File

src/Plugin/Field/FieldType/SerialItem.php, line 58

Class

SerialItem
Plugin implementation of the 'serial' field type.

Namespace

Drupal\serial\Plugin\Field\FieldType

Code

public function storageSettingsForm(array &$form, FormStateInterface $form_state, $has_data) {
  $element = [];
  $element['start_value'] = [
    '#type' => 'number',
    '#title' => $this
      ->t('Starting value'),
    '#default_value' => $this
      ->getSetting('start_value'),
    '#min' => 1,
    '#required' => TRUE,
    '#disabled' => $has_data,
  ];
  $element['init_existing_entities'] = [
    '#type' => 'radios',
    '#title' => $this
      ->t('Start on existing entities'),
    '#description' => $this
      ->t('When this field is created for a bundle that already have entities.'),
    '#options' => [
      0 => $this
        ->t('No'),
      1 => $this
        ->t('Yes'),
    ],
    '#default_value' => $this
      ->getSetting('init_existing_entities'),
    '#required' => TRUE,
    '#disabled' => $has_data,
  ];

  // Only run the initialization when the field has no data.
  if (!$has_data) {

    // @todo ideally, use submit handler and not validate
    // $handlers = $form_state->getSubmitHandlers();
    // $handlers[] = [$this, 'initializeEntitiesCallback'];
    // $form_state->setSubmitHandlers($handlers);
    $form['#validate'][] = [
      $this,
      'initializeEntitiesCallback',
    ];
  }
  return $element;
}