TimestampDatetimeOptionalWidget.php in farmOS 2.x

Namespace

Drupal\farm_field\Plugin\Field\FieldWidget

File

modules/core/field/src/Plugin/Field/FieldWidget/TimestampDatetimeOptionalWidget.php

<?php

namespace Drupal\farm_field\Plugin\Field\FieldWidget;

use Drupal\Core\Datetime\DrupalDateTime;
use Drupal\Core\Datetime\Element\Datetime;
use Drupal\Core\Datetime\Entity\DateFormat;
use Drupal\Core\Datetime\Plugin\Field\FieldWidget\TimestampDatetimeWidget;
use Drupal\Core\Field\FieldItemListInterface;
use Drupal\Core\Form\FormStateInterface;

/**
 * Plugin implementation of the 'datetime timestamp optional' widget.
 *
 * Extends the core datetime_timestamp widget to not default to current time.
 * This is useful when a timestamp field is optional and should not default
 * to the current time, such as the animal birthdate.
 *
 * @FieldWidget(
 *   id = "datetime_timestamp_optional",
 *   label = @Translation("Datetime Timestamp Optional"),
 *   field_types = {
 *     "timestamp",
 *   }
 * )
 */
class TimestampDatetimeOptionalWidget extends TimestampDatetimeWidget {

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    $element = parent::formElement($items, $delta, $element, $form, $form_state);
    $date_format = DateFormat::load('html_date')
      ->getPattern();
    $time_format = DateFormat::load('html_time')
      ->getPattern();
    $element['value']['#description'] = $this
      ->t('Format: %format.', [
      '%format' => Datetime::formatExample($date_format . ' ' . $time_format),
    ]);
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function massageFormValues(array $values, array $form, FormStateInterface $form_state) {
    foreach ($values as &$item) {

      // @todo The structure is different whether access is denied or not, to
      //   be fixed in https://www.drupal.org/node/2326533.
      if (isset($item['value']) && $item['value'] instanceof DrupalDateTime) {
        $date = $item['value'];
      }
      elseif (isset($item['value']['object']) && $item['value']['object'] instanceof DrupalDateTime) {
        $date = $item['value']['object'];
      }
      $item['value'] = !empty($date) ? $date
        ->getTimestamp() : NULL;
    }
    return $values;
  }

}

Classes

Name	Description
TimestampDatetimeOptionalWidget	Plugin implementation of the 'datetime timestamp optional' widget.