yaffs.net Git - yaffs-website/blob - web/core/modules/datetime_range/src/Plugin/Field/FieldType/DateRangeFieldItemList.php

   1 <?php
   2
   3 namespace Drupal\datetime_range\Plugin\Field\FieldType;
   4
   5 use Drupal\Core\Datetime\DrupalDateTime;
   6 use Drupal\Core\Entity\FieldableEntityInterface;
   7 use Drupal\Core\Field\FieldDefinitionInterface;
   8 use Drupal\Core\Field\FieldItemList;
   9 use Drupal\Core\Form\FormStateInterface;
  10 use Drupal\datetime\Plugin\Field\FieldType\DateTimeFieldItemList;
  11 use Drupal\datetime\Plugin\Field\FieldType\DateTimeItemInterface;
  12
  13 /**
  14  * Represents a configurable entity daterange field.
  15  */
  16 class DateRangeFieldItemList extends DateTimeFieldItemList {
  17
  18   /**
  19    * {@inheritdoc}
  20    */
  21   public function defaultValuesForm(array &$form, FormStateInterface $form_state) {
  22     if (empty($this->getFieldDefinition()->getDefaultValueCallback())) {
  23       $default_value = $this->getFieldDefinition()->getDefaultValueLiteral();
  24
  25       $element = parent::defaultValuesForm($form, $form_state);
  26
  27       $element['default_date_type']['#title'] = $this->t('Default start date');
  28       $element['default_date_type']['#description'] = $this->t('Set a default value for the start date.');
  29
  30       $element['default_end_date_type'] = [
  31         '#type' => 'select',
  32         '#title' => $this->t('Default end date'),
  33         '#description' => $this->t('Set a default value for the end date.'),
  34         '#default_value' => isset($default_value[0]['default_end_date_type']) ? $default_value[0]['default_end_date_type'] : '',
  35         '#options' => [
  36           static::DEFAULT_VALUE_NOW => $this->t('Current date'),
  37           static::DEFAULT_VALUE_CUSTOM => $this->t('Relative date'),
  38         ],
  39         '#empty_value' => '',
  40       ];
  41
  42       $element['default_end_date'] = [
  43         '#type' => 'textfield',
  44         '#title' => $this->t('Relative default value'),
  45         '#description' => $this->t("Describe a time by reference to the current day, like '+90 days' (90 days from the day the field is created) or '+1 Saturday' (the next Saturday). See <a href=\"http://php.net/manual/function.strtotime.php\">strtotime</a> for more details."),
  46         '#default_value' => (isset($default_value[0]['default_end_date_type']) && $default_value[0]['default_end_date_type'] == static::DEFAULT_VALUE_CUSTOM) ? $default_value[0]['default_end_date'] : '',
  47         '#states' => [
  48           'visible' => [
  49             ':input[id="edit-default-value-input-default-end-date-type"]' => ['value' => static::DEFAULT_VALUE_CUSTOM],
  50           ],
  51         ],
  52       ];
  53
  54       return $element;
  55     }
  56   }
  57
  58   /**
  59    * {@inheritdoc}
  60    */
  61   public function defaultValuesFormValidate(array $element, array &$form, FormStateInterface $form_state) {
  62     if ($form_state->getValue(['default_value_input', 'default_date_type']) == static::DEFAULT_VALUE_CUSTOM) {
  63       $is_strtotime = @strtotime($form_state->getValue(['default_value_input', 'default_date']));
  64       if (!$is_strtotime) {
  65         $form_state->setErrorByName('default_value_input][default_date', $this->t('The relative start date value entered is invalid.'));
  66       }
  67     }
  68
  69     if ($form_state->getValue(['default_value_input', 'default_end_date_type']) == static::DEFAULT_VALUE_CUSTOM) {
  70       $is_strtotime = @strtotime($form_state->getValue(['default_value_input', 'default_end_date']));
  71       if (!$is_strtotime) {
  72         $form_state->setErrorByName('default_value_input][default_end_date', $this->t('The relative end date value entered is invalid.'));
  73       }
  74     }
  75   }
  76
  77   /**
  78    * {@inheritdoc}
  79    */
  80   public function defaultValuesFormSubmit(array $element, array &$form, FormStateInterface $form_state) {
  81     if ($form_state->getValue(['default_value_input', 'default_date_type']) || $form_state->getValue(['default_value_input', 'default_end_date_type'])) {
  82       if ($form_state->getValue(['default_value_input', 'default_date_type']) == static::DEFAULT_VALUE_NOW) {
  83         $form_state->setValueForElement($element['default_date'], static::DEFAULT_VALUE_NOW);
  84       }
  85       if ($form_state->getValue(['default_value_input', 'default_end_date_type']) == static::DEFAULT_VALUE_NOW) {
  86         $form_state->setValueForElement($element['default_end_date'], static::DEFAULT_VALUE_NOW);
  87       }
  88       return [$form_state->getValue('default_value_input')];
  89     }
  90     return [];
  91   }
  92
  93   /**
  94    * {@inheritdoc}
  95    */
  96   public static function processDefaultValue($default_value, FieldableEntityInterface $entity, FieldDefinitionInterface $definition) {
  97     // Explicitly call the base class so that we can get the default value
  98     // types.
  99     $default_value = FieldItemList::processDefaultValue($default_value, $entity, $definition);
 100
 101     // Allow either the start or end date to have a default, but not require
 102     // defaults for both.
 103     if (!empty($default_value[0]['default_date_type']) || !empty($default_value[0]['default_end_date_type'])) {
 104       // A default value should be in the format and timezone used for date
 105       // storage. All-day ranges are stored the same as date+time ranges.  We
 106       // only provide a default value for the first item, as do all fields.
 107       // Otherwise, there is no way to clear out unwanted values on multiple
 108       // value fields.
 109       $storage_format = $definition->getSetting('datetime_type') == DateRangeItem::DATETIME_TYPE_DATE ? DateTimeItemInterface::DATE_STORAGE_FORMAT : DateTimeItemInterface::DATETIME_STORAGE_FORMAT;
 110       $default_values = [[]];
 111
 112       if (!empty($default_value[0]['default_date_type'])) {
 113         $start_date = new DrupalDateTime($default_value[0]['default_date'], DateTimeItemInterface::STORAGE_TIMEZONE);
 114         $start_value = $start_date->format($storage_format);
 115         $default_values[0]['value'] = $start_value;
 116         $default_values[0]['start_date'] = $start_date;
 117       }
 118
 119       if (!empty($default_value[0]['default_end_date_type'])) {
 120         $end_date = new DrupalDateTime($default_value[0]['default_end_date'], DateTimeItemInterface::STORAGE_TIMEZONE);
 121         $end_value = $end_date->format($storage_format);
 122         $default_values[0]['end_value'] = $end_value;
 123         $default_values[0]['end_date'] = $end_date;
 124       }
 125
 126       $default_value = $default_values;
 127     }
 128
 129     return $default_value;
 130   }
 131
 132 }