public function BackgroundImageEffect::buildConfigurationForm in Image Effects 8.2

Same name and namespace in other branches

1. 8.3 src/Plugin/ImageEffect/BackgroundImageEffect.php \Drupal\image_effects\Plugin\ImageEffect\BackgroundImageEffect::buildConfigurationForm()
2. 8 src/Plugin/ImageEffect/BackgroundImageEffect.php \Drupal\image_effects\Plugin\ImageEffect\BackgroundImageEffect::buildConfigurationForm()

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 PluginFormInterface::buildConfigurationForm

File

src/Plugin/ImageEffect/BackgroundImageEffect.php, line 104

Class

BackgroundImageEffect

Class BackgroundImageEffect.

Namespace

Drupal\image_effects\Plugin\ImageEffect

Code

public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
  $options = [
    '#title' => $this
      ->t('Background image'),
    '#description' => $this
      ->t('Image to use for background.'),
    '#default_value' => $this->configuration['background_image'],
  ];
  $form['background_image'] = $this->imageSelector
    ->selectionElement($options);
  $form['placement'] = [
    '#type' => 'radios',
    '#title' => $this
      ->t('Placement'),
    '#options' => [
      'left-top' => $this
        ->t('Top left'),
      'center-top' => $this
        ->t('Top center'),
      'right-top' => $this
        ->t('Top right'),
      'left-center' => $this
        ->t('Center left'),
      'center-center' => $this
        ->t('Center'),
      'right-center' => $this
        ->t('Center right'),
      'left-bottom' => $this
        ->t('Bottom left'),
      'center-bottom' => $this
        ->t('Bottom center'),
      'right-bottom' => $this
        ->t('Bottom right'),
    ],
    '#theme' => 'image_anchor',
    '#default_value' => $this->configuration['placement'],
    '#description' => $this
      ->t('Position of the source image on the background image.'),
  ];
  $form['x_offset'] = [
    '#type' => 'number',
    '#title' => $this
      ->t('Horizontal offset'),
    '#field_suffix' => 'px',
    '#description' => $this
      ->t('Additional horizontal offset from placement.'),
    '#default_value' => $this->configuration['x_offset'],
    '#maxlength' => 4,
    '#size' => 4,
  ];
  $form['y_offset'] = [
    '#type' => 'number',
    '#title' => $this
      ->t('Vertical offset'),
    '#field_suffix' => 'px',
    '#description' => $this
      ->t('Additional vertical offset from placement.'),
    '#default_value' => $this->configuration['y_offset'],
    '#maxlength' => 4,
    '#size' => 4,
  ];
  $form['opacity'] = [
    '#type' => 'number',
    '#title' => $this
      ->t('Opacity'),
    '#field_suffix' => '%',
    '#description' => $this
      ->t('Opacity of the source image when overlaid on the background image, in percentage. 0% means fully transparent, 100% fully opaque.'),
    '#default_value' => $this->configuration['opacity'],
    '#min' => 0,
    '#max' => 100,
    '#maxlength' => 3,
    '#size' => 3,
  ];
  return $form;
}