You are here

Home » API reference » AP Style Date 8 » ApStyleDateRangeFieldFormatter.php

class ApStyleDateRangeFieldFormatter in AP Style Date 8

Plugin implementation of the 'timestamp' formatter as time ago.

Plugin annotation


@FieldFormatter(
  id = "daterange_ap_style",
  label = @Translation("AP Style"),
  field_types = {
    "daterange"
  }
)

Hierarchy

Expanded class hierarchy of ApStyleDateRangeFieldFormatter

File

src/Plugin/Field/FieldFormatter/ApStyleDateRangeFieldFormatter.php, line 25

Namespace

Drupal\date_ap_style\Plugin\Field\FieldFormatter
View source 
class ApStyleDateRangeFieldFormatter extends FormatterBase implements ContainerFactoryPluginInterface {
  use DateTimeRangeTrait;

  /**
   * The date formatter.
   *
   * @var \Drupal\date_ap_style\ApStyleDateFormatter
   */
  protected $apStyleDateFormatter;

  /**
   * Constructs a TimestampAgoFormatter object.
   *
   * @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
   *   Any third party settings.
   * @param \Drupal\date_ap_style\ApStyleDateFormatter $date_formatter
   *   The date formatter.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, ApStyleDateFormatter $date_formatter) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
    $this->apStyleDateFormatter = $date_formatter;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {

    // @see \Drupal\Core\Field\FormatterPluginManager::createInstance().
    return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['label'], $configuration['view_mode'], $configuration['third_party_settings'], $container
      ->get('date_ap_style.formatter'));
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    $config = \Drupal::config('date_ap_style.dateapstylesettings');
    $base_defaults = [
      'always_display_year' => $config
        ->get('always_display_year'),
      'display_day' => $config
        ->get('display_day'),
      'use_today' => $config
        ->get('use_today'),
      'cap_today' => $config
        ->get('cap_today'),
      'display_time' => $config
        ->get('display_time'),
      'time_before_date' => $config
        ->get('time_before_date'),
      'use_all_day' => $config
        ->get('use_all_day'),
      'display_noon_and_midnight' => $config
        ->get('display_noon_and_midnight'),
      'capitalize_noon_and_midnight' => $config
        ->get('capitalize_noon_and_midnight'),
      'timezone' => $config
        ->get('timezone'),
      'separator' => $config
        ->get('separator'),
    ];
    return $base_defaults + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $elements = parent::settingsForm($form, $form_state);
    $elements['always_display_year'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Always display year'),
      '#description' => $this
        ->t('When unchecked, the year will not be displayed if the date is in the same year as the current date.'),
      '#default_value' => $this
        ->getSetting('always_display_year'),
    ];
    $elements['use_today'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Use today'),
      '#default_value' => $this
        ->getSetting('use_today'),
    ];
    $elements['cap_today'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Capitalize today'),
      '#default_value' => $this
        ->getSetting('cap_today'),
    ];
    $elements['display_time'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Display time'),
      '#default_value' => $this
        ->getSetting('display_time'),
    ];
    $elements['time_before_date'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Display time before date'),
      '#description' => $this
        ->t('When checked, the time will be displayed before the date. Otherwise it will be displayed after the date.'),
      '#default_value' => $this
        ->getSetting('time_before_date'),
      '#states' => [
        'visible' => [
          ':input[name$="[settings][display_time]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $elements['use_all_day'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Show "All Day" instead of midnight'),
      '#default_value' => $this
        ->getSetting('use_all_day'),
      '#states' => [
        'visible' => [
          ':input[name$="[settings][display_time]"]' => [
            'checked' => TRUE,
          ],
        ],
        'unchecked' => [
          ':input[name$="[settings][display_noon_and_midnight]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $elements['display_noon_and_midnight'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Display noon and midnight'),
      '#default_value' => $this
        ->getSetting('display_noon_and_midnight'),
      '#description' => $this
        ->t('Converts 12:00 p.m. to "noon" and 12:00 a.m. to "midnight".'),
      '#states' => [
        'visible' => [
          ':input[name$="[settings][display_time]"]' => [
            'checked' => TRUE,
          ],
        ],
        'unchecked' => [
          ':input[name$="[settings][use_all_day]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $elements['capitalize_noon_and_midnight'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Capitalize noon and midnight'),
      '#default_value' => $this
        ->getSetting('capitalize_noon_and_midnight'),
      '#states' => [
        'visible' => [
          ':input[name$="[settings][display_time]"]' => [
            'checked' => TRUE,
          ],
          ':input[name$="[settings][display_noon_and_midnight]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $elements['separator'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Date range separator'),
      '#options' => [
        'endash' => $this
          ->t('En dash'),
        'to' => $this
          ->t('to'),
      ],
      '#default_value' => $this
        ->getSetting('separator'),
    ];
    $elements['timezone'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Time zone'),
      '#options' => [
        '' => $this
          ->t('- Default site/user time zone -'),
      ] + system_time_zones(FALSE),
      '#default_value' => $this
        ->getSetting('timezone'),
    ];
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = parent::settingsSummary();
    if ($this
      ->getSetting('always_display_year')) {
      $summary[] = $this
        ->t('Always displaying year');
    }
    if ($this
      ->getSetting('display_day')) {
      $summary[] = $this
        ->t('Displaying day of the week');
    }
    if ($this
      ->getSetting('use_today')) {
      $today = '';
      if ($this
        ->getSetting('cap_today')) {
        $today = ' (capitalized)';
      }
      $summary[] = $this
        ->t('Displaying today@today', [
        '@today' => $today,
      ]);
    }
    if ($this
      ->getSetting('display_time')) {
      $display_time = $this
        ->t('Displaying time');
      if ($this
        ->getSetting('time_before_date')) {
        $display_time .= ' (before date)';
      }
      else {
        $display_time .= ' (after date)';
      }
      $summary[] = $display_time;
      if ($this
        ->getSetting('use_all_day')) {
        $summary[] = 'Show "All Day" instead of midnight';
      }
      elseif ($this
        ->getSetting('display_noon_and_midnight')) {
        $noon_and_midnight = '';
        if ($this
          ->getSetting('capitalize_noon_and_midnight')) {
          $noon_and_midnight = ' (capitalized)';
        }
        $summary[] = $this
          ->t('Displaying noon and midnight@noon_and_midnight', [
          '@noon_and_midnight' => $noon_and_midnight,
        ]);
      }
    }
    if ($this
      ->getSetting('separator') == 'endash') {
      $summary[] = $this
        ->t('Using en dash date range separator');
    }
    else {
      $summary[] = $this
        ->t('Using "to" date range separator');
    }
    if ($timezone = $this
      ->getSetting('timezone')) {
      $summary[] = $this
        ->t('Time zone: @timezone', [
        '@timezone' => $timezone,
      ]);
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    $opts = [
      'always_display_year',
      'display_day',
      'use_today',
      'cap_today',
      'display_time',
      'time_before_date',
      'use_all_day',
      'display_noon_and_midnight',
      'capitalize_noon_and_midnight',
    ];
    $options = [];
    foreach ($opts as $opt) {
      if ($this
        ->getSetting($opt)) {
        $options[$opt] = TRUE;
      }
    }
    $timezone = $this
      ->getSetting('timezone') ?: NULL;
    foreach ($items as $delta => $item) {
      if (!empty($item->start_date) && !empty($item->end_date)) {

        /** @var \Drupal\Core\Datetime\DrupalDateTime $start_date */
        $start_date = $item->start_date;

        /** @var \Drupal\Core\Datetime\DrupalDateTime $end_date */
        $end_date = $item->end_date;
        $dates['start'] = $start_date
          ->getTimestamp();
        $dates['end'] = $end_date
          ->getTimestamp();
        $elements[$delta] = [
          '#cache' => [
            'contexts' => [
              'timezone',
            ],
          ],
          '#markup' => $this->apStyleDateFormatter
            ->formatRange($dates, $options, $timezone, $langcode),
        ];
      }
    }
    return $elements;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ApStyleDateRangeFieldFormatter::$apStyleDateFormatter protected property The date formatter.
ApStyleDateRangeFieldFormatter::create public static function Creates an instance of the plugin. Overrides FormatterBase::create
ApStyleDateRangeFieldFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
ApStyleDateRangeFieldFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
ApStyleDateRangeFieldFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
ApStyleDateRangeFieldFormatter::viewElements public function Builds a renderable array for a field value. Overrides DateTimeRangeTrait::viewElements
ApStyleDateRangeFieldFormatter::__construct public function Constructs a TimestampAgoFormatter object. Overrides FormatterBase::__construct
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
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.