function Datelist::validateDatelist

Same name in other branches
  1. 9 core/lib/Drupal/Core/Datetime/Element/Datelist.php \Drupal\Core\Datetime\Element\Datelist::validateDatelist()
  2. 8.9.x core/lib/Drupal/Core/Datetime/Element/Datelist.php \Drupal\Core\Datetime\Element\Datelist::validateDatelist()
  3. 11.x core/lib/Drupal/Core/Datetime/Element/Datelist.php \Drupal\Core\Datetime\Element\Datelist::validateDatelist()

Validation callback for a datelist element.

If the date is valid, the date object created from the user input is set in the form for use by the caller. The work of compiling the user input back into a date object is handled by the value callback, so we can use it here. We also have the raw input available for validation testing.

Parameters

array $element: The element being processed.

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

array $complete_form: The complete form structure.

File

core/lib/Drupal/Core/Datetime/Element/Datelist.php, line 292

Class

Datelist
Provides a datelist element.

Namespace

Drupal\Core\Datetime\Element

Code

public static function validateDatelist(&$element, FormStateInterface $form_state, &$complete_form) {
    $input_exists = FALSE;
    $input = NestedArray::getValue($form_state->getValues(), $element['#parents'], $input_exists);
    $title = static::getElementTitle($element, $complete_form);
    if ($input_exists) {
        $all_empty = static::checkEmptyInputs($input, $element['#date_part_order']);
        // If there's empty input and the field is not required, set it to empty.
        if (empty($input['year']) && empty($input['month']) && empty($input['day']) && !$element['#required']) {
            $form_state->setValueForElement($element, NULL);
        }
        elseif (empty($input['year']) && empty($input['month']) && empty($input['day']) && $element['#required']) {
            $form_state->setError($element, t('The %field date is required.', [
                '%field' => $title,
            ]));
        }
        elseif (!empty($all_empty)) {
            foreach ($all_empty as $value) {
                $form_state->setError($element, t('The %field date is incomplete.', [
                    '%field' => $title,
                ]));
                $form_state->setError($element[$value], t('A value must be selected for %part.', [
                    '%part' => $value,
                ]));
            }
        }
        else {
            // If the input is valid, set it.
            $date = $input['object'];
            if ($date instanceof DrupalDateTime && !$date->hasErrors()) {
                $form_state->setValueForElement($element, $date);
            }
            elseif ($form_state->getError($element) === NULL) {
                $form_state->setError($element, t('The %field date is invalid.', [
                    '%field' => $title,
                ]));
            }
        }
    }
}

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