diff --git a/core/includes/form.inc b/core/includes/form.inc index 5cd3bdbae..c139279 100644 --- a/core/includes/form.inc +++ b/core/includes/form.inc @@ -10,7 +10,9 @@ use Drupal\Component\Utility\String; use Drupal\Component\Utility\Url; use Drupal\Core\Database\Database; +use Drupal\Core\Form\FormElementHelper; use Drupal\Core\Language\Language; +use Drupal\Core\Render\Element; use Drupal\Core\Template\Attribute; use Drupal\Core\Utility\Color; use Symfony\Component\HttpFoundation\RedirectResponse; @@ -1158,6 +1160,7 @@ function form_process_password_confirm($element) { '#value' => empty($element['#value']) ? NULL : $element['#value']['pass1'], '#required' => $element['#required'], '#attributes' => array('class' => array('password-field')), + '#error_use_parent' => TRUE, ); $element['pass2'] = array( '#type' => 'password', @@ -1165,6 +1168,7 @@ function form_process_password_confirm($element) { '#value' => empty($element['#value']) ? NULL : $element['#value']['pass2'], '#required' => $element['#required'], '#attributes' => array('class' => array('password-confirm')), + '#error_use_parent' => TRUE, ); $element['#element_validate'] = array('password_confirm_validate'); $element['#tree'] = TRUE; @@ -1268,6 +1272,8 @@ function form_process_radios($element) { '#parents' => $element['#parents'], '#id' => drupal_html_id('edit-' . implode('-', $parents_for_id)), '#ajax' => isset($element['#ajax']) ? $element['#ajax'] : NULL, + // Errors should only be shown on the parent radios element. + '#error_use_parent' => TRUE, '#weight' => $weight, ); } @@ -1342,6 +1348,7 @@ function form_pre_render_conditional_form_element($element) { if (isset($element['#title']) || isset($element['#description'])) { // @see #type 'fieldgroup' + $element['#theme_wrappers'][] = 'form_element'; $element['#theme_wrappers'][] = 'fieldset'; $element['#attributes']['class'][] = 'fieldgroup'; $element['#attributes']['class'][] = 'form-composite'; @@ -1421,6 +1428,8 @@ function form_process_checkboxes($element) { '#default_value' => isset($value[$key]) ? $key : NULL, '#attributes' => $element['#attributes'], '#ajax' => isset($element['#ajax']) ? $element['#ajax'] : NULL, + // Errors should only be shown on the parent checkboxes element. + '#error_use_parent' => TRUE, '#weight' => $weight, ); } @@ -2649,6 +2658,36 @@ function form_pre_render_color($element) { } /** + * Preprocesses variables for theme_form(). + * + * @param array $variables + * An associative array containing: + * - element: An associative array containing the properties of the element. + * + * @ingroup themeable + */ +function template_preprocess_form(&$variables) { + if (!empty($variables['element']['#errors'])) { + $error_links = array(); + // Loop through all form errors, and display a link for each error that + // is associated with a specific form element. + foreach ($variables['element']['#errors'] as $key => $error) { + if ($element = FormElementHelper::getElementByName($key, $variables['element'])) { + $title = FormElementHelper::getElementTitle($element); + $error_links[] = l($title, '', array('fragment' => 'edit-' . str_replace('_', '-', $key), 'external' => TRUE)); + } + else { + drupal_set_message($error, 'error'); + } + } + + if (!empty($error_links)) { + drupal_set_message(format_plural(count($error_links), '1 error has been found', '@count errors have been found') . ': ' . implode(', ', $error_links), 'error'); + } + } +} + +/** * Returns HTML for a form. * * @param $variables @@ -2864,6 +2903,14 @@ function template_preprocess_form_element(&$variables) { $variables['attributes']['class'][] = 'form-disabled'; } + // Display any error messages. + $variables['errors'] = NULL; + if (!empty($element['#errors']) && empty($element['#error_use_parent'])) { + // Add a class if an error exists. + $variables['attributes']['class'][] = 'form-error'; + $variables['errors'] = $element['#errors']; + } + // If #title is not set, we don't display any label or required marker. if (!isset($element['#title'])) { $element['#title_display'] = 'none'; diff --git a/core/lib/Drupal/Core/Form/FormBuilder.php b/core/lib/Drupal/Core/Form/FormBuilder.php index 8e8a82a..ddcfbcc 100644 --- a/core/lib/Drupal/Core/Form/FormBuilder.php +++ b/core/lib/Drupal/Core/Form/FormBuilder.php @@ -860,6 +860,9 @@ public function validateForm($form_id, &$form, &$form_state) { } $form_state['values'] = $values; } + if (!$form_state['programmed']) { + $form['#errors'] = $this->getErrors($form_state); + } } /** @@ -1170,6 +1173,16 @@ public function executeHandlers($type, &$form, &$form_state) { */ public function setErrorByName($name, array &$form_state, $message = '') { if (!isset($form_state['errors'][$name])) { + // This is only used by errors set in submit handlers. + // @todo Unlike errors set during validation, these errors will not + // directly correspond to their input element, and will not interrupt + // submission. We should consider limiting usage of form errors to + // validation only, and encourage usage of drupal_set_message() in + // submit handlers. + if ($message && isset($form_state['build_info']['form_id']) && !empty($this->validatedForms[$form_state['build_info']['form_id']])) { + $this->drupalSetMessage($message, 'error'); + } + $record = TRUE; if (isset($form_state['limit_validation_errors'])) { // #limit_validation_errors is an array of "sections" within which user @@ -1197,9 +1210,6 @@ public function setErrorByName($name, array &$form_state, $message = '') { if ($record) { $form_state['errors'][$name] = $message; $this->request->attributes->set('_form_errors', TRUE); - if ($message) { - $this->drupalSetMessage($message, 'error'); - } } } diff --git a/core/lib/Drupal/Core/Form/FormElementHelper.php b/core/lib/Drupal/Core/Form/FormElementHelper.php new file mode 100644 index 0000000..ec5616e --- /dev/null +++ b/core/lib/Drupal/Core/Form/FormElementHelper.php @@ -0,0 +1,68 @@ + + {% if errors %} +
+ {% endif %} {% if label_display in ['before', 'invisible'] %} {{ label }} {% endif %} diff --git a/core/tests/Drupal/Tests/Core/Form/FormElementHelperTest.php b/core/tests/Drupal/Tests/Core/Form/FormElementHelperTest.php new file mode 100644 index 0000000..58973bd --- /dev/null +++ b/core/tests/Drupal/Tests/Core/Form/FormElementHelperTest.php @@ -0,0 +1,81 @@ + 'FormElementHelper test', + 'description' => 'Tests the form element helper.', + 'group' => 'Form API', + ); + } + + /** + * Tests the getElementByName() method. + * + * @covers ::getElementByName() + * + * @dataProvider getElementByNameProvider + */ + public function testGetElementByName($name, $form, $expected) { + $this->assertSame($expected, FormElementHelper::getElementByName($name, $form)); + } + + /** + * Provides test data. + */ + public function getElementByNameProvider() { + return array( + array('id', array(), array()), + array('id', array('id' => array('#title' => 'ID')), array('#title' => 'ID')), + array('id', array('fieldset' => array('id' => array('#title' => 'ID'))), array('#title' => 'ID')), + array('fieldset', array('fieldset' => array('id' => array('#title' => 'ID'))), array('id' => array('#title' => 'ID'))), + ); + } + + /** + * Tests the getElementTitle() method. + * + * @covers ::getElementTitle() + * + * @dataProvider getElementTitleProvider + */ + public function testGetElementTitle($name, $form, $expected) { + $element = FormElementHelper::getElementByName($name, $form); + $this->assertSame($expected, FormElementHelper::getElementTitle($element)); + } + + /** + * Provides test data. + */ + public function getElementTitleProvider() { + return array( + array('id', array(), ''), + array('id', array('id' => array('#title' => 'ID')), 'ID'), + array('id', array('fieldset' => array('id' => array('#title' => 'ID'))), 'ID'), + array('fieldset', array('fieldset' => array('id' => array('#title' => 'ID'))), 'ID'), + ); + } + +}