Issue #3251171 by mandclu, marcvangend, lindsay.wils: Hiding Past Dates (728f4059) · Commits · project / smart_date

modules/smart_date_recur/src/Plugin/Field/FieldFormatter/SmartDateRecurrenceFormatter.php

+149 −105

Original line number	Diff line number	Diff line
		@@ -30,6 +30,13 @@ class SmartDateRecurrenceFormatter extends SmartDateDefaultFormatter {
		use SmartDateTrait;
		use SmartDateRecurTrait;

		/**
		* The formatter configuration.
		*
		* @var array
		*/
		protected $settings = [];

		/**
		* {@inheritdoc}
		*/
		@@ -86,6 +93,8 @@ class SmartDateRecurrenceFormatter extends SmartDateDefaultFormatter {
		'#default_value' => $this->getSetting('current_upcoming'),
		];

		$form['force_chronological']['#description'] = $this->t('Merge together all recurring rule instances and single events, and sort choronologically before subsetting as a single group.');

		return $form;
		}

		@@ -127,10 +136,7 @@ class SmartDateRecurrenceFormatter extends SmartDateDefaultFormatter {
		$elements = [];
		// TODO: intellident switching between retrieval methods
		// Look for a defined format and use it if specified.
		$timezone_override = $this->getSetting('timezone_override') ?: NULL;
		$format_label = $this->getSetting('format');
		$add_classes = $this->getSetting('add_classes');
		$time_wrapper = $this->getSetting('time_wrapper');
		if ($format_label) {
		$format = SmartDateFormat::load($format_label);
		$settings = $format->getOptions();
		@@ -147,6 +153,14 @@ class SmartDateRecurrenceFormatter extends SmartDateDefaultFormatter {
		'allday_label' => $this->getSetting('allday_label'),
		];
		}
		$force_chrono = $this->getSetting('force_chronological') ?: FALSE;
		$settings['timezone_override'] = $this->getSetting('timezone_override') ?: NULL;
		$settings['add_classes'] = $this->getSetting('add_classes');
		$settings['time_wrapper'] = $this->getSetting('time_wrapper');
		$settings['past_display'] = $this->getSetting('past_display');
		$settings['upcoming_display'] = $this->getSetting('upcoming_display');
		$settings['show_next'] = $this->getSetting('show_next');
		$settings['current_upcoming'] = $this->getSetting('current_upcoming');

		// Retrieve any available augmenters.
		$augmenter_sets = ['instances', 'rule'];
		@@ -155,24 +169,24 @@ class SmartDateRecurrenceFormatter extends SmartDateDefaultFormatter {
		if (count($augmenters, COUNT_RECURSIVE) > 2) {
		$this->entity = $items->getEntity();
		}
		$settings['augmenters'] = $augmenters;
		$this->settings = $settings;

		$rrules = [];
		foreach ($items as $delta => $item) {
		$timezone = $item->timezone ? $item->timezone : $timezone_override;
		$timezone = $item->timezone ? $item->timezone : $settings['timezone_override'];
		if (empty($item->value) \|\| empty($item->end_value)) {
		continue;
		}
		if (empty($item->rrule)) {
		// 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]);
		// Save the original delta within the item.
		$item->delta = $delta;
		if (empty($item->rrule) \|\| $force_chrono) {
		if ($force_chrono) {
		$elements[$item->value] = $item;
		}
		if ($time_wrapper) {
		$this->addTimeWrapper($elements[$delta], $item->value, $item->end_value, $timezone);
		}
		if ($augmenters['instances']) {
		$this->augmentOutput($elements[$delta], $augmenters['instances'], $item->value, $item->end_value, $item->timezone, $delta, 'instances');
		else {
		// No rule so include the item directly.
		$elements[$delta] = $this->buildOutput($delta, $item);
		}
		}
		else {
		@@ -185,10 +199,13 @@ class SmartDateRecurrenceFormatter extends SmartDateDefaultFormatter {
		$rrules[$item->rrule]['instances'][] = $item;
		}
		}
		if ($force_chrono) {
		ksort($elements);
		$elements = array_values($elements);
		$next_index = $this->findNextInstance($elements);
		return [$this->subsetInstances($elements, $next_index)];
		}
		foreach ($rrules as $rrid => $rrule_collected) {
		$rrule_output = [
		'#theme' => 'smart_date_recurring_formatter',
		];
		$instances = $rrule_collected['instances'];
		if (empty($instances)) {
		continue;
		@@ -199,17 +216,6 @@ class SmartDateRecurrenceFormatter extends SmartDateDefaultFormatter {
		if (empty($rrule)) {
		continue;
		}
		$rrule_output['#rule_text']['rule'] = $rrule->getTextRule();
		if ($augmenters['rule']) {
		$repeats = $rrule->getRule();
		$start = $instances[0]->getValue();
		// Grab the end value of the last instance.
		$ends = $instances[array_key_last($instances)]->getValue()['end_value'];
		$this->augmentOutput($rrule_output['#rule_text'], $augmenters['rule'], $start['value'], $start['end_value'], $start['timezone'], $delta, 'rule', $repeats, $ends);
		}

		// Get the specified number of past instances.
		$past_display = $this->getSetting('past_display');

		if (in_array($rrule->get('freq')->getString(), ['MINUTELY', 'HOURLY'])) {
		$within_day = TRUE;
		@@ -241,6 +247,43 @@ class SmartDateRecurrenceFormatter extends SmartDateDefaultFormatter {
		$next_index = $this->findNextInstance($instances);
		}

		$rrule_output = $this->subsetInstances($instances, $next_index, $within_day);

		$rrule_output['#rule_text']['rule'] = $rrule->getTextRule();
		if (!empty($augmenters['rule'])) {
		$repeats = $rrule->getRule();
		$start = $instances[0]->getValue();
		// Grab the end value of the last instance.
		$ends = $instances[array_key_last($instances)]->getValue()['end_value'];
		$this->augmentOutput($rrule_output['#rule_text'], $augmenters['rule'], $start['value'], $start['end_value'], $start['timezone'], $delta, 'rule', $repeats, $ends);
		}

		$elements[$delta] = $rrule_output;
		}

		return $elements;
		}

		/**
		* Format the configured number of upcoming and past instances.
		*
		* @param array $instances
		* The values to draw from.
		* @param int $next_index
		* The value from which to calculate.
		* @param bool $within_day
		* Whether or not to format for recurring within a day.
		*
		* @return array
		* The formatted render array.
		*/
		protected function subsetInstances(array $instances, $next_index, $within_day = FALSE) {
		$periods = ['past_display', 'upcoming_display'];
		$period_instances = [];

		// Get the specified number of past instances.
		$past_display = $this->settings['past_display'];

		// Display past instances if set and at least one instances in the past.
		if ($past_display && $next_index) {
		if ($next_index == -1) {
		@@ -250,78 +293,80 @@ class SmartDateRecurrenceFormatter extends SmartDateDefaultFormatter {
		$begin = $next_index - $past_display;
		}
		if ($begin < 0) {
		$past_display += $begin;
		$begin = 0;
		}
		$past_instances = array_slice($instances, $begin, $past_display, TRUE);
		$rrule_output['#past_display'] = [
		'#theme' => 'item_list',
		'#list_type' => 'ul',
		];
		if ($within_day) {
		$items = $this->formatWithinDay($past_instances, $settings);
		}
		else {
		$items = [];
		foreach ($past_instances as $key => $item) {
		$items[$key] = static::formatSmartDate($item->value, $item->end_value, $settings, $item->timezone);
		if ($add_classes) {
		$this->addRangeClasses($items[$key]);
		}
		if ($time_wrapper) {
		$this->addTimeWrapper($items[$key], $item->value, $item->end_value, $item->timezone);
		}
		if ($augmenters['instances']) {
		$this->augmentOutput($items[$key], $augmenters['instances'], $item->value, $item->end_value, $item->timezone, $key, 'instances');
		}
		$period_instances['past_display'] = array_slice($instances, $begin, $past_display, TRUE);
		}

		$upcoming_display = $this->settings['upcoming_display'];
		// Display upcoming instances if set and at least one instance upcoming.
		if ($upcoming_display && $next_index < count($instances) && $next_index != -1) {
		$period_instances['upcoming_display'] = array_slice($instances, $next_index, $upcoming_display, TRUE);
		}
		foreach ($items as $item) {
		$rrule_output['#past_display']['#items'][] = [
		'#children' => $item,
		'#theme' => 'container',

		$rrule_output = [
		'#theme' => 'smart_date_recurring_formatter',
		];

		foreach ($periods as $period) {
		if (empty($period_instances[$period])) {
		continue;
		}
		}
		$upcoming_display = $this->getSetting('upcoming_display');
		// Display upcoming instances if set and at least one instance upcoming.
		if ($upcoming_display && $next_index < count($instances) && $next_index != -1) {
		$upcoming_instances = array_slice($instances, $next_index, $upcoming_display, TRUE);
		$rrule_output['#upcoming_display'] = [
		$rrule_output['#' . $period] = [
		'#theme' => 'item_list',
		'#list_type' => 'ul',
		];
		if ($within_day) {
		$items = $this->formatWithinDay($upcoming_instances, $settings);
		$items = $this->formatWithinDay($period_instances[$period], $settings);
		}
		else {
		$items = [];
		foreach ($upcoming_instances as $key => $item) {
		$items[$key] = static::formatSmartDate($item->value, $item->end_value, $settings, $item->timezone);
		if ($add_classes) {
		$this->addRangeClasses($items[$key]);
		}
		if ($time_wrapper) {
		$this->addTimeWrapper($items[$key], $item->value, $item->end_value, $item->timezone);
		}
		if ($augmenters['instances']) {
		$this->augmentOutput($items[$key], $augmenters['instances'], $item->value, $item->end_value, $item->timezone, $key, 'instances');
		foreach ($period_instances[$period] as $key => $item) {
		// Check for manual key and use, if set.
		$delta = $item->delta ?? $key;
		$items[$delta] = $this->buildOutput($delta, $item);
		}
		}
		}
		foreach ($items as $item) {
		$rrule_output['#upcoming_display']['#items'][] = [
		foreach ($items as $delta => $item) {
		$rrule_output['#' . $period]['#items'][$delta] = [
		'#children' => $item,
		'#theme' => 'container',
		];
		}
		if ($this->getSetting('show_next')) {
		$rrule_output['#next_display'] = array_shift($rrule_output['#upcoming_display']['#items']);
		}
		if ($this->settings['show_next'] && !empty($rrule_output['#upcoming_display']['#items'])) {
		$rrule_output['#next_display'] = array_shift($rrule_output['#upcoming_display']['#items']);
		}
		$elements[$delta] = $rrule_output;
		return $rrule_output;
		}

		return $elements;
		/**
		* Helper function to create and augment formatted output.
		*
		* @param int $key
		* Numeric key of the output delta.
		* @param object $item
		* Field values.
		*
		* @return array
		* Render array of the formatted output.
		*/
		protected function buildOutput($key, $item) {
		if (!$item \|\| empty($item->value)) {
		return [];
		}
		$output = static::formatSmartDate($item->value, $item->end_value, $this->settings, $item->timezone);
		if ($this->settings['add_classes']) {
		$this->addRangeClasses($output);
		}
		if ($this->settings['time_wrapper']) {
		$this->addTimeWrapper($output, $item->value, $item->end_value, $item->timezone);
		}
		if (!empty($this->settings['augmenters']['instances'])) {
		$this->augmentOutput($output, $this->settings['augmenters']['instances'], $item->value, $item->end_value, $item->timezone, $key, 'instances');
		}
		return $output;
		}

		/**
		@@ -330,9 +375,8 @@ class SmartDateRecurrenceFormatter extends SmartDateDefaultFormatter {
		protected function findNextInstance(array $instances) {
		$next_index = -1;
		$time = time();
		$current_upcoming = $this->getSetting('current_upcoming');
		foreach ($instances as $index => $instance) {
		$date_compare = ($current_upcoming) ? $instance->end_value : $instance->value;
		$date_compare = ($this->settings['current_upcoming']) ? $instance->end_value : $instance->value;
		if ($date_compare > $time) {
		$next_index = $index;
		break;

src/Plugin/Field/FieldType/SmartDateItem.php

+7 −0

Original line number	Diff line number	Diff line
		@@ -22,6 +22,13 @@ use Drupal\datetime\DateTimeComputed;
		*/
		class SmartDateItem extends TimestampItem {

		/**
		* The stored field delta.
		*
		* @var int
		*/
		public $delta;

		/**
		* {@inheritdoc}
		*/