public function FileFieldFormatter::buildConfigurationForm in Entity Embed 8

Form constructor.

Plugin forms are embedded in other forms. In order to know where the plugin form is located in the parent form, #parents and #array_parents must be known, but these are not available during the initial build phase. In order to have these properties available when building the plugin form's elements, let this method return a form element that has a #process callback and build the rest of the form in the callback. By the time the callback is executed, the element's #parents and #array_parents properties will have been set by the form API. For more documentation on #parents and #array_parents, see \Drupal\Core\Render\Element\FormElement.

Parameters

array $form: An associative array containing the initial structure of the plugin form.

\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form. Calling code should pass on a subform state created through \Drupal\Core\Form\SubformState::createForSubform().

Return value

array The form structure.

Overrides FieldFormatterEntityEmbedDisplayBase::buildConfigurationForm

1 call to FileFieldFormatter::buildConfigurationForm()

ImageFieldFormatter::buildConfigurationForm in src/Plugin/entity_embed/EntityEmbedDisplay/ImageFieldFormatter.php

Form constructor.

1 method overrides FileFieldFormatter::buildConfigurationForm()

ImageFieldFormatter::buildConfigurationForm in src/Plugin/entity_embed/EntityEmbedDisplay/ImageFieldFormatter.php

Form constructor.

File

src/Plugin/entity_embed/EntityEmbedDisplay/FileFieldFormatter.php, line 45

Class

FileFieldFormatter

Entity Embed Display reusing file field formatters.

Namespace

Drupal\entity_embed\Plugin\entity_embed\EntityEmbedDisplay

Code

public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
  $form = parent::buildConfigurationForm($form, $form_state);

  // Description is stored in the configuration since it doesn't map to an
  // actual HTML attribute.
  $form['description'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Description'),
    '#default_value' => $this
      ->getConfigurationValue('description'),
    '#description' => $this
      ->t('The description may be used as the label of the link to the file.'),
  ];
  return $form;
}