EventDate.php in Open Social 8.9

Namespace

Drupal\social_event\Plugin\views\filter

File

modules/social_features/social_event/src/Plugin/views/filter/EventDate.php

<?php

namespace Drupal\social_event\Plugin\views\filter;

use Drupal\datetime\Plugin\Field\FieldType\DateTimeItemInterface;
use Drupal\views\Plugin\views\display\DisplayPluginBase;
use Drupal\views\Plugin\views\filter\InOperator;
use Drupal\views\ViewExecutable;
use Drupal\views\Views;

/**
 * Filter events by start date and end date.
 *
 * @ingroup views_filter_handlers
 *
 * @ViewsFilter("social_event_date_filter")
 */
class EventDate extends InOperator {

  /**
   * {@inheritdoc}
   */
  protected $valueFormType = 'radios';

  /**
   * Flag to indicate Upcoming events.
   */
  const UPCOMING_EVENTS = 1;

  /**
   * Flag to indicate Past events.
   */
  const PAST_EVENTS = 2;

  /**
   * {@inheritdoc}
   */
  public function init(ViewExecutable $view, DisplayPluginBase $display, array &$options = NULL) {
    parent::init($view, $display, $options);
    $this->definition['options callback'] = [
      $this,
      'generateOptions',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function query() {
    $value = (int) current($this->value);
    if (empty($value)) {
      return;
    }
    $this
      ->ensureMyTable();
    $now = $this->query
      ->getDateFormat('NOW()', DateTimeItemInterface::DATETIME_STORAGE_FORMAT, TRUE);
    $configuration = [
      'table' => 'node__field_event_date_end',
      'field' => 'entity_id',
      'left_table' => '',
      'left_field' => 'nid',
    ];
    $join = Views::pluginManager('join')
      ->createInstance('standard', $configuration);
    $alias = $this->query
      ->addRelationship($configuration['table'], $join, 'node_field_data');
    $field_end = $this->query
      ->getDateFormat($alias . '.field_event_date_end_value', DateTimeItemInterface::DATETIME_STORAGE_FORMAT, TRUE);
    $field = "{$this->tableAlias}.{$this->realField}";
    $field = $this->query
      ->getDateFormat($field, DateTimeItemInterface::DATETIME_STORAGE_FORMAT, TRUE);
    switch ($value) {
      case self::UPCOMING_EVENTS:
        $this->query
          ->addWhereExpression($this->options['group'], "({$field} >= {$now}) OR ({$field} <= {$now} AND {$field_end} > {$now})");
        break;
      case self::PAST_EVENTS:
        $this->query
          ->addWhereExpression($this->options['group'], "\n        ({$now} >= {$field_end})\n        OR\n        ({$field_end} IS NULL AND {$now} >= {$field})");
        break;
    }
  }

  /**
   * Retrieves the allowed values for the date filter.
   *
   * @return array
   *   An array of allowed values in the form key => label.
   */
  public function generateOptions() {
    return [
      self::UPCOMING_EVENTS => $this
        ->t('Ongoing and upcoming events'),
      self::PAST_EVENTS => $this
        ->t('Past events'),
    ];
  }

}

Classes

Name	Description
EventDate	Filter events by start date and end date.