class DateTimeDayDefaultFormatter in Date time day 8

Plugin implementation of the 'Default' formatter for 'datetimeday' fields.

This formatter renders the data time day using <time> elements, with configurable date formats (from the list of configured formats) and separators.

Plugin annotation


@FieldFormatter(
  id = "datetimeday_default",
  label = @Translation("Default"),
  field_types = {
    "datetimeday"
  }
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
    class \Drupal\Core\Field\FormatterBase implements FormatterInterface, ContainerFactoryPluginInterface
    class \Drupal\datetime\Plugin\Field\FieldFormatter\DateTimeFormatterBase implements ContainerFactoryPluginInterface
    class \Drupal\datetime\Plugin\Field\FieldFormatter\DateTimeDefaultFormatter
    class \Drupal\date_time_day\Plugin\Field\FieldFormatter\DateTimeDayDefaultFormatter uses DateTimeDayTrait

Expanded class hierarchy of DateTimeDayDefaultFormatter

File

src/Plugin/Field/FieldFormatter/DateTimeDayDefaultFormatter.php, line 26

Namespace

Drupal\date_time_day\Plugin\Field\FieldFormatter

View source

class DateTimeDayDefaultFormatter extends DateTimeDefaultFormatter {
  use DateTimeDayTrait;

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    $default_settings = [
      'day_separator' => ',',
      'time_separator' => '-',
      'time_format_type' => 'html_time',
    ] + parent::defaultSettings();

    // Override format type with our custom value.
    $default_settings['format_type'] = 'html_date';
    return $default_settings;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $form = parent::settingsForm($form, $form_state);
    $form['format_type']['#title'] = $this
      ->t('Day format');
    $form['format_type']['#description'] = $this
      ->t("Choose a format for displaying the day. Be sure to set a format appropriate for the field, i.e. omitting time for a field that only has a date.");
    $form['time_format_type'] = [
      '#type' => 'select',
      '#title' => t('Time format'),
      '#description' => t("Choose a format for displaying the time. Be sure to set a format appropriate for the field, i.e. omitting date for a field that only has a time."),
      '#options' => $form['format_type']['#options'],
      '#default_value' => $this
        ->getSetting('time_format_type'),
    ];
    $form['day_separator'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Day separator'),
      '#description' => $this
        ->t('The string to separate the day and start, end times'),
      '#default_value' => $this
        ->getSetting('day_separator'),
    ];
    $form['time_separator'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Time separator'),
      '#description' => $this
        ->t('The string to separate start, end times'),
      '#default_value' => $this
        ->getSetting('time_separator'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    if ($override = $this
      ->getSetting('timezone_override')) {
      $summary[] = $this
        ->t('Time zone: @timezone', [
        '@timezone' => $override,
      ]);
    }
    $date = new DrupalDateTime();
    $summary[] = t('Day format: @display', [
      '@display' => $this
        ->formatDate($date),
    ]);
    $summary[] = t('Time format: @display', [
      '@display' => $this
        ->formatTime($date),
    ]);
    if ($day_separator = $this
      ->getSetting('day_separator')) {
      $summary[] = $this
        ->t('Day separator: %day_separator', [
        '%day_separator' => $day_separator,
      ]);
    }
    if ($time_separator = $this
      ->getSetting('time_separator')) {
      $summary[] = $this
        ->t('Time separator: %time_separator', [
        '%time_separator' => $time_separator,
      ]);
    }
    return $summary;
  }

  /**
   * Formats the date to time format.
   *
   * @param \Drupal\Core\Datetime\DrupalDateTime $date
   *   The date to format to time.
   *
   * @return string
   *   The formatted time string.
   */
  protected function formatTime(DrupalDateTime $date) {
    $format_type = $this
      ->getSetting('time_format_type');
    $timezone = $this
      ->getSetting('timezone_override') ?: $date
      ->getTimezone()
      ->getName();
    return $this->dateFormatter
      ->format($date
      ->getTimestamp(), $format_type, '', $timezone != '' ? $timezone : NULL);
  }

  /**
   * Creates a render array from a date object with time attribute.
   *
   * @param \Drupal\Core\Datetime\DrupalDateTime $dateTime
   *   A date object.
   *
   * @return array
   *   A render array.
   */
  protected function buildTimeWithAttribute(DrupalDateTime $dateTime) {
    $build = [
      '#theme' => 'time',
      '#text' => $this
        ->formatTime($dateTime),
      '#html' => FALSE,
      '#attributes' => [
        'time' => $this
          ->formatTime($dateTime),
      ],
      '#cache' => [
        'contexts' => [
          'timezone',
        ],
      ],
    ];
    return $build;
  }

  /**
   * {@inheritdoc}
   */
  protected function buildDateWithIsoAttribute(DrupalDateTime $date) {
    if ($this
      ->getFieldSetting('datetime_type') == DateTimeItem::DATETIME_TYPE_DATE) {

      // A date without time will pick up the current time, use the default.
      $date
        ->setDefaultDateTime();
    }

    // Create the ISO date in Universal Time.
    $iso_date = $date
      ->format("Y-m-d\\TH:i:s") . 'Z';
    $this
      ->setTimeZone($date);
    $build = [
      '#theme' => 'time',
      '#text' => $this
        ->formatDate($date),
      '#html' => FALSE,
      '#attributes' => [
        'datetime' => $iso_date,
      ],
      '#cache' => [
        'contexts' => [
          'timezone',
        ],
      ],
    ];
    return $build;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DateTimeDayDefaultFormatter::buildDateWithIsoAttribute	protected	function	Creates a render array from a date object with ISO date attribute. Overrides DateTimeFormatterBase::buildDateWithIsoAttribute
DateTimeDayDefaultFormatter::buildTimeWithAttribute	protected	function	Creates a render array from a date object with time attribute.
DateTimeDayDefaultFormatter::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides DateTimeDefaultFormatter::defaultSettings
DateTimeDayDefaultFormatter::formatTime	protected	function	Formats the date to time format.
DateTimeDayDefaultFormatter::settingsForm	public	function	Returns a form to configure settings for the formatter. Overrides DateTimeDefaultFormatter::settingsForm
DateTimeDayDefaultFormatter::settingsSummary	public	function	Returns a short summary for the current formatter settings. Overrides DateTimeDefaultFormatter::settingsSummary
DateTimeDayTrait::viewElements	public	function
DateTimeDefaultFormatter::formatDate	protected	function	Creates a formatted date value as a string. Overrides DateTimeFormatterBase::formatDate
DateTimeFormatterBase::$dateFormatStorage	protected	property	The date format entity storage.
DateTimeFormatterBase::$dateFormatter	protected	property	The date formatter service.
DateTimeFormatterBase::buildDate	protected	function	Creates a render array from a date object.
DateTimeFormatterBase::create	public static	function	Creates an instance of the plugin. Overrides FormatterBase::create
DateTimeFormatterBase::getFormatSettings	protected	function	Gets a settings array suitable for DrupalDateTime::format().
DateTimeFormatterBase::setTimeZone	protected	function	Sets the proper time zone on a DrupalDateTime object for the current user.
DateTimeFormatterBase::__construct	public	function	Constructs a new DateTimeDefaultFormatter. 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.

You are here