ConfirmFormHelper.php

Same filename in other branches
  1. 8.9.x core/lib/Drupal/Core/Form/ConfirmFormHelper.php
  2. 10 core/lib/Drupal/Core/Form/ConfirmFormHelper.php
  3. 11.x core/lib/Drupal/Core/Form/ConfirmFormHelper.php

Namespace

Drupal\Core\Form

File

core/lib/Drupal/Core/Form/ConfirmFormHelper.php

View source
<?php

namespace Drupal\Core\Form;

use Drupal\Component\Utility\UrlHelper;
use Drupal\Core\Url;
use Symfony\Component\HttpFoundation\Request;

/**
 * Provides common functionality to confirmation forms.
 */
class ConfirmFormHelper {
    
    /**
     * Builds the cancel link for a confirmation form.
     *
     * @param \Drupal\Core\Form\ConfirmFormInterface $form
     *   The confirmation form.
     * @param \Symfony\Component\HttpFoundation\Request $request
     *   The current request.
     *
     * @return array
     *   The link render array for the cancel form.
     */
    public static function buildCancelLink(ConfirmFormInterface $form, Request $request) {
        // Prepare cancel link.
        $query = $request->query;
        $url = NULL;
        // If a destination is specified, that serves as the cancel link.
        if ($query->has('destination')) {
            $options = UrlHelper::parse($query->get('destination'));
            // @todo Revisit this in https://www.drupal.org/node/2418219.
            try {
                $url = Url::fromUserInput('/' . ltrim($options['path'], '/'), $options);
            } catch (\InvalidArgumentException $e) {
                // Suppress the exception and fall back to the form's cancel url.
            }
        }
        // Check for a route-based cancel link.
        if (!$url) {
            $url = $form->getCancelUrl();
        }
        return [
            '#type' => 'link',
            '#title' => $form->getCancelText(),
            '#attributes' => [
                'class' => [
                    'button',
                ],
            ],
            '#url' => $url,
            '#cache' => [
                'contexts' => [
                    'url.query_args:destination',
                ],
            ],
        ];
    }

}

Classes

Title Deprecated Summary
ConfirmFormHelper Provides common functionality to confirmation forms.

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