You are here

Home » API reference » Commerce Core 8.2 » StoreDateTimeFormatter.php

class StoreDateTimeFormatter in Commerce Core 8.2

Plugin implementation of the 'commerce_store_datetime' formatter.

Used for displaying date/time values in the store timezone, as opposed to the user's timezone.

Plugin annotation


@FieldFormatter(
  id = "commerce_store_datetime",
  label = @Translation("Default (Store timezone)"),
  field_types = {
    "datetime"
  }
)

Hierarchy

Expanded class hierarchy of StoreDateTimeFormatter

See also

\Drupal\commerce_store\Plugin\Field\FieldWidget\StoreDateTimeWidget

File

modules/store/src/Plugin/Field/FieldFormatter/StoreDateTimeFormatter.php, line 33

Namespace

Drupal\commerce_store\Plugin\Field\FieldFormatter
View source 
class StoreDateTimeFormatter extends FormatterBase implements ContainerFactoryPluginInterface {

  /**
   * The current store.
   *
   * @var \Drupal\commerce_store\CurrentStoreInterface
   */
  protected $currentStore;

  /**
   * The date format storage.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $dateFormatStorage;

  /**
   * Constructs a new StoreDateTimeFormatter.
   *
   * @param string $plugin_id
   *   The plugin_id for the formatter.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   *   The definition of the field to which the formatter is associated.
   * @param array $settings
   *   The formatter settings.
   * @param string $label
   *   The formatter label display setting.
   * @param string $view_mode
   *   The view mode.
   * @param array $third_party_settings
   *   Third party settings.
   * @param \Drupal\commerce_store\CurrentStoreInterface $current_store
   *   The current store.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, CurrentStoreInterface $current_store, EntityTypeManagerInterface $entity_type_manager) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
    $this->currentStore = $current_store;
    $this->dateFormatStorage = $entity_type_manager
      ->getStorage('date_format');
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['label'], $configuration['view_mode'], $configuration['third_party_settings'], $container
      ->get('commerce_store.current_store'), $container
      ->get('entity_type.manager'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $form = parent::settingsForm($form, $form_state);
    $date = new DrupalDateTime('now', $this
      ->getTimezone());

    /** @var \Drupal\Core\Datetime\DateFormatInterface[] $date_formats */
    $date_formats = $this->dateFormatStorage
      ->loadMultiple();
    $options = [];
    foreach ($date_formats as $type => $date_format) {
      $example = $date
        ->format($date_format
        ->getPattern());
      $options[$type] = $date_format
        ->label() . ' (' . $example . ')';
    }
    $form['date_format'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Date format'),
      '#description' => $this
        ->t('Choose a format for displaying the date. Be sure to set a format appropriate for the field, i.e. omitting time for a field that only has a date.'),
      '#options' => $options,
      '#default_value' => $this
        ->getSetting('date_format'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = parent::settingsSummary();
    $date_format = $this
      ->getDateFormat();
    $date = new DrupalDateTime('now', $this
      ->getTimezone());

    // Uses the same summary format as DateTimeDefaultFormatter.
    $summary[] = $this
      ->t('Format: @date_format', [
      '@date_format' => $date
        ->format($date_format
        ->getPattern()),
    ]);
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $date_pattern = $this
      ->getDateFormat()
      ->getPattern();
    $timezone = $this
      ->getTimezone();
    $store = $this->currentStore
      ->getStore();
    $elements = [];
    foreach ($items as $delta => $item) {
      if ($item->value) {
        $date = new DrupalDateTime($item->value, $timezone);
        $elements[$delta] = [
          '#theme' => 'time',
          '#text' => $date
            ->format($date_pattern),
          '#html' => FALSE,
          '#attributes' => [
            'datetime' => $date
              ->format('Y-m-d\\TH:i:sP'),
          ],
          '#cache' => [
            'contexts' => [
              'store',
            ],
          ],
        ];
        if ($store) {

          // Make sure the render cache is cleared when the store is updated.
          $cacheability = new CacheableMetadata();
          $cacheability
            ->addCacheableDependency($store);
          $cacheability
            ->applyTo($elements[$delta]);
        }
        if (!empty($item->_attributes)) {
          $elements[$delta]['#attributes'] += $item->_attributes;

          // Unset field item attributes since they have been included in the
          // formatter output and should not be rendered in the field template.
          unset($item->_attributes);
        }
      }
    }
    return $elements;
  }

  /**
   * Gets the configured date format.
   *
   * @return \Drupal\Core\Datetime\DateFormatInterface
   *   The date format.
   */
  protected function getDateFormat() {

    /** @var \Drupal\Core\Datetime\DateFormatInterface $date_format */
    $date_format = $this->dateFormatStorage
      ->load($this
      ->getSetting('date_format'));
    if (!$date_format) {

      // Guard against missing/deleted date formats.
      $date_format = $this->dateFormatStorage
        ->load('fallback');
    }
    return $date_format;
  }

  /**
   * Gets the timezone used for date formatting.
   *
   * This is the timezone of the current store, with a fallback to the
   * site timezone, in case the site doesn't have any stores yet.
   *
   * @return string
   *   The timezone.
   */
  protected function getTimezone() {
    $store = $this->currentStore
      ->getStore();
    if ($store) {
      $timezone = $store
        ->getTimezone();
    }
    else {
      $site_timezone = Store::getSiteTimezone();
      $timezone = reset($site_timezone);
    }
    return $timezone;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormatterBase::$fieldDefinition protected property The field definition.
FormatterBase::$label protected property The label display setting.
FormatterBase::$settings protected property The formatter settings. Overrides PluginSettingsBase::$settings
FormatterBase::$viewMode protected property The view mode.
FormatterBase::getFieldSetting protected function Returns the value of a field setting.
FormatterBase::getFieldSettings protected function Returns the array of field settings.
FormatterBase::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterInterface::isApplicable 14
FormatterBase::prepareView public function Allows formatters to load information for field values being displayed. Overrides FormatterInterface::prepareView 2
FormatterBase::view public function Builds a renderable array for a fully themed field. Overrides FormatterInterface::view 1
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginSettingsBase::$defaultSettingsMerged protected property Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings protected property The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 6
PluginSettingsBase::getSetting public function Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval 3
PluginSettingsBase::setSetting public function Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
StoreDateTimeFormatter::$currentStore protected property The current store.
StoreDateTimeFormatter::$dateFormatStorage protected property The date format storage.
StoreDateTimeFormatter::create public static function Creates an instance of the plugin. Overrides FormatterBase::create
StoreDateTimeFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
StoreDateTimeFormatter::getDateFormat protected function Gets the configured date format.
StoreDateTimeFormatter::getTimezone protected function Gets the timezone used for date formatting.
StoreDateTimeFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
StoreDateTimeFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
StoreDateTimeFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
StoreDateTimeFormatter::__construct public function Constructs a new StoreDateTimeFormatter. Overrides FormatterBase::__construct
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.