public function DefineCanvasImageEffect::buildConfigurationForm in Imagick 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 PluginFormInterface::buildConfigurationForm

File

src/Plugin/ImageEffect/DefineCanvasImageEffect.php, line 60

Class

DefineCanvasImageEffect

Applies the define canvas effect on an image resource.

Namespace

Drupal\imagick\Plugin\ImageEffect

Code

public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
  $form = [
    '#type' => 'container',
    '#attributes' => [
      'class' => [
        'colorform',
      ],
    ],
  ];
  $form['HEX'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('HEX'),
    '#default_value' => $this->configuration['HEX'],
    '#attributes' => [
      'class' => [
        'colorentry',
      ],
    ],
  ];
  $form['colorpicker'] = [
    '#weight' => -1,
    '#type' => 'container',
    '#attributes' => [
      'class' => [
        'colorpicker',
      ],
      'style' => [
        'float:right',
      ],
    ],
  ];

  // Add Farbtastic color picker.
  $form['matte_color']['#attached'] = [
    'library' => [
      'imagick/colorpicker',
    ],
  ];
  $form['under'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Resize canvas <em>under</em> image (possibly cropping)'),
    '#default_value' => $this->configuration['under'],
    '#description' => $this
      ->t('If <em>not</em> set, this will create a solid flat layer, probably totally obscuring the source image'),
  ];
  $form['info'] = [
    '#value' => $this
      ->t('Enter values in ONLY ONE of the below options. Either exact or relative. Most values are optional - you can adjust only one dimension as needed. If no useful values are set, the current base image size will be used.'),
  ];
  $form['exact_measurements'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Exact measurements'),
    '#default_value' => $this->configuration['exact_measurements'],
  ];
  $form['exact'] = [
    '#type' => 'details',
    '#open' => TRUE,
    '#title' => $this
      ->t('Exact size'),
    'help' => [
      '#markup' => $this
        ->t('Set the canvas to a precise size, possibly cropping the image. Use to start with a known size.'),
      '#prefix' => '<p>',
      '#suffix' => '</p>',
    ],
    'width' => [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Width'),
      '#default_value' => $this->configuration['exact']['width'],
      '#description' => $this
        ->t('Enter a value in pixels or percent'),
      '#size' => 5,
    ],
    'height' => [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Height'),
      '#default_value' => $this->configuration['exact']['height'],
      '#description' => $this
        ->t('Enter a value in pixels or percent'),
      '#size' => 5,
    ],
    'anchor' => [
      '#type' => 'radios',
      '#title' => $this
        ->t('Anchor'),
      '#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']['anchor'],
    ],
    '#states' => [
      'visible' => [
        ':input[name="data[exact_measurements]"]' => [
          'checked' => TRUE,
        ],
      ],
    ],
  ];
  $form['relative'] = [
    '#type' => 'details',
    '#open' => TRUE,
    '#title' => $this
      ->t('Relative size'),
    'help' => [
      '#markup' => $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.'),
      '#prefix' => '<p>',
      '#suffix' => '</p>',
    ],
    'leftdiff' => [
      '#type' => 'textfield',
      '#title' => $this
        ->t('left difference'),
      '#default_value' => $this->configuration['relative']['leftdiff'],
      '#size' => 6,
      '#description' => $this
        ->t('Enter an offset in pixels.'),
    ],
    'rightdiff' => [
      '#type' => 'textfield',
      '#title' => $this
        ->t('right difference'),
      '#default_value' => $this->configuration['relative']['rightdiff'],
      '#size' => 6,
      '#description' => $this
        ->t('Enter an offset in pixels.'),
    ],
    'topdiff' => [
      '#type' => 'textfield',
      '#title' => $this
        ->t('top difference'),
      '#default_value' => $this->configuration['relative']['topdiff'],
      '#size' => 6,
      '#description' => $this
        ->t('Enter an offset in pixels.'),
    ],
    'bottomdiff' => [
      '#type' => 'textfield',
      '#title' => $this
        ->t('bottom difference'),
      '#default_value' => $this->configuration['relative']['bottomdiff'],
      '#size' => 6,
      '#description' => $this
        ->t('Enter an offset in pixels.'),
    ],
    '#states' => [
      'visible' => [
        ':input[name="data[exact_measurements]"]' => [
          'checked' => FALSE,
        ],
      ],
    ],
  ];
  return $form;
}