DateTimeDatelistNoTimeWidget.php in Datetime Extras 8

Namespace

Drupal\datetime_extras\Plugin\Field\FieldWidget

File

src/Plugin/Field/FieldWidget/DateTimeDatelistNoTimeWidget.php

<?php

namespace Drupal\datetime_extras\Plugin\Field\FieldWidget;

use Drupal\Core\Field\FieldItemListInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\datetime\Plugin\Field\FieldWidget\DateTimeDatelistWidget;

/**
 * Plugin implementation of the 'datetime_datelist_no_time' widget.
 *
 * @FieldWidget(
 *   id = "datetime_datelist_no_time",
 *   label = @Translation("Select list, no time"),
 *   field_types = {
 *     "datetime",
 *   },
 * )
 */
class DateTimeDatelistNoTimeWidget extends DateTimeDatelistWidget {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'date_year_range' => '1900:2050',
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $elements = parent::settingsForm($form, $form_state);
    $elements['date_order']['#options'] += [
      'Y' => $this
        ->t('Year'),
      'MY' => $this
        ->t('Month/Year'),
      'YM' => $this
        ->t('Year/Month'),
    ];
    $elements['date_year_range'] = [
      '#type' => 'textfield',
      '#title' => t('Date year range'),
      '#description' => "Example: 2000:2010",
      '#default_value' => $this
        ->getSetting('date_year_range'),
    ];
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = parent::settingsSummary();
    $summary[] = t('Date year range: @range', [
      '@range' => $this
        ->getSetting('date_year_range'),
    ]);
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    $date_order = $this
      ->getSetting('date_order');

    // Set up the date part order array.
    switch ($date_order) {
      case 'Y':
        $date_part_order = [
          'year',
        ];
        break;
      case 'MY':
        $date_part_order = [
          'month',
          'year',
        ];
        break;
      case 'YM':
        $date_part_order = [
          'year',
          'month',
        ];
        break;
    }

    // Work around core bug.
    // @TODO: Fix after https://www.drupal.org/node/2863897
    if (isset($date_part_order)) {
      $this
        ->setSetting('date_order', 'YMD');
    }
    $element = parent::formElement($items, $delta, $element, $form, $form_state);
    $this
      ->setSetting('date_order', $date_order);
    if (isset($date_part_order)) {
      $element['value']['#date_part_order'] = $date_part_order;
    }

    // Set year start / end.
    $year_range = $this
      ->getSetting('date_year_range');
    if (isset($year_range)) {
      $element['value']['#date_year_range'] = $year_range;
    }
    return $element;
  }

}

Classes

Name	Description
DateTimeDatelistNoTimeWidget	Plugin implementation of the 'datetime_datelist_no_time' widget.