public function AspectSwitcherImageEffect::buildConfigurationForm in Image Effects 8

Same name and namespace in other branches

1. 8.3 src/Plugin/ImageEffect/AspectSwitcherImageEffect.php \Drupal\image_effects\Plugin\ImageEffect\AspectSwitcherImageEffect::buildConfigurationForm()
2. 8.2 src/Plugin/ImageEffect/AspectSwitcherImageEffect.php \Drupal\image_effects\Plugin\ImageEffect\AspectSwitcherImageEffect::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/AspectSwitcherImageEffect.php, line 72

Class

AspectSwitcherImageEffect

Choose image styles to apply based on source image orientation.

Namespace

Drupal\image_effects\Plugin\ImageEffect

Code

public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
  $form['info'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('Information'),
  ];
  $form['info']['help'] = [
    '#markup' => $this
      ->t("'Convert' effects included in the image style specified will not be effective. It is not possible to change the image format based on the aspect. If you need to change the image format, you will have to add a 'Convert' effect in this image style."),
  ];
  $form['landscape_image_style'] = [
    '#type' => 'entity_autocomplete',
    '#title' => $this
      ->t('Landscape image style'),
    '#target_type' => 'image_style',
    '#default_value' => $this
      ->failSafeGetImageStyle($this->configuration['landscape_image_style']),
    '#description' => $this
      ->t("Leave empty to avoid switching."),
  ];
  $form['portrait_image_style'] = [
    '#type' => 'entity_autocomplete',
    '#title' => $this
      ->t('Portrait image style'),
    '#target_type' => 'image_style',
    '#default_value' => $this
      ->failSafeGetImageStyle($this->configuration['portrait_image_style']),
    '#description' => $this
      ->t("Leave empty to avoid switching."),
  ];
  $form['ratio_adjustment'] = [
    '#type' => 'number',
    '#title' => t('Ratio adjustment (advanced)'),
    '#required' => TRUE,
    '#size' => 7,
    '#min' => 0,
    '#max' => 5,
    '#step' => 0.01,
    '#default_value' => $this->configuration['ratio_adjustment'],
    '#description' => $this
      ->t("This allows you to bend the rules for how different the proportions need to be to trigger the switch.") . "<br/>" . $this
      ->t("If n = (width/height)*ratio is greater than 1, use 'landscape', otherwise use 'portrait'.") . "<br/>" . $this
      ->t("When ratio = 1 (the default) it will just switch between portrait and landscape modes."),
  ];
  return $form;
}