public function SmartDateDurationFormatter::viewElements in Smart Date 3.4.x

Same name and namespace in other branches

1. 8.2 src/Plugin/Field/FieldFormatter/SmartDateDurationFormatter.php \Drupal\smart_date\Plugin\Field\FieldFormatter\SmartDateDurationFormatter::viewElements()
2. 3.x src/Plugin/Field/FieldFormatter/SmartDateDurationFormatter.php \Drupal\smart_date\Plugin\Field\FieldFormatter\SmartDateDurationFormatter::viewElements()
3. 3.0.x src/Plugin/Field/FieldFormatter/SmartDateDurationFormatter.php \Drupal\smart_date\Plugin\Field\FieldFormatter\SmartDateDurationFormatter::viewElements()
4. 3.1.x src/Plugin/Field/FieldFormatter/SmartDateDurationFormatter.php \Drupal\smart_date\Plugin\Field\FieldFormatter\SmartDateDurationFormatter::viewElements()
5. 3.2.x src/Plugin/Field/FieldFormatter/SmartDateDurationFormatter.php \Drupal\smart_date\Plugin\Field\FieldFormatter\SmartDateDurationFormatter::viewElements()
6. 3.3.x src/Plugin/Field/FieldFormatter/SmartDateDurationFormatter.php \Drupal\smart_date\Plugin\Field\FieldFormatter\SmartDateDurationFormatter::viewElements()

Overrides SmartDateTrait::viewElements

File

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

Class

SmartDateDurationFormatter

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

Namespace

Drupal\smart_date\Plugin\Field\FieldFormatter

Code

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'),
    ];
  }
  $timezone_override = $this
    ->getSetting('timezone_override') ?: NULL;
  $add_classes = $this
    ->getSetting('add_classes');
  $time_wrapper = $this
    ->getSetting('time_wrapper');

  // Look for the Date Augmenter plugin manager service.
  $augmenters = [];
  if (!empty(\Drupal::hasService('plugin.manager.dateaugmenter'))) {
    $dateAugmenterManager = \Drupal::service('plugin.manager.dateaugmenter');

    // TODO: Support custom entities.
    $config = $this
      ->getThirdPartySettings('date_augmenter');
    $augmenters = $dateAugmenterManager
      ->getActivePlugins($config);
    $entity = $items
      ->getEntity();
  }
  foreach ($items as $delta => $item) {
    if ($field_type == 'smartdate') {
      $timezone = $item->timezone ? $item->timezone : $timezone_override;
      if (empty($item->value) || empty($item->end_value)) {
        continue;
      }
      $start_ts = $item->value;
      $end_ts = $item->end_value;
    }
    elseif ($field_type == 'daterange') {
      $timezone = $timezone_override;
      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, $timezone);
    $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 ($time_wrapper) {
      $this
        ->addTimeWrapper($elements[$delta], $start_ts, $end_ts, $timezone);

      // For the sake of finding differences, "fix" all day events.
      if ($this
        ->isAllDay($start_ts, $end_ts, $timezone)) {
        $adjusted_end = $end_ts + 60;
      }
      else {
        $adjusted_end = $end_ts;
      }
      $diff = \Drupal::service('date.formatter')
        ->formatDiff($start_ts, $adjusted_end, [
        'strict' => FALSE,
        'language' => 'en',
      ]);
      $current_contents = $elements[$delta]['duration'];
      $elements[$delta]['duration'] = [
        '#theme' => 'time',
        '#attributes' => [
          'datetime' => $this
            ->formatDurationTime($diff),
        ],
        '#text' => $current_contents,
      ];
    }
    if ($augmenters) {
      foreach ($augmenters as $augmenter_id => $augmenter) {

        // Use the enabled plugin to manipulate the output.
        $augmenter
          ->augmentOutput($elements[$delta], DrupalDateTime::createFromTimestamp($start_ts), DrupalDateTime::createFromTimestamp($end_ts), [
          'timezone' => $timezone,
          'allday' => static::isAllDay($start_ts, $end_ts, $timezone),
          'entity' => $entity,
          'settings' => $config['settings'][$augmenter_id],
          'delta' => $delta,
          'formatter' => $this,
          'field_name' => $this->fieldDefinition
            ->getName(),
        ]);
      }
    }
    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;
}