function ImageEffectFormBase::buildForm

Same name and namespace in other branches
  1. 9 core/modules/image/src/Form/ImageEffectFormBase.php \Drupal\image\Form\ImageEffectFormBase::buildForm()
  2. 8.9.x core/modules/image/src/Form/ImageEffectFormBase.php \Drupal\image\Form\ImageEffectFormBase::buildForm()
  3. 10 core/modules/image/src/Form/ImageEffectFormBase.php \Drupal\image\Form\ImageEffectFormBase::buildForm()

Parameters

array $form: A nested array form elements comprising the form.

\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form.

\Drupal\image\ImageStyleInterface $image_style: The image style.

string $image_effect: The image effect ID.

Return value

array The form structure.

Throws

\Symfony\Component\HttpKernel\Exception\NotFoundHttpException

Overrides FormInterface::buildForm

2 calls to ImageEffectFormBase::buildForm()
ImageEffectAddForm::buildForm in core/modules/image/src/Form/ImageEffectAddForm.php
Form constructor.
ImageEffectEditForm::buildForm in core/modules/image/src/Form/ImageEffectEditForm.php
Form constructor.
2 methods override ImageEffectFormBase::buildForm()
ImageEffectAddForm::buildForm in core/modules/image/src/Form/ImageEffectAddForm.php
Form constructor.
ImageEffectEditForm::buildForm in core/modules/image/src/Form/ImageEffectEditForm.php
Form constructor.

File

core/modules/image/src/Form/ImageEffectFormBase.php, line 56

Class

ImageEffectFormBase
Provides a base form for image effects.

Namespace

Drupal\image\Form

Code

public function buildForm(array $form, FormStateInterface $form_state, ?ImageStyleInterface $image_style = NULL, $image_effect = NULL) {
    $this->imageStyle = $image_style;
    try {
        $this->imageEffect = $this->prepareImageEffect($image_effect);
    } catch (PluginNotFoundException $e) {
        throw new NotFoundHttpException("Invalid effect id: '{$image_effect}'.");
    }
    $request = $this->getRequest();
    if (!$this->imageEffect instanceof ConfigurableImageEffectInterface) {
        throw new NotFoundHttpException();
    }
    $form['#attached']['library'][] = 'image/admin';
    $form['uuid'] = [
        '#type' => 'value',
        '#value' => $this->imageEffect
            ->getUuid(),
    ];
    $form['id'] = [
        '#type' => 'value',
        '#value' => $this->imageEffect
            ->getPluginId(),
    ];
    $form['data'] = [];
    $subform_state = SubformState::createForSubform($form['data'], $form, $form_state);
    $form['data'] = $this->imageEffect
        ->buildConfigurationForm($form['data'], $subform_state);
    $form['data']['#tree'] = TRUE;
    // Check the URL for a weight, then the image effect, otherwise use default.
    $form['weight'] = [
        '#type' => 'hidden',
        '#value' => $request->query
            ->has('weight') ? (int) $request->query
            ->get('weight') : $this->imageEffect
            ->getWeight(),
    ];
    $form['actions'] = [
        '#type' => 'actions',
    ];
    $form['actions']['submit'] = [
        '#type' => 'submit',
        '#button_type' => 'primary',
    ];
    $form['actions']['cancel'] = [
        '#type' => 'link',
        '#title' => $this->t('Cancel'),
        '#url' => $this->imageStyle
            ->toUrl('edit-form'),
        '#attributes' => [
            'class' => [
                'button',
            ],
        ],
    ];
    return $form;
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.