www.aleph1.co.uk Git - yaffs-website/blob - web/core/modules/inline_form_errors/src/FormErrorHandler.php

   1 <?php
   2
   3 namespace Drupal\inline_form_errors;
   4
   5 use Drupal\Core\Form\FormElementHelper;
   6 use Drupal\Core\Form\FormErrorHandler as CoreFormErrorHandler;
   7 use Drupal\Core\Form\FormStateInterface;
   8 use Drupal\Core\Messenger\MessengerInterface;
   9 use Drupal\Core\Render\Element;
  10 use Drupal\Core\Routing\LinkGeneratorTrait;
  11 use Drupal\Core\Render\RendererInterface;
  12 use Drupal\Core\StringTranslation\StringTranslationTrait;
  13 use Drupal\Core\StringTranslation\TranslationInterface;
  14 use Drupal\Core\Url;
  15 use Drupal\Core\Utility\LinkGeneratorInterface;
  16
  17 /**
  18  * Produces inline form errors.
  19  */
  20 class FormErrorHandler extends CoreFormErrorHandler {
  21
  22   use StringTranslationTrait;
  23   use LinkGeneratorTrait;
  24
  25   /**
  26    * The renderer service.
  27    *
  28    * @var \Drupal\Core\Render\RendererInterface
  29    */
  30   protected $renderer;
  31
  32   /**
  33    * The messenger.
  34    *
  35    * @var \Drupal\Core\Messenger\MessengerInterface
  36    */
  37   protected $messenger;
  38
  39   /**
  40    * Constructs a new FormErrorHandler.
  41    *
  42    * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
  43    *   The string translation service.
  44    * @param \Drupal\Core\Utility\LinkGeneratorInterface $link_generator
  45    *   The link generation service.
  46    * @param \Drupal\Core\Render\RendererInterface $renderer
  47    *   The renderer service.
  48    * @param \Drupal\Core\Messenger\MessengerInterface $messenger
  49    *   The messenger.
  50    */
  51   public function __construct(TranslationInterface $string_translation, LinkGeneratorInterface $link_generator, RendererInterface $renderer, MessengerInterface $messenger) {
  52     $this->stringTranslation = $string_translation;
  53     $this->linkGenerator = $link_generator;
  54     $this->renderer = $renderer;
  55     $this->messenger = $messenger;
  56   }
  57
  58   /**
  59    * Loops through and displays all form errors.
  60    *
  61    * To disable inline form errors for an entire form set the
  62    * #disable_inline_form_errors property to TRUE on the top level of the $form
  63    * array:
  64    * @code
  65    * $form['#disable_inline_form_errors'] = TRUE;
  66    * @endcode
  67    * This should only be done when another appropriate accessibility strategy is
  68    * in place.
  69    *
  70    * @param array $form
  71    *   An associative array containing the structure of the form.
  72    * @param \Drupal\Core\Form\FormStateInterface $form_state
  73    *   The current state of the form.
  74    */
  75   protected function displayErrorMessages(array $form, FormStateInterface $form_state) {
  76     // Skip generating inline form errors when opted out.
  77     if (!empty($form['#disable_inline_form_errors'])) {
  78       parent::displayErrorMessages($form, $form_state);
  79       return;
  80     }
  81
  82     $error_links = [];
  83     $errors = $form_state->getErrors();
  84     // Loop through all form errors and check if we need to display a link.
  85     foreach ($errors as $name => $error) {
  86       $form_element = FormElementHelper::getElementByName($name, $form);
  87       $title = FormElementHelper::getElementTitle($form_element);
  88
  89       // Only show links to erroneous elements that are visible.
  90       $is_visible_element = Element::isVisibleElement($form_element);
  91       // Only show links for elements that have a title themselves or have
  92       // children with a title.
  93       $has_title = !empty($title);
  94       // Only show links for elements with an ID.
  95       $has_id = !empty($form_element['#id']);
  96
  97       // Do not show links to elements with suppressed messages. Most often
  98       // their parent element is used for inline errors.
  99       if (!empty($form_element['#error_no_message'])) {
 100         unset($errors[$name]);
 101       }
 102       elseif ($is_visible_element && $has_title && $has_id) {
 103         $error_links[] = $this->l($title, Url::fromRoute('<none>', [], ['fragment' => $form_element['#id'], 'external' => TRUE]));
 104         unset($errors[$name]);
 105       }
 106     }
 107
 108     // Set normal error messages for all remaining errors.
 109     foreach ($errors as $error) {
 110       $this->messenger->addError($error);
 111     }
 112
 113     if (!empty($error_links)) {
 114       $render_array = [
 115         [
 116          '#markup' => $this->formatPlural(count($error_links), '1 error has been found: ', '@count errors have been found: '),
 117         ],
 118         [
 119           '#theme' => 'item_list',
 120           '#items' => $error_links,
 121           '#context' => ['list_style' => 'comma-list'],
 122         ],
 123       ];
 124       $message = $this->renderer->renderPlain($render_array);
 125       $this->messenger->addError($message);
 126     }
 127   }
 128
 129 }