public function DateRangeWidgetBase::massageFormValues in Drupal 10

Same name and namespace in other branches

1. 8 core/modules/datetime_range/src/Plugin/Field/FieldWidget/DateRangeWidgetBase.php \Drupal\datetime_range\Plugin\Field\FieldWidget\DateRangeWidgetBase::massageFormValues()
2. 9 core/modules/datetime_range/src/Plugin/Field/FieldWidget/DateRangeWidgetBase.php \Drupal\datetime_range\Plugin\Field\FieldWidget\DateRangeWidgetBase::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 DateTimeWidgetBase::massageFormValues

File

core/modules/datetime_range/src/Plugin/Field/FieldWidget/DateRangeWidgetBase.php, line 51

Class

DateRangeWidgetBase

Base class for the 'daterange_*' widgets.

Namespace

Drupal\datetime_range\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 === DateRangeItem::DATETIME_TYPE_DATE) {
    $storage_format = DateTimeItemInterface::DATE_STORAGE_FORMAT;
  }
  else {
    $storage_format = DateTimeItemInterface::DATETIME_STORAGE_FORMAT;
  }
  $storage_timezone = new \DateTimeZone(DateTimeItemInterface::STORAGE_TIMEZONE);
  $user_timezone = new \DateTimeZone(date_default_timezone_get());
  foreach ($values as &$item) {
    if (!empty($item['value']) && $item['value'] instanceof DrupalDateTime) {

      /** @var \Drupal\Core\Datetime\DrupalDateTime $start_date */
      $start_date = $item['value'];
      if ($datetime_type === DateRangeItem::DATETIME_TYPE_ALLDAY) {

        // All day fields start at midnight on the starting date, but are
        // stored like datetime fields, so we need to adjust the time.
        // This function is called twice, so to prevent a double conversion
        // we need to explicitly set the timezone.
        $start_date
          ->setTimeZone($user_timezone)
          ->setTime(0, 0, 0);
      }

      // Adjust the date for storage.
      $item['value'] = $start_date
        ->setTimezone($storage_timezone)
        ->format($storage_format);
    }
    if (!empty($item['end_value']) && $item['end_value'] instanceof DrupalDateTime) {

      /** @var \Drupal\Core\Datetime\DrupalDateTime $end_date */
      $end_date = $item['end_value'];
      if ($datetime_type === DateRangeItem::DATETIME_TYPE_ALLDAY) {

        // All day fields start at midnight on the starting date, but are
        // stored like datetime fields, so we need to adjust the time.
        // This function is called twice, so to prevent a double conversion
        // we need to explicitly set the timezone.
        $end_date
          ->setTimeZone($user_timezone)
          ->setTime(23, 59, 59);
      }

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