DateFormat.php

Same filename in this branch
  1. 9 core/lib/Drupal/Core/Datetime/Entity/DateFormat.php
Same filename in other branches
  1. 8.9.x core/modules/config_translation/src/FormElement/DateFormat.php
  2. 8.9.x core/lib/Drupal/Core/Datetime/Entity/DateFormat.php
  3. 10 core/modules/config_translation/src/FormElement/DateFormat.php
  4. 10 core/lib/Drupal/Core/Datetime/Entity/DateFormat.php
  5. 11.x core/modules/config_translation/src/FormElement/DateFormat.php
  6. 11.x core/lib/Drupal/Core/Datetime/Entity/DateFormat.php

Namespace

Drupal\config_translation\FormElement

File

core/modules/config_translation/src/FormElement/DateFormat.php

View source
<?php

namespace Drupal\config_translation\FormElement;

use Drupal\Core\Language\LanguageInterface;

/**
 * Defines the date format element for the configuration translation interface.
 */
class DateFormat extends FormElementBase {
    
    /**
     * {@inheritdoc}
     */
    public function getTranslationElement(LanguageInterface $translation_language, $source_config, $translation_config) {
        
        /** @var \Drupal\Core\Datetime\DateFormatterInterface $date_formatter */
        $date_formatter = \Drupal::service('date.formatter');
        $description = $this->t('A user-defined date format. See the <a href="https://www.php.net/manual/datetime.format.php#refsect1-datetime.format-parameters">PHP manual</a> for available options.');
        $format = $this->t('Displayed as %date_format', [
            '%date_format' => $date_formatter->format(REQUEST_TIME, 'custom', $translation_config),
        ]);
        return [
            '#type' => 'textfield',
            '#description' => $description,
            '#field_suffix' => ' <small data-drupal-date-formatter="preview">' . $format . '</small>',
            '#attributes' => [
                'data-drupal-date-formatter' => 'source',
            ],
            '#attached' => [
                'drupalSettings' => [
                    'dateFormats' => $date_formatter->getSampleDateFormats($translation_language->getId()),
                ],
                'library' => [
                    'system/drupal.system.date',
                ],
            ],
        ] + parent::getTranslationElement($translation_language, $source_config, $translation_config);
    }

}

Classes

Title Deprecated Summary
DateFormat Defines the date format element for the configuration translation interface.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.