public function ResponsiveBgImageFormatter::settingsForm in Background Images Formatter 8.2

Same name and namespace in other branches

8.3 modules/responsive_bg_image_formatter/src/Plugin/Field/FieldFormatter/ResponsiveBgImageFormatter.php \Drupal\responsive_bg_image_formatter\Plugin\Field\FieldFormatter\ResponsiveBgImageFormatter::settingsForm()
8 modules/responsive_bg_image_formatter/src/Plugin/Field/FieldFormatter/ResponsiveBgImageFormatter.php \Drupal\responsive_bg_image_formatter\Plugin\Field\FieldFormatter\ResponsiveBgImageFormatter::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 BgImageFormatter::settingsForm

File

modules/responsive_bg_image_formatter/src/Plugin/Field/FieldFormatter/ResponsiveBgImageFormatter.php, line 41

Class

ResponsiveBgImageFormatter: Plugin annotation @FieldFormatter( id = "responsive_bg_image_formatter", label = @Translation("Responsive Background Image"), field_types = {"image"} )

Namespace

Drupal\responsive_bg_image_formatter\Plugin\Field\FieldFormatter

Code

public function settingsForm(array $form, FormStateInterface $form_state) {
  $element = parent::settingsForm($form, $form_state);
  $element['image_style']['#options'] = $this
    ->getResponsiveImageStyles(TRUE);
  $element['image_style']['#description'] = $this
    ->t('Select <a href="@href_image_style">the responsive image style</a> to use.', [
    '@href_image_style' => Url::fromRoute('entity.responsive_image_style.collection')
      ->toString(),
  ]);
  unset($element['css_settings']['bg_image_media_query']);
  return $element;
}

You are here