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

Same name and namespace in other branches

1. 3.0.x modules/smart_date_recur/src/Plugin/Field/FieldFormatter/SmartDateDailyRangeFormatter.php \Drupal\smart_date_recur\Plugin\Field\FieldFormatter\SmartDateDailyRangeFormatter::viewElements()
2. 3.1.x modules/smart_date_recur/src/Plugin/Field/FieldFormatter/SmartDateDailyRangeFormatter.php \Drupal\smart_date_recur\Plugin\Field\FieldFormatter\SmartDateDailyRangeFormatter::viewElements()
3. 3.2.x modules/smart_date_recur/src/Plugin/Field/FieldFormatter/SmartDateDailyRangeFormatter.php \Drupal\smart_date_recur\Plugin\Field\FieldFormatter\SmartDateDailyRangeFormatter::viewElements()
4. 3.3.x modules/smart_date_recur/src/Plugin/Field/FieldFormatter/SmartDateDailyRangeFormatter.php \Drupal\smart_date_recur\Plugin\Field\FieldFormatter\SmartDateDailyRangeFormatter::viewElements()

Overrides SmartDateTrait::viewElements

File

modules/smart_date_recur/src/Plugin/Field/FieldFormatter/SmartDateDailyRangeFormatter.php, line 54

Class

SmartDateDailyRangeFormatter

Plugin for a recurrence-optimized formatter for 'smartdate' fields.

Namespace

Drupal\smart_date_recur\Plugin\Field\FieldFormatter

Code

public function viewElements(FieldItemListInterface $items, $langcode) {
  $elements = [];

  // TODO: intellident switching between retrieval methods
  // Look for a defined format and use it if specified.
  $format_label = $this
    ->getSetting('format');
  if ($format_label) {
    $format = SmartDateFormat::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'),
      'allday_label' => $this
        ->getSetting('allday_label'),
    ];
  }
  $add_classes = $this
    ->getSetting('add_classes');
  $time_wrapper = $this
    ->getSetting('time_wrapper');
  $rrules = [];
  $rrules_nondaily = [];

  // 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) {
    $timezone = $item->timezone ? $item->timezone : NULL;
    if (empty($item->value) || empty($item->end_value)) {
      continue;
    }
    $is_daily = FALSE;
    if (!empty($item->rrule)) {
      if (isset($rrules[$item->rrule])) {

        // Already established as daily.
        $is_daily = TRUE;
      }
      elseif (isset($rrules_nondaily[$item->rrule])) {

        // Already established as NOT daily, so list as normal.
      }
      else {

        // New rule to process, so load it.
        $rrule_obj = SmartDateRule::load($item->rrule);
        $rule_props = $rrule_obj
          ->toArray();
        $allowed_freq = [
          'HOURLY',
          'MINUTELY',
        ];

        // Check that no extra parameters have been set.
        // TODO: Separate handling for daily ranges with no end?
        // TODO: Check for overrides.
        if ($rule_props['freq']) {
          if ($rule_props['freq'][0]['value'] == 'DAILY' && $rule_props['limit'] && !$rule_props['parameters']) {
            $is_daily = TRUE;
          }
          elseif (in_array($rule_props['freq'][0]['value'], $allowed_freq)) {
            $is_daily = TRUE;
          }
        }
        if ($is_daily) {

          // Uses a daily rule, so render a range instead.
          $is_daily = TRUE;
          $elements[$delta] = $item->rrule;
          $rrules[$item->rrule]['delta'] = $delta;
          $rrules[$item->rrule]['freq'] = $rule_props['freq'][0]['value'];
        }
        else {
          $rrules_nondaily[$item->rrule]['delta'] = $delta;
        }
      }
    }
    if ($is_daily) {

      // Add this instance to our array of instances for the rule.
      $rrules[$item->rrule]['instances'][] = $item;
    }
    else {

      // No rule so include the item directly.
      $elements[$delta] = static::formatSmartDate($item->value, $item->end_value, $settings, $timezone);
      if ($add_classes) {
        $this
          ->addRangeClasses($elements[$delta]);
      }
      if ($time_wrapper) {
        $this
          ->addTimeWrapper($elements[$delta], $item->value, $item->end_value, $timezone);
      }
      if ($augmenters) {
        foreach ($augmenters as $augmenter_id => $augmenter) {

          // Use the enabled plugin to manipulate the output.
          $augmenter
            ->augmentOutput($elements[$delta], DrupalDateTime::createFromTimestamp($item->value), DrupalDateTime::createFromTimestamp($item->end_value), [
            'timezone' => $timezone,
            'allday' => static::isAllDay($item->value, $item->end_value, $timezone),
            'entity' => $entity,
            'settings' => $config['settings'][$augmenter_id],
            'delta' => $delta,
            'formatter' => $this,
            'field_name' => $this->fieldDefinition
              ->getName(),
          ]);
        }
      }
    }
  }
  foreach ($rrules as $rrule_collected) {
    $instances = $rrule_collected['instances'];
    if (empty($instances)) {
      continue;
    }
    $settings_notime = $this
      ->settingsFormatNoTime($settings);
    $settings_nodate = $this
      ->settingsFormatNoDate($settings);
    switch ($rrule_collected['freq']) {
      case 'DAILY':
        $first_date = array_shift($instances);
        $last_date = array_pop($instances);
        $output['time'] = static::formatSmartDate($first_date->value, $first_date->end_value, $settings_notime, $timezone);
        $output['join'] = [
          '#markup' => $settings['join'],
        ];
        $output['date'] = static::formatSmartDate($first_date->value, $last_date->end_value, $settings_nodate, $timezone);
        $output['#attributes']['class'] = [
          'smart-date--range',
        ];
        $output = $this
          ->massageForOutput($output, $settings, $add_classes);
        break;
      case 'HOURLY':
      case 'MINUTELY':

        // For recurrences within a day, display in a succinct format.
        $output = [];
        $times = [];

        // Group instances into days.
        foreach ($instances as $instance) {
          $this_formatted_date = static::formatSmartDate($instance->value, $instance->end_value, $settings_notime, $timezone, 'string');
          $times[$this_formatted_date][] = $instance;
        }
        $output = $this
          ->formatWithinDay($times, $settings, $timezone);
        break;
    }
    $delta = $rrule_collected['delta'];
    $elements[$delta] = $output;
  }
  return $elements;
}