public function ImageItem::storageSettingsForm in Drupal 9

Same name and namespace in other branches

8 core/modules/image/src/Plugin/Field/FieldType/ImageItem.php \Drupal\image\Plugin\Field\FieldType\ImageItem::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 FileItem::storageSettingsForm

File

core/modules/image/src/Plugin/Field/FieldType/ImageItem.php, line 166

Class

ImageItem: Plugin implementation of the 'image' field type.

Namespace

Drupal\image\Plugin\Field\FieldType

Code

public function storageSettingsForm(array &$form, FormStateInterface $form_state, $has_data) {
  $element = [];

  // We need the field-level 'default_image' setting, and $this->getSettings()
  // will only provide the instance-level one, so we need to explicitly fetch
  // the field.
  $settings = $this
    ->getFieldDefinition()
    ->getFieldStorageDefinition()
    ->getSettings();
  $scheme_options = \Drupal::service('stream_wrapper_manager')
    ->getNames(StreamWrapperInterface::WRITE_VISIBLE);
  $element['uri_scheme'] = [
    '#type' => 'radios',
    '#title' => t('Upload destination'),
    '#options' => $scheme_options,
    '#default_value' => $settings['uri_scheme'],
    '#description' => t('Select where the final files should be stored. Private file storage has significantly more overhead than public files, but allows restricted access to files within this field.'),
  ];

  // Add default_image element.
  static::defaultImageForm($element, $settings);
  $element['default_image']['#description'] = t('If no image is uploaded, this image will be shown on display.');
  return $element;
}

You are here