public function SetCanvasImageEffect::buildConfigurationForm in Image Effects 8

Same name and namespace in other branches

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

Class

SetCanvasImageEffect

Class SetCanvasImageEffect.

Namespace

Drupal\image_effects\Plugin\ImageEffect

Code

public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
  $form['canvas_size'] = [
    '#type' => 'radios',
    '#title' => $this
      ->t('Canvas size'),
    '#default_value' => $this->configuration['canvas_size'],
    '#options' => [
      'exact' => $this
        ->t('Exact size'),
      'relative' => $this
        ->t('Relative size'),
    ],
    '#required' => TRUE,
  ];

  // Exact size canvas.
  $form['exact'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('Exact size'),
    '#description' => $this
      ->t('Set the canvas to a precise size, possibly cropping the image. Use to start with a known size.'),
    '#open' => TRUE,
    '#collapsible' => FALSE,
    '#states' => [
      'visible' => [
        ':input[name="data[canvas_size]"]' => [
          'value' => 'exact',
        ],
      ],
    ],
  ];
  $form['exact']['width'] = [
    '#type' => 'image_effects_px_perc',
    '#title' => $this
      ->t('Width'),
    '#default_value' => $this->configuration['exact']['width'],
    '#description' => $this
      ->t('Enter a value, and specify if pixels or percent. Leave blank to keep source image width.'),
    '#size' => 6,
    '#maxlength' => 6,
  ];
  $form['exact']['height'] = [
    '#type' => 'image_effects_px_perc',
    '#title' => $this
      ->t('Height'),
    '#default_value' => $this->configuration['exact']['height'],
    '#description' => $this
      ->t('Enter a value, and specify if pixels or percent. Leave blank to keep source image height.'),
    '#size' => 6,
    '#maxlength' => 6,
  ];
  $form['exact']['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['exact']['placement'],
    '#description' => $this
      ->t('Position of the image on the canvas.'),
  ];
  $form['exact']['x_offset'] = [
    '#type' => 'number',
    '#title' => $this
      ->t('Horizontal offset'),
    '#field_suffix' => 'px',
    '#description' => $this
      ->t('Additional horizontal offset from placement.'),
    '#default_value' => $this->configuration['exact']['x_offset'],
    '#maxlength' => 4,
    '#size' => 4,
  ];
  $form['exact']['y_offset'] = [
    '#type' => 'number',
    '#title' => $this
      ->t('Vertical offset'),
    '#field_suffix' => 'px',
    '#description' => $this
      ->t('Additional vertical offset from placement.'),
    '#default_value' => $this->configuration['exact']['y_offset'],
    '#maxlength' => 4,
    '#size' => 4,
  ];

  // Relative size canvas.
  $form['relative'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('Relative size'),
    '#description' => $this
      ->t('Set the canvas to a relative size, based on the current image dimensions. Use to add simple borders or expand by a fixed amount. Negative values may crop the image.'),
    '#open' => TRUE,
    '#collapsible' => FALSE,
    '#states' => [
      'visible' => [
        ':input[name="data[canvas_size]"]' => [
          'value' => 'relative',
        ],
      ],
    ],
  ];
  $form['relative']['left'] = [
    '#type' => 'number',
    '#title' => $this
      ->t('Left margin'),
    '#default_value' => $this->configuration['relative']['left'],
    '#maxlength' => 4,
    '#size' => 4,
    '#description' => $this
      ->t('Enter an offset in pixels.'),
  ];
  $form['relative']['right'] = [
    '#type' => 'number',
    '#title' => $this
      ->t('Right margin'),
    '#default_value' => $this->configuration['relative']['right'],
    '#maxlength' => 4,
    '#size' => 4,
    '#description' => $this
      ->t('Enter an offset in pixels.'),
  ];
  $form['relative']['top'] = [
    '#type' => 'number',
    '#title' => $this
      ->t('Top margin'),
    '#default_value' => $this->configuration['relative']['top'],
    '#maxlength' => 4,
    '#size' => 4,
    '#description' => $this
      ->t('Enter an offset in pixels.'),
  ];
  $form['relative']['bottom'] = [
    '#type' => 'number',
    '#title' => $this
      ->t('Bottom margin'),
    '#default_value' => $this->configuration['relative']['bottom'],
    '#maxlength' => 4,
    '#size' => 4,
    '#description' => $this
      ->t('Enter an offset in pixels.'),
  ];

  // Canvas color.
  $form['canvas_color'] = [
    '#type' => 'image_effects_color',
    '#title' => $this
      ->t('Canvas color'),
    '#allow_null' => TRUE,
    '#allow_opacity' => TRUE,
    '#description' => $this
      ->t("This will have the effect of adding colored (or transparent) margins around the image."),
    '#default_value' => $this->configuration['canvas_color'],
  ];
  return $form;
}