public function BaseFieldFileFormatterBase::settingsForm in Drupal 10

Same name and namespace in other branches

8 core/modules/file/src/Plugin/Field/FieldFormatter/BaseFieldFileFormatterBase.php \Drupal\file\Plugin\Field\FieldFormatter\BaseFieldFileFormatterBase::settingsForm()
9 core/modules/file/src/Plugin/Field/FieldFormatter/BaseFieldFileFormatterBase.php \Drupal\file\Plugin\Field\FieldFormatter\BaseFieldFileFormatterBase::settingsForm()

Returns a form to configure settings for the formatter.

Invoked from \Drupal\field_ui\Form\EntityDisplayFormBase to allow administrators to configure the formatter. The field_ui module takes care of handling submitted form values.

Parameters

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

\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form.

Return value

array The form elements for the formatter settings.

Overrides FormatterBase::settingsForm

4 methods override BaseFieldFileFormatterBase::settingsForm()

DefaultFileFormatter::settingsForm in core/modules/file/src/Plugin/Field/FieldFormatter/DefaultFileFormatter.php: Returns a form to configure settings for the formatter.
FileExtensionFormatter::settingsForm in core/modules/file/src/Plugin/Field/FieldFormatter/FileExtensionFormatter.php: Returns a form to configure settings for the formatter.
FilemimeFormatter::settingsForm in core/modules/file/src/Plugin/Field/FieldFormatter/FilemimeFormatter.php: Returns a form to configure settings for the formatter.
FileUriFormatter::settingsForm in core/modules/file/src/Plugin/Field/FieldFormatter/FileUriFormatter.php: Returns a form to configure settings for the formatter.

File

core/modules/file/src/Plugin/Field/FieldFormatter/BaseFieldFileFormatterBase.php, line 78

Class

BaseFieldFileFormatterBase: Base class for file formatters, which allow to link to the file download URL.

Namespace

Drupal\file\Plugin\Field\FieldFormatter

Code

public function settingsForm(array $form, FormStateInterface $form_state) {
  $form = parent::settingsForm($form, $form_state);
  $form['link_to_file'] = [
    '#title' => $this
      ->t('Link this field to the file download URL'),
    '#type' => 'checkbox',
    '#default_value' => $this
      ->getSetting('link_to_file'),
  ];
  return $form;
}

You are here