public function FileExtensionFormatter::settingsForm in Zircon Profile 8

Same name and namespace in other branches

1. 8.0 core/modules/file/src/Plugin/Field/FieldFormatter/FileExtensionFormatter.php \Drupal\file\Plugin\Field\FieldFormatter\FileExtensionFormatter::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 BaseFieldFileFormatterBase::settingsForm

File

core/modules/file/src/Plugin/Field/FieldFormatter/FileExtensionFormatter.php, line 40

Contains \Drupal\file\Plugin\Field\FieldFormatter\FileExtensionFormatter.

Class

FileExtensionFormatter

Formatter to render a filename as file extension.

Namespace

Drupal\file\Plugin\Field\FieldFormatter

Code

public function settingsForm(array $form, FormStateInterface $form_state) {
  $form = parent::settingsForm($form, $form_state);
  $form['extension_detect_tar'] = array(
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Include tar in extension'),
    '#description' => $this
      ->t("If the part of the filename just before the extension is '.tar', include this in the extension output."),
    '#default_value' => $this
      ->getSetting('extension_detect_tar'),
  );
  return $form;
}