class SmartDateDurationFormatter in Smart Date 3.1.x

Plugin implementation of a duration-based formatter for 'smartdate' fields.

This formatter renders the start time range using <time> elements, with the duration, using core's formatInterval functionality.

Plugin annotation

@FieldFormatter(
  id = "smartdate_duration",
  label = @Translation("Smart Date with Duration"),
  field_types = {
    "smartdate",
    "daterange"
  }
)

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
          • class \Drupal\datetime\Plugin\Field\FieldFormatter\DateTimeDefaultFormatter
            • class \Drupal\smart_date\Plugin\Field\FieldFormatter\SmartDateDefaultFormatter uses SmartDateTrait
              • class \Drupal\smart_date\Plugin\Field\FieldFormatter\SmartDateDurationFormatter uses SmartDateTrait

File

src/Plugin/Field/FieldFormatter/SmartDateDurationFormatter.php, line 24

Namespace

Drupal\smart_date\Plugin\Field\FieldFormatter

class SmartDateDurationFormatter extends SmartDateDefaultFormatter {
  use SmartDateTrait;

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

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {

    // Use the upstream settings form, which gives us a control to override the
    // timezone.
    $form = parent::settingsForm($form, $form_state);

    // Ask the user to choose a Smart Date Format.
    $smartDateFormatOptions = $this
      ->getAvailableSmartDateFormatOptions();
    $form['duration_separator'] = [
      '#type' => 'text',
      '#title' => $this
        ->t('Duration Separator'),
      '#description' => $this
        ->t('Choose which display configuration to use.'),
      '#default_value' => $this
        ->getSetting('duration_separator'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary[] = $this
      ->getSetting('timezone_override') === '' ? t('No timezone override.') : t('Timezone overridden to %timezone.', [
      '%timezone' => $this
        ->getSetting('timezone_override'),
    ]);
    $summary[] = t('Smart date format: %format.', [
      '%format' => $this
        ->getSetting('format'),
    ]);
    $summary[] = t('Duration separator: %duration_separator.', [
      '%duration_separator' => $this
        ->getSetting('duration_separator'),
    ]);
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $field_type = $this->fieldDefinition
      ->getType();
    $elements = [];

    // TODO: intelligent switching between retrieval methods.
    // Look for a defined format and use it if specified.
    $format_label = $this
      ->getSetting('format');
    if ($format_label) {
      $entity_storage_manager = \Drupal::entityTypeManager()
        ->getStorage('smart_date_format');
      $format = $entity_storage_manager
        ->load($format_label);
      $settings = $format
        ->getOptions();
    }
    else {
      $settings = [
        'separator' => $this
          ->getSetting('separator'),
        'join' => $this
          ->getSetting('join'),
        'time_format' => $this
          ->getSetting('time_format'),
        'time_hour_format' => $this
          ->getSetting('time_hour_format'),
        'date_format' => $this
          ->getSetting('date_format'),
        'date_first' => $this
          ->getSetting('date_first'),
        'ampm_reduce' => $this
          ->getSetting('ampm_reduce'),
        'site_time_toggle' => $this
          ->getSetting('site_time_toggle'),
        'allday_label' => $this
          ->getSetting('allday_label'),
      ];
    }
    $add_classes = $this
      ->getSetting('add_classes');
    foreach ($items as $delta => $item) {
      if ($field_type == 'smartdate') {
        if (empty($item->value) || empty($item->end_value)) {
          continue;
        }
        $start_ts = $item->value;
        $end_ts = $item->end_value;
      }
      elseif ($field_type == 'daterange') {
        if (empty($item->start_date) || empty($item->end_date)) {
          continue;
        }
        $start_ts = $item->start_date
          ->getTimestamp();
        $end_ts = $item->end_date
          ->getTimestamp();
      }
      else {

        // Not sure how to handle anything else, so return an empty set.
        return $elements;
      }
      $elements[$delta] = static::formatSmartDate($start_ts, $start_ts, $settings);
      $elements[$delta]['spacer'] = [
        '#markup' => $this
          ->getSetting('duration_separator'),
      ];

      // TODO: Include timezone in isAllDay check.
      if (static::isAllDay($start_ts, $end_ts)) {
        $duration_output = $settings['allday_label'];
        unset($elements[$delta]['start']['time']);
        unset($elements[$delta]['start']['join']);
      }
      else {
        $duration_output = \Drupal::service('date.formatter')
          ->formatDiff($start_ts, $end_ts);
      }
      $elements[$delta]['duration'] = [
        '#markup' => $duration_output,
      ];
      if ($add_classes) {
        if ($elements[$delta]['start'] && $elements[$delta]['start']['date']) {
          $elements[$delta]['start']['date']['#prefix'] = '<span class="smart-date--date">';
          $elements[$delta]['start']['date']['#suffix'] = '</span>';
        }
        if ($elements[$delta]['start'] && $elements[$delta]['start']['time']) {
          $elements[$delta]['start']['time']['#prefix'] = '<span class="smart-date--time">';
          $elements[$delta]['start']['time']['#suffix'] = '</span>';
        }
        if ($elements[$delta]['start'] && $elements[$delta]['duration']) {
          $elements[$delta]['duration']['#prefix'] = '<span class="smart-date--duration">';
          $elements[$delta]['duration']['#suffix'] = '</span>';
        }
      }
      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;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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::buildDateWithIsoAttribute	protected	function	Creates a render array from a date object with ISO date attribute.
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
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
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.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
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	2
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
SmartDateDefaultFormatter::getAvailableSmartDateFormatOptions	protected	function	Get an array of available Smart Date format options.
SmartDateDurationFormatter::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides SmartDateDefaultFormatter::defaultSettings
SmartDateDurationFormatter::settingsForm	public	function	Returns a form to configure settings for the formatter. Overrides SmartDateDefaultFormatter::settingsForm
SmartDateDurationFormatter::settingsSummary	public	function	Returns a short summary for the current formatter settings. Overrides SmartDateDefaultFormatter::settingsSummary
SmartDateDurationFormatter::viewElements	public	function	Overrides SmartDateTrait::viewElements
SmartDateTrait::addRangeClasses	private	function
SmartDateTrait::arrayToRender	private static	function	Helper function to turn a simple, nested array into a render array.
SmartDateTrait::formatSmartDate	public static	function	Creates a formatted date value as a string.
SmartDateTrait::isAllDay	public static	function	Evaluates whether or not a provided range is "all day".
SmartDateTrait::loadSmartDateFormat	public static	function	Load a Smart Date Format from a format name.
SmartDateTrait::rangeDateReduce	private static	function	Reduce duplication in a provided date range.
SmartDateTrait::rangeFormat	private static	function	Format a provided range, using provided settings.
SmartDateTrait::settingsFormatNoDate	public static	function	Removes date tokens from format settings.
SmartDateTrait::settingsFormatNoTime	public static	function	Removes time tokens from format settings.
SmartDateTrait::settingsFormatNoTz	public static	function	Removes timezone tokens from time settings.
SmartDateTrait::timeFormat	private static	function	Helper function to apply time formats.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
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.