public function DateTimeWidgetBase::massageFormValues in Drupal 8

Same name and namespace in other branches

1. 9 core/modules/datetime/src/Plugin/Field/FieldWidget/DateTimeWidgetBase.php \Drupal\datetime\Plugin\Field\FieldWidget\DateTimeWidgetBase::massageFormValues()
2. 10 core/modules/datetime/src/Plugin/Field/FieldWidget/DateTimeWidgetBase.php \Drupal\datetime\Plugin\Field\FieldWidget\DateTimeWidgetBase::massageFormValues()

Massages the form values into the format expected for field values.

Parameters

array $values: The submitted form values produced by the widget.

• If the widget does not manage multiple values itself, the array holds the values generated by the multiple copies of the $element generated by the formElement() method, keyed by delta.
• If the widget manages multiple values, the array holds the values of the form element generated by the formElement() method.

array $form: The form structure where field elements are attached to. This might be a full form structure, or a sub-element of a larger form.

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

Return value

array An array of field values, keyed by delta.

Overrides WidgetBase::massageFormValues

1 method overrides DateTimeWidgetBase::massageFormValues()

DateRangeWidgetBase::massageFormValues in core/modules/datetime_range/src/Plugin/Field/FieldWidget/DateRangeWidgetBase.php

Massages the form values into the format expected for field values.

File

core/modules/datetime/src/Plugin/Field/FieldWidget/DateTimeWidgetBase.php, line 49

Class

DateTimeWidgetBase

Base class for the 'datetime_*' widgets.

Namespace

Drupal\datetime\Plugin\Field\FieldWidget

Code

public function massageFormValues(array $values, array $form, FormStateInterface $form_state) {

  // The widget form element type has transformed the value to a
  // DrupalDateTime object at this point. We need to convert it back to the
  // storage timezone and format.
  $datetime_type = $this
    ->getFieldSetting('datetime_type');
  if ($datetime_type === DateTimeItem::DATETIME_TYPE_DATE) {
    $storage_format = DateTimeItemInterface::DATE_STORAGE_FORMAT;
  }
  else {
    $storage_format = DateTimeItemInterface::DATETIME_STORAGE_FORMAT;
  }
  $storage_timezone = new \DateTimezone(DateTimeItemInterface::STORAGE_TIMEZONE);
  foreach ($values as &$item) {
    if (!empty($item['value']) && $item['value'] instanceof DrupalDateTime) {

      /** @var \Drupal\Core\Datetime\DrupalDateTime $date */
      $date = $item['value'];

      // Adjust the date for storage.
      $item['value'] = $date
        ->setTimezone($storage_timezone)
        ->format($storage_format);
    }
  }
  return $values;
}