www.aleph1.co.uk Git - yaffs-website/blob - web/core/modules/datetime/src/Plugin/Field/FieldType/DateTimeFieldItemList.php

   1 <?php
   2
   3 namespace Drupal\datetime\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
  11 /**
  12  * Represents a configurable entity datetime field.
  13  */
  14 class DateTimeFieldItemList extends FieldItemList {
  15
  16   /**
  17    * Defines the default value as now.
  18    */
  19   const DEFAULT_VALUE_NOW = 'now';
  20
  21   /**
  22    * Defines the default value as relative.
  23    */
  24   const DEFAULT_VALUE_CUSTOM = 'relative';
  25
  26   /**
  27    * {@inheritdoc}
  28    */
  29   public function defaultValuesForm(array &$form, FormStateInterface $form_state) {
  30     if (empty($this->getFieldDefinition()->getDefaultValueCallback())) {
  31       $default_value = $this->getFieldDefinition()->getDefaultValueLiteral();
  32
  33       $element = [
  34         '#parents' => ['default_value_input'],
  35         'default_date_type' => [
  36           '#type' => 'select',
  37           '#title' => t('Default date'),
  38           '#description' => t('Set a default value for this date.'),
  39           '#default_value' => isset($default_value[0]['default_date_type']) ? $default_value[0]['default_date_type'] : '',
  40           '#options' => [
  41             static::DEFAULT_VALUE_NOW => t('Current date'),
  42             static::DEFAULT_VALUE_CUSTOM => t('Relative date'),
  43           ],
  44           '#empty_value' => '',
  45         ],
  46         'default_date' => [
  47           '#type' => 'textfield',
  48           '#title' => t('Relative default value'),
  49           '#description' => 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."),
  50           '#default_value' => (isset($default_value[0]['default_date_type']) && $default_value[0]['default_date_type'] == static::DEFAULT_VALUE_CUSTOM) ? $default_value[0]['default_date'] : '',
  51           '#states' => [
  52             'visible' => [
  53               ':input[id="edit-default-value-input-default-date-type"]' => ['value' => static::DEFAULT_VALUE_CUSTOM],
  54             ],
  55           ],
  56         ],
  57       ];
  58
  59       return $element;
  60     }
  61   }
  62
  63   /**
  64    * {@inheritdoc}
  65    */
  66   public function defaultValuesFormValidate(array $element, array &$form, FormStateInterface $form_state) {
  67     if ($form_state->getValue(['default_value_input', 'default_date_type']) == static::DEFAULT_VALUE_CUSTOM) {
  68       $is_strtotime = @strtotime($form_state->getValue(['default_value_input', 'default_date']));
  69       if (!$is_strtotime) {
  70         $form_state->setErrorByName('default_value_input][default_date', t('The relative date value entered is invalid.'));
  71       }
  72     }
  73   }
  74
  75   /**
  76    * {@inheritdoc}
  77    */
  78   public function defaultValuesFormSubmit(array $element, array &$form, FormStateInterface $form_state) {
  79     if ($form_state->getValue(['default_value_input', 'default_date_type'])) {
  80       if ($form_state->getValue(['default_value_input', 'default_date_type']) == static::DEFAULT_VALUE_NOW) {
  81         $form_state->setValueForElement($element['default_date'], static::DEFAULT_VALUE_NOW);
  82       }
  83       return [$form_state->getValue('default_value_input')];
  84     }
  85     return [];
  86   }
  87
  88   /**
  89    * {@inheritdoc}
  90    */
  91   public static function processDefaultValue($default_value, FieldableEntityInterface $entity, FieldDefinitionInterface $definition) {
  92     $default_value = parent::processDefaultValue($default_value, $entity, $definition);
  93
  94     if (isset($default_value[0]['default_date_type'])) {
  95       if ($definition->getSetting('datetime_type') === DateTimeItem::DATETIME_TYPE_DATE) {
  96         // A default date only value should be in the format used for date
  97         // storage but in the user's local timezone.
  98         $date = new DrupalDateTime($default_value[0]['default_date'], drupal_get_user_timezone());
  99         $format = DateTimeItemInterface::DATE_STORAGE_FORMAT;
 100       }
 101       else {
 102         // A default date+time value should be in the format and timezone used
 103         // for date storage.
 104         $date = new DrupalDateTime($default_value[0]['default_date'], DateTimeItemInterface::STORAGE_TIMEZONE);
 105         $format = DateTimeItemInterface::DATETIME_STORAGE_FORMAT;
 106       }
 107       $value = $date->format($format);
 108       // We only provide a default value for the first item, as do all fields.
 109       // Otherwise, there is no way to clear out unwanted values on multiple value
 110       // fields.
 111       $default_value = [
 112         [
 113           'value' => $value,
 114           'date' => $date,
 115         ],
 116       ];
 117     }
 118     return $default_value;
 119   }
 120
 121 }