From 24219febf31ec4af894cb98093403419c01b5789 Mon Sep 17 00:00:00 2001
From: Alex Pott <alex.a.pott@googlemail.com>
Date: Tue, 14 Jul 2015 11:03:11 +0100
Subject: [PATCH] =?UTF-8?q?Issue=20#1838242=20by=20jhedstrom,=20pivica,=20?=
=?UTF-8?q?tim.plunkett,=20bojanz,=20Ga=C3=ABlG,=20mpdonadio,=20dawehner,?=
=?UTF-8?q?=20olli,=20Lendude:=20Provide=20Views=20integration=20for=20dat?=
=?UTF-8?q?etime=20field?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
core/modules/datetime/datetime.views.inc | 49 +++++
.../src/Plugin/views/argument/Date.php | 45 ++++
.../src/Plugin/views/argument/DayDate.php | 22 ++
.../src/Plugin/views/argument/MonthDate.php | 22 ++
.../src/Plugin/views/argument/YearDate.php | 22 ++
.../datetime/src/Plugin/views/filter/Date.php | 131 ++++++++++++
.../datetime/src/Plugin/views/sort/Date.php | 56 +++++
.../src/Tests/Views/ArgumentDateTimeTest.php | 141 +++++++++++++
.../Tests/Views/DateTimeHandlerTestBase.php | 78 +++++++
.../src/Tests/Views/FilterDateTest.php | 115 +++++++++++
.../src/Tests/Views/FilterDateTimeTest.php | 195 ++++++++++++++++++
.../src/Tests/Views/SortDateTimeTest.php | 99 +++++++++
.../datetime_test/datetime_test.info.yml | 8 +
.../views.view.test_argument_datetime.yml | 99 +++++++++
.../views.view.test_filter_datetime.yml | 56 +++++
.../views.view.test_sort_datetime.yml | 57 +++++
.../Plugin/views/query/QueryPluginBase.php | 5 +-
.../views/src/Plugin/views/query/Sql.php | 19 +-
18 files changed, 1213 insertions(+), 6 deletions(-)
create mode 100644 core/modules/datetime/datetime.views.inc
create mode 100644 core/modules/datetime/src/Plugin/views/argument/Date.php
create mode 100644 core/modules/datetime/src/Plugin/views/argument/DayDate.php
create mode 100644 core/modules/datetime/src/Plugin/views/argument/MonthDate.php
create mode 100644 core/modules/datetime/src/Plugin/views/argument/YearDate.php
create mode 100644 core/modules/datetime/src/Plugin/views/filter/Date.php
create mode 100644 core/modules/datetime/src/Plugin/views/sort/Date.php
create mode 100644 core/modules/datetime/src/Tests/Views/ArgumentDateTimeTest.php
create mode 100644 core/modules/datetime/src/Tests/Views/DateTimeHandlerTestBase.php
create mode 100644 core/modules/datetime/src/Tests/Views/FilterDateTest.php
create mode 100644 core/modules/datetime/src/Tests/Views/FilterDateTimeTest.php
create mode 100644 core/modules/datetime/src/Tests/Views/SortDateTimeTest.php
create mode 100644 core/modules/datetime/tests/modules/datetime_test/datetime_test.info.yml
create mode 100644 core/modules/datetime/tests/modules/datetime_test/test_views/views.view.test_argument_datetime.yml
create mode 100644 core/modules/datetime/tests/modules/datetime_test/test_views/views.view.test_filter_datetime.yml
create mode 100644 core/modules/datetime/tests/modules/datetime_test/test_views/views.view.test_sort_datetime.yml
diff --git a/core/modules/datetime/datetime.views.inc b/core/modules/datetime/datetime.views.inc
new file mode 100644
index 000000000000..c12a3aca42a8
--- /dev/null
+++ b/core/modules/datetime/datetime.views.inc
@@ -0,0 +1,49 @@
+<?php
+
+/**
+ * @file
+ * Provides views data for the datetime module.
+ */
+
+use Drupal\field\FieldStorageConfigInterface;
+
+/**
+ * Implements hook_field_views_data().
+ */
+function datetime_field_views_data(FieldStorageConfigInterface $field_storage) {
+ // @todo This code only covers configurable fields, handle base table fields
+ // in https://www.drupal.org/node/2489476.
+ $data = views_field_default_views_data($field_storage);
+ foreach ($data as $table_name => $table_data) {
+ // Set the 'datetime' filter type.
+ $data[$table_name][$field_storage->getName() . '_value']['filter']['id'] = 'datetime';
+
+ // Set the 'datetime' argument type.
+ $data[$table_name][$field_storage->getName() . '_value']['argument']['id'] = 'datetime';
+
+ // Create year, month, and day arguments.
+ $group = $data[$table_name][$field_storage->getName() . '_value']['group'];
+ $arguments = [
+ // Argument type => help text.
+ 'year' => t('Date in the form of YYYY.'),
+ 'month' => t('Date in the form of MM.'),
+ 'day' => t('Date in the form of DD.'),
+ ];
+ foreach ($arguments as $argument_type => $help_text) {
+ $data[$table_name][$field_storage->getName() . '_value_' . $argument_type] = [
+ 'title' => $field_storage->getLabel() . ' (' . $argument_type . ')',
+ 'help' => $help_text,
+ 'argument' => [
+ 'field' => $field_storage->getName() . '_value',
+ 'id' => 'datetime_' . $argument_type,
+ ],
+ 'group' => $group,
+ ];
+ }
+
+ // Set the 'datetime' sort handler.
+ $data[$table_name][$field_storage->getName() . '_value']['sort']['id'] = 'datetime';
+ }
+
+ return $data;
+}
diff --git a/core/modules/datetime/src/Plugin/views/argument/Date.php b/core/modules/datetime/src/Plugin/views/argument/Date.php
new file mode 100644
index 000000000000..7bd5cdf337dd
--- /dev/null
+++ b/core/modules/datetime/src/Plugin/views/argument/Date.php
@@ -0,0 +1,45 @@
+<?php
+
+/**
+ * @file
+ * Contains \Drupal\datetime\Plugin\views\Argument\Date.
+ */
+
+namespace Drupal\datetime\Plugin\views\Argument;
+
+use Drupal\views\Plugin\views\argument\Date as NumericDate;
+
+/**
+ * Abstract argument handler for dates.
+ *
+ * Adds an option to set a default argument based on the current date.
+ *
+ * Definitions terms:
+ * - many to one: If true, the "many to one" helper will be used.
+ * - invalid input: A string to give to the user for obviously invalid input.
+ * This is deprecated in favor of argument validators.
+ *
+ * @see \Drupal\views\ManyTonOneHelper
+ *
+ * @ingroup views_argument_handlers
+ *
+ * @ViewsArgument("datetime")
+ */
+class Date extends NumericDate {
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getDateField() {
+ // Return the real field, since it is already in string format.
+ return "$this->tableAlias.$this->realField";
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getDateFormat($format) {
+ // Pass in the string-field option.
+ return $this->query->getDateFormat($this->getDateField(), $format, TRUE);
+ }
+}
diff --git a/core/modules/datetime/src/Plugin/views/argument/DayDate.php b/core/modules/datetime/src/Plugin/views/argument/DayDate.php
new file mode 100644
index 000000000000..f100db044b89
--- /dev/null
+++ b/core/modules/datetime/src/Plugin/views/argument/DayDate.php
@@ -0,0 +1,22 @@
+<?php
+
+/**
+ * @file
+ * Contains \Drupal\datetime\Plugin\views\argument\DayDate.
+ */
+
+namespace Drupal\datetime\Plugin\views\argument;
+
+/**
+ * Argument handler for a day.
+ *
+ * @ViewsArgument("datetime_day")
+ */
+class DayDate extends Date {
+
+ /**
+ * {@inheritdoc}
+ */
+ protected $argFormat = 'd';
+
+}
diff --git a/core/modules/datetime/src/Plugin/views/argument/MonthDate.php b/core/modules/datetime/src/Plugin/views/argument/MonthDate.php
new file mode 100644
index 000000000000..2aac64dafee6
--- /dev/null
+++ b/core/modules/datetime/src/Plugin/views/argument/MonthDate.php
@@ -0,0 +1,22 @@
+<?php
+
+/**
+ * @file
+ * Contains \Drupal\datetime\Plugin\views\argument\MonthDate.
+ */
+
+namespace Drupal\datetime\Plugin\views\argument;
+
+/**
+ * Argument handler for a month.
+ *
+ * @ViewsArgument("datetime_month")
+ */
+class MonthDate extends Date {
+
+ /**
+ * {@inheritdoc}
+ */
+ protected $argFormat = 'm';
+
+}
diff --git a/core/modules/datetime/src/Plugin/views/argument/YearDate.php b/core/modules/datetime/src/Plugin/views/argument/YearDate.php
new file mode 100644
index 000000000000..c34dde33b3f2
--- /dev/null
+++ b/core/modules/datetime/src/Plugin/views/argument/YearDate.php
@@ -0,0 +1,22 @@
+<?php
+
+/**
+ * @file
+ * Contains \Drupal\datetime\Plugin\views\argument\YearDate.
+ */
+
+namespace Drupal\datetime\Plugin\views\argument;
+
+/**
+ * Argument handler for a year.
+ *
+ * @ViewsArgument("datetime_year")
+ */
+class YearDate extends Date {
+
+ /**
+ * {@inheritdoc}
+ */
+ protected $argFormat = 'Y';
+
+}
diff --git a/core/modules/datetime/src/Plugin/views/filter/Date.php b/core/modules/datetime/src/Plugin/views/filter/Date.php
new file mode 100644
index 000000000000..cc3caf716105
--- /dev/null
+++ b/core/modules/datetime/src/Plugin/views/filter/Date.php
@@ -0,0 +1,131 @@
+<?php
+
+/**
+ * @file
+ * Contains \Drupal\datetime\Plugin\views\filter\Date.
+ */
+
+namespace Drupal\datetime\Plugin\views\filter;
+
+use Drupal\Core\Datetime\DateFormatter;
+use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
+use Drupal\datetime\Plugin\Field\FieldType\DateTimeItem;
+use Drupal\views\FieldAPIHandlerTrait;
+use Drupal\views\Plugin\views\filter\Date as NumericDate;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+use Symfony\Component\HttpFoundation\RequestStack;
+
+/**
+ * Date/time views filter.
+ *
+ * Even thought dates are stored as strings, the numeric filter is extended
+ * because it provides more sensible operators.
+ *
+ * @ingroup views_filter_handlers
+ *
+ * @ViewsFilter("datetime")
+ */
+class Date extends NumericDate implements ContainerFactoryPluginInterface {
+
+ use FieldAPIHandlerTrait;
+
+ /**
+ * The date formatter service.
+ *
+ * @var \Drupal\Core\Datetime\DateFormatter
+ */
+ protected $dateFormatter;
+
+ /**
+ * Date format for SQL conversion.
+ *
+ * @var string
+ *
+ * @see \Drupal\views\Plugin\views\query\Sql::getDateFormat()
+ */
+ protected $dateFormat = DATETIME_DATETIME_STORAGE_FORMAT;
+
+ /**
+ * The request stack used to determin current time.
+ *
+ * @var \Symfony\Component\HttpFoundation\RequestStack
+ */
+ protected $requestStack;
+
+ /**
+ * Constructs a new Date handler.
+ *
+ * @param array $configuration
+ * A configuration array containing information about the plugin instance.
+ * @param string $plugin_id
+ * The plugin ID for the plugin instance.
+ * @param mixed $plugin_definition
+ * The plugin implementation definition.
+ * @param \Drupal\Core\Datetime\DateFormatter $date_formatter
+ * The date formatter service.
+ * @param \Symfony\Component\HttpFoundation\RequestStack
+ * The request stack used to determine the current time.
+ */
+ public function __construct(array $configuration, $plugin_id, $plugin_definition, DateFormatter $date_formatter, RequestStack $request_stack) {
+ parent::__construct($configuration, $plugin_id, $plugin_definition);
+ $this->dateFormatter = $date_formatter;
+ $this->requestStack = $request_stack;
+
+ // Date format depends on field storage format.
+ $definition = $this->getFieldStorageDefinition();
+ if ($definition->getSetting('datetime_type') === DateTimeItem::DATETIME_TYPE_DATE) {
+ $this->dateFormat = DATETIME_DATE_STORAGE_FORMAT;
+ }
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
+ return new static(
+ $configuration,
+ $plugin_id,
+ $plugin_definition,
+ $container->get('date.formatter'),
+ $container->get('request_stack')
+ );
+ }
+
+ /**
+ * Override parent method, which deals with dates as integers.
+ */
+ protected function opBetween($field) {
+ $origin = ($this->value['type'] == 'offset') ? $this->requestStack->getCurrentRequest()->server->get('REQUEST_TIME') : 0;
+ $a = intval(strtotime($this->value['min'], $origin));
+ $b = intval(strtotime($this->value['max'], $origin));
+
+ // Formatting will vary on date storage.
+
+
+ // Convert to ISO format and format for query. UTC timezone is used since
+ // dates are stored in UTC.
+ $a = $this->query->getDateFormat("'" . $this->dateFormatter->format($a, 'custom', DATETIME_DATETIME_STORAGE_FORMAT, DATETIME_STORAGE_TIMEZONE) . "'", $this->dateFormat, TRUE);
+ $b = $this->query->getDateFormat("'" . $this->dateFormatter->format($b, 'custom', DATETIME_DATETIME_STORAGE_FORMAT, DATETIME_STORAGE_TIMEZONE) . "'", $this->dateFormat, TRUE);
+
+ // This is safe because we are manually scrubbing the values.
+ $operator = strtoupper($this->operator);
+ $field = $this->query->getDateFormat($field, $this->dateFormat, TRUE);
+ $this->query->addWhereExpression($this->options['group'], "$field $operator $a AND $b");
+ }
+
+ /**
+ * Override parent method, which deals with dates as integers.
+ */
+ protected function opSimple($field) {
+ $origin = (!empty($this->value['type']) && $this->value['type'] == 'offset') ? $this->requestStack->getCurrentRequest()->server->get('REQUEST_TIME') : 0;
+ $value = intval(strtotime($this->value['value'], $origin));
+
+ // Convert to ISO. UTC is used since dates are stored in UTC.
+ $value = $this->query->getDateFormat("'" . $this->dateFormatter->format($value, 'custom', DATETIME_DATETIME_STORAGE_FORMAT, DATETIME_STORAGE_TIMEZONE) . "'", $this->dateFormat, TRUE);
+
+ // This is safe because we are manually scrubbing the value.
+ $field = $this->query->getDateFormat($field, $this->dateFormat, TRUE);
+ $this->query->addWhereExpression($this->options['group'], "$field $this->operator $value");
+ }
+
+}
diff --git a/core/modules/datetime/src/Plugin/views/sort/Date.php b/core/modules/datetime/src/Plugin/views/sort/Date.php
new file mode 100644
index 000000000000..12eddc6ed9d5
--- /dev/null
+++ b/core/modules/datetime/src/Plugin/views/sort/Date.php
@@ -0,0 +1,56 @@
+<?php
+
+/**
+ * @file
+ * Contains \Drupal\datetime\Plugin\views\sort\Date.
+ */
+
+namespace Drupal\datetime\Plugin\views\sort;
+
+use Drupal\views\Plugin\views\sort\Date as NumericDate;
+
+/**
+ * Basic sort handler for datetime fields.
+ *
+ * This handler enables granularity, which is the ability to make dates
+ * equivalent based upon nearness.
+ *
+ * @ViewsSort("datetime")
+ */
+class Date extends NumericDate {
+
+ /**
+ * Override to account for dates stored as strings.
+ */
+ public function getDateField() {
+ // Return the real field, since it is already in string format.
+ return "$this->tableAlias.$this->realField";
+ }
+
+ /**
+ * Override query to provide 'second' granularity.
+ */
+ public function query() {
+ $this->ensureMyTable();
+ switch ($this->options['granularity']) {
+ case 'second':
+ $formula = $this->getDateFormat('YmdHis');
+ $this->query->addOrderBy(NULL, $formula, $this->options['order'], $this->tableAlias . '_' . $this->field . '_' . $this->options['granularity']);
+ return;
+ }
+
+ // All other granularities are handled by the numeric sort handler.
+ parent::query();
+ }
+
+ /**
+ * {@inheritdoc}
+ *
+ * Overridden in order to pass in the string date flag.
+ */
+ public function getDateFormat($format) {
+ return $this->query->getDateFormat($this->getDateField(), $format, TRUE);
+ }
+
+
+}
diff --git a/core/modules/datetime/src/Tests/Views/ArgumentDateTimeTest.php b/core/modules/datetime/src/Tests/Views/ArgumentDateTimeTest.php
new file mode 100644
index 000000000000..18906846fbee
--- /dev/null
+++ b/core/modules/datetime/src/Tests/Views/ArgumentDateTimeTest.php
@@ -0,0 +1,141 @@
+<?php
+
+/**
+ * @file
+ * Contains \Drupal\datetime\Tests\Views\ArgumentDateTimeTest.
+ */
+
+namespace Drupal\datetime\Tests\Views;
+
+use Drupal\views\Views;
+
+/**
+ * Tests the Drupal\datetime\Plugin\views\filter\Date handler.
+ *
+ * @group datetime
+ */
+class ArgumentDateTimeTest extends DateTimeHandlerTestBase {
+
+ /**
+ * {@inheritdoc}
+ */
+ public static $testViews = ['test_argument_datetime'];
+
+ /**
+ * {@inheritdoc}
+ */
+ public function setUp() {
+ parent::setUp();
+
+ // Add some basic test nodes.
+ $dates = [
+ '2000-10-10',
+ '2001-10-10',
+ '2002-01-01',
+ ];
+ foreach ($dates as $date) {
+ $this->nodes[] = $this->drupalCreateNode([
+ 'field_date' => [
+ 'value' => $date,
+ ]
+ ]);
+ }
+ }
+
+ /**
+ * Test year argument.
+ *
+ * @see \Drupal\datetime\Plugin\views\argument\YearDate
+ */
+ public function testDatetimeArgumentYear() {
+ $view = Views::getView('test_argument_datetime');
+
+ // The 'default' display has the 'year' argument.
+ $view->setDisplay('default');
+ $this->executeView($view, ['2000']);
+ $expected = [];
+ $expected[] = ['nid' => $this->nodes[0]->id()];
+ $this->assertIdenticalResultset($view, $expected, $this->map);
+ $view->destroy();
+
+ $view->setDisplay('default');
+ $this->executeView($view, ['2002']);
+ $expected = [];
+ $expected[] = ['nid' => $this->nodes[2]->id()];
+ $this->assertIdenticalResultset($view, $expected, $this->map);
+ $view->destroy();
+ }
+
+ /**
+ * Test month argument.
+ *
+ * @see \Drupal\datetime\Plugin\views\argument\MonthDate
+ */
+ public function testDatetimeArgumentMonth() {
+ $view = Views::getView('test_argument_datetime');
+ // The 'embed_1' display has the 'month' argument.
+ $view->setDisplay('embed_1');
+
+ $this->executeView($view, ['10']);
+ $expected = [];
+ $expected[] = ['nid' => $this->nodes[0]->id()];
+ $expected[] = ['nid' => $this->nodes[1]->id()];
+ $this->assertIdenticalResultset($view, $expected, $this->map);
+ $view->destroy();
+
+ $view->setDisplay('embed_1');
+ $this->executeView($view, ['01']);
+ $expected = [];
+ $expected[] = ['nid' => $this->nodes[2]->id()];
+ $this->assertIdenticalResultset($view, $expected, $this->map);
+ $view->destroy();
+ }
+
+ /**
+ * Test day argument.
+ *
+ * @see \Drupal\datetime\Plugin\views\argument\DayDate
+ */
+ public function testDatetimeArgumentDay() {
+ $view = Views::getView('test_argument_datetime');
+
+ // The 'embed_2' display has the 'day' argument.
+ $view->setDisplay('embed_2');
+ $this->executeView($view, ['10']);
+ $expected = [];
+ $expected[] = ['nid' => $this->nodes[0]->id()];
+ $expected[] = ['nid' => $this->nodes[1]->id()];
+ $this->assertIdenticalResultset($view, $expected, $this->map);
+ $view->destroy();
+
+ $view->setDisplay('embed_2');
+ $this->executeView($view, ['01']);
+ $expected = [];
+ $expected[] = ['nid' => $this->nodes[2]->id()];
+ $this->assertIdenticalResultset($view, $expected, $this->map);
+ $view->destroy();
+ }
+
+ /**
+ * Test year, month, and day arguments combined.
+ */
+ public function testDatetimeArgumentAll() {
+ $view = Views::getView('test_argument_datetime');
+ // The 'embed_3' display has year, month, and day arguments.
+ $view->setDisplay('embed_3');
+
+ $this->executeView($view, ['2000', '10', '10']);
+ $expected = [];
+ $expected[] = ['nid' => $this->nodes[0]->id()];
+ $this->assertIdenticalResultset($view, $expected, $this->map);
+ $view->destroy();
+
+ $view->setDisplay('embed_3');
+ $this->executeView($view, ['2002', '01', '01']);
+ $expected = [];
+ $expected[] = ['nid' => $this->nodes[2]->id()];
+ $this->assertIdenticalResultset($view, $expected, $this->map);
+ $view->destroy();
+ }
+
+}
diff --git a/core/modules/datetime/src/Tests/Views/DateTimeHandlerTestBase.php b/core/modules/datetime/src/Tests/Views/DateTimeHandlerTestBase.php
new file mode 100644
index 000000000000..b9a46992fd0a
--- /dev/null
+++ b/core/modules/datetime/src/Tests/Views/DateTimeHandlerTestBase.php
@@ -0,0 +1,78 @@
+<?php
+
+/**
+ * @file
+ * Contains \Drupal\datetime\Tests\Views\DateTimeHandlerTestBase.
+ */
+
+namespace Drupal\datetime\Tests\Views;
+
+use Drupal\datetime\Plugin\Field\FieldType\DateTimeItem;
+use Drupal\views\Tests\Handler\HandlerTestBase;
+use Drupal\views\Tests\ViewTestData;
+
+/**
+ * Base class for testing datetime handlers.
+ */
+abstract class DateTimeHandlerTestBase extends HandlerTestBase {
+
+ /**
+ * {@inheritdoc}
+ */
+ public static $modules = ['datetime_test', 'node', 'datetime'];
+
+ /**
+ * Name of the field.
+ *
+ * Note, this is used in the default test view.
+ *
+ * @var string
+ */
+ protected static $field_name = 'field_date';
+
+ /**
+ * Nodes to test.
+ *
+ * @var \Drupal\node\NodeInterface[]
+ */
+ protected $nodes = [];
+
+ /**
+ * {@inheritdoc}
+ */
+ public function setUp() {
+ parent::setUp();
+
+ // Add a date field to page nodes.
+ $node_type = entity_create('node_type', [
+ 'type' => 'page',
+ 'name' => 'page'
+ ]);
+ $node_type->save();
+ $fieldStorage = entity_create('field_storage_config', [
+ 'field_name' => static::$field_name,
+ 'entity_type' => 'node',
+ 'type' => 'datetime',
+ 'settings' => ['datetime_type' => DateTimeItem::DATETIME_TYPE_DATETIME],
+ ]);
+ $fieldStorage->save();
+ $field = entity_create('field_config', [
+ 'field_storage' => $fieldStorage,
+ 'bundle' => 'page',
+ 'required' => TRUE,
+ ]);
+ $field->save();
+
+ // Views needs to be aware of the new field.
+ $this->container->get('views.views_data')->clear();
+
+ // Set column map.
+ $this->map = [
+ 'nid' => 'nid',
+ ];
+
+ // Load test views.
+ ViewTestData::createTestViews(get_class($this), ['datetime_test']);
+ }
+
+}
diff --git a/core/modules/datetime/src/Tests/Views/FilterDateTest.php b/core/modules/datetime/src/Tests/Views/FilterDateTest.php
new file mode 100644
index 000000000000..5e54f78e2802
--- /dev/null
+++ b/core/modules/datetime/src/Tests/Views/FilterDateTest.php
@@ -0,0 +1,115 @@
+<?php
+
+/**
+ * @file
+ * Contains \Drupal\datetime\Tests\Views\FilterDateTest.
+ */
+
+namespace Drupal\datetime\Tests\Views;
+use Drupal\datetime\Plugin\Field\FieldType\DateTimeItem;
+use Drupal\field\Entity\FieldStorageConfig;
+use Drupal\views\Views;
+
+/**
+ * Tests date-only fields.
+ *
+ * @group datetime
+ */
+class FilterDateTest extends DateTimeHandlerTestBase {
+
+ /**
+ * {@inheritdoc}
+ */
+ public static $testViews = ['test_filter_datetime'];
+
+ /**
+ * For offset tests, set to the current time.
+ */
+ protected static $date;
+
+ /**
+ * {@inheritdoc}
+ *
+ * Create nodes with relative dates of yesterday, today, and tomorrow.
+ */
+ public function setUp() {
+ parent::setUp();
+
+ // Set to 'today'.
+ static::$date = REQUEST_TIME;
+
+ // Change field storage to date-only.
+ $storage = FieldStorageConfig::load('node.' . static::$field_name);
+ $storage->setSetting('datetime_type', DateTimeItem::DATETIME_TYPE_DATE);
+ $storage->save();
+
+ $dates = [
+ // Tomorrow.
+ \Drupal::service('date.formatter')->format(static::$date + 86400, 'custom', DATETIME_DATE_STORAGE_FORMAT, DATETIME_STORAGE_TIMEZONE),
+ // Today.
+ \Drupal::service('date.formatter')->format(static::$date, 'custom', DATETIME_DATE_STORAGE_FORMAT, DATETIME_STORAGE_TIMEZONE),
+ // Yesterday.
+ \Drupal::service('date.formatter')->format(static::$date - 86400, 'custom', DATETIME_DATE_STORAGE_FORMAT, DATETIME_STORAGE_TIMEZONE),
+ ];
+
+ foreach ($dates as $date) {
+ $this->nodes[] = $this->drupalCreateNode([
+ 'field_date' => [
+ 'value' => $date,
+ ]
+ ]);
+ }
+ }
+
+ /**
+ * Test offsets with date-only fields.
+ */
+ public function testDateOffsets() {
+ $view = Views::getView('test_filter_datetime');
+ $field = static::$field_name . '_value';
+
+ // Test simple operations.
+ $view->initHandlers();
+
+ // A greater than or equal to 'now', should return the 'today' and
+ // the 'tomorrow' node.
+ $view->filter[$field]->operator = '>=';
+ $view->filter[$field]->value['type'] = 'offset';
+ $view->filter[$field]->value['value'] = 'now';
+ $view->setDisplay('default');
+ $this->executeView($view);
+ $expected_result = [
+ ['nid' => $this->nodes[0]->id()],
+ ['nid' => $this->nodes[1]->id()],
+ ];
+ $this->assertIdenticalResultset($view, $expected_result, $this->map);
+ $view->destroy();
+
+ // Only dates in the past.
+ $view->initHandlers();
+ $view->filter[$field]->operator = '<';
+ $view->filter[$field]->value['type'] = 'offset';
+ $view->filter[$field]->value['value'] = 'now';
+ $view->setDisplay('default');
+ $this->executeView($view);
+ $expected_result = [
+ ['nid' => $this->nodes[2]->id()],
+ ];
+ $this->assertIdenticalResultset($view, $expected_result, $this->map);
+ $view->destroy();
+
+ // Test offset for between operator. Only the 'tomorrow' node should appear.
+ $view->initHandlers();
+ $view->filter[$field]->operator = 'between';
+ $view->filter[$field]->value['type'] = 'offset';
+ $view->filter[$field]->value['max'] = '+2 days';
+ $view->filter[$field]->value['min'] = '+1 day';
+ $view->setDisplay('default');
+ $this->executeView($view);
+ $expected_result = [
+ ['nid' => $this->nodes[0]->id()],
+ ];
+ $this->assertIdenticalResultset($view, $expected_result, $this->map);
+ }
+
+}
diff --git a/core/modules/datetime/src/Tests/Views/FilterDateTimeTest.php b/core/modules/datetime/src/Tests/Views/FilterDateTimeTest.php
new file mode 100644
index 000000000000..137f45ccf589
--- /dev/null
+++ b/core/modules/datetime/src/Tests/Views/FilterDateTimeTest.php
@@ -0,0 +1,195 @@
+<?php
+
+/**
+ * @file
+ * Contains \Drupal\datetime\Tests\Views\FilterDateTimeTest.
+ */
+
+namespace Drupal\datetime\Tests\Views;
+
+use Drupal\Core\Datetime\Element\Datetime;
+use Drupal\views\Views;
+
+/**
+ * Tests the Drupal\datetime\Plugin\views\filter\Date handler.
+ *
+ * @group datetime
+ */
+class FilterDateTimeTest extends DateTimeHandlerTestBase {
+
+ /**
+ * {@inheritdoc}
+ */
+ public static $testViews = ['test_filter_datetime'];
+
+ /**
+ * For offset tests, set a date 1 day in the future.
+ */
+ protected static $date;
+
+ /**
+ * Use a non-UTC timezone.
+ */
+ protected static $timezone = 'America/Vancouver';
+
+ /**
+ * {@inheritdoc}
+ */
+ public function setUp() {
+ parent::setUp();
+
+ static::$date = REQUEST_TIME + 86400;
+
+ // Set the timezone.
+ date_default_timezone_set(static::$timezone);
+
+ // Add some basic test nodes.
+ $dates = [
+ '2000-10-10T00:01:30',
+ '2001-10-10T12:12:12',
+ '2002-10-10T14:14:14',
+ // The date storage timezone is used (this mimics the steps taken in the
+ // widget: \Drupal\datetime\Plugin\Field\FieldWidget::messageFormValues().
+ \Drupal::service('date.formatter')->format(static::$date, 'custom', DATETIME_DATETIME_STORAGE_FORMAT, DATETIME_STORAGE_TIMEZONE),
+ ];
+ foreach ($dates as $date) {
+ $this->nodes[] = $this->drupalCreateNode([
+ 'field_date' => [
+ 'value' => $date,
+ ]
+ ]);
+ }
+ }
+
+ /**
+ * Test filter operations.
+ */
+ public function testDatetimeFilter() {
+ $this->_testOffset();
+ $this->_testBetween();
+ $this->_testExact();
+ }
+
+ /**
+ * Test offset operations.
+ */
+ protected function _testOffset() {
+ $view = Views::getView('test_filter_datetime');
+ $field = static::$field_name . '_value';
+
+ // Test simple operations.
+ $view->initHandlers();
+
+ $view->filter[$field]->operator = '>';
+ $view->filter[$field]->value['type'] = 'offset';
+ $view->filter[$field]->value['value'] = '+1 hour';
+ $view->setDisplay('default');
+ $this->executeView($view);
+ $expected_result = [
+ ['nid' => $this->nodes[3]->id()],
+ ];
+ $this->assertIdenticalResultset($view, $expected_result, $this->map);
+ $view->destroy();
+
+ // Test offset for between operator.
+ $view->initHandlers();
+ $view->filter[$field]->operator = 'between';
+ $view->filter[$field]->value['type'] = 'offset';
+ $view->filter[$field]->value['max'] = '+2 days';
+ $view->filter[$field]->value['min'] = '+1 hour';
+ $view->setDisplay('default');
+ $this->executeView($view);
+ $expected_result = [
+ ['nid' => $this->nodes[3]->id()],
+ ];
+ $this->assertIdenticalResultset($view, $expected_result, $this->map);
+ }
+
+ /**
+ * Test between operations.
+ */
+ protected function _testBetween() {
+ $view = Views::getView('test_filter_datetime');
+ $field = static::$field_name . '_value';
+
+ // Test between with min and max.
+ $view->initHandlers();
+ $view->filter[$field]->operator = 'between';
+ $view->filter[$field]->value['min'] = '2001-01-01';
+ $view->filter[$field]->value['max'] = '2002-01-01';
+ $view->setDisplay('default');
+ $this->executeView($view);
+ $expected_result = [
+ ['nid' => $this->nodes[1]->id()],
+ ];
+ $this->assertIdenticalResultset($view, $expected_result, $this->map);
+ $view->destroy();
+
+ // Test between with just max.
+ $view->initHandlers();
+ $view->filter[$field]->operator = 'between';
+ $view->filter[$field]->value['max'] = '2002-01-01';
+ $view->setDisplay('default');
+ $this->executeView($view);
+ $expected_result = [
+ ['nid' => $this->nodes[0]->id()],
+ ['nid' => $this->nodes[1]->id()],
+ ];
+ $this->assertIdenticalResultset($view, $expected_result, $this->map);
+ $view->destroy();
+
+ // Test not between with min and max.
+ $view->initHandlers();
+ $view->filter[$field]->operator = 'not between';
+ $view->filter[$field]->value['min'] = '2001-01-01';
+ $view->filter[$field]->value['max'] = '2002-01-01';
+ $view->setDisplay('default');
+ $this->executeView($view);
+ $expected_result = [
+ ['nid' => $this->nodes[0]->id()],
+ ['nid' => $this->nodes[2]->id()],
+ ['nid' => $this->nodes[3]->id()],
+ ];
+ $this->assertIdenticalResultset($view, $expected_result, $this->map);
+ $view->destroy();
+
+ // Test not between with just max.
+ $view->initHandlers();
+ $view->filter[$field]->operator = 'not between';
+ $view->filter[$field]->value['max'] = '2001-01-01';
+ $view->setDisplay('default');
+ $this->executeView($view);
+ $expected_result = [
+ ['nid' => $this->nodes[1]->id()],
+ ['nid' => $this->nodes[2]->id()],
+ ['nid' => $this->nodes[3]->id()],
+ ];
+ $this->assertIdenticalResultset($view, $expected_result, $this->map);
+ }
+
+ /**
+ * Test exact date matching.
+ */
+ protected function _testExact() {
+ $view = Views::getView('test_filter_datetime');
+ $field = static::$field_name . '_value';
+
+ // Test between with min and max.
+ $view->initHandlers();
+ $view->filter[$field]->operator = '=';
+ $view->filter[$field]->value['min'] = '';
+ $view->filter[$field]->value['max'] = '';
+ // Use the date from node 3. Use the site timezone (mimics a value entered
+ // through the UI).
+ $view->filter[$field]->value['value'] = \Drupal::service('date.formatter')->format(static::$date, 'custom', DATETIME_DATETIME_STORAGE_FORMAT, static::$timezone);
+ $view->setDisplay('default');
+ $this->executeView($view);
+ $expected_result = [
+ ['nid' => $this->nodes[3]->id()],
+ ];
+ $this->assertIdenticalResultset($view, $expected_result, $this->map);
+ $view->destroy();
+
+ }
+
+}
diff --git a/core/modules/datetime/src/Tests/Views/SortDateTimeTest.php b/core/modules/datetime/src/Tests/Views/SortDateTimeTest.php
new file mode 100644
index 000000000000..f3f89366cff4
--- /dev/null
+++ b/core/modules/datetime/src/Tests/Views/SortDateTimeTest.php
@@ -0,0 +1,99 @@
+<?php
+
+/**
+ * @file
+ * Contains \Drupal\datetime\Tests\Views\SortDateTimeTest.
+ */
+
+namespace Drupal\datetime\Tests\Views;
+
+use Drupal\views\Views;
+
+/**
+ * Tests for core Drupal\datetime\Plugin\views\sort\Date handler.
+ *
+ * @group datetime
+ */
+class SortDateTimeTest extends DateTimeHandlerTestBase {
+
+ /**
+ * {@inheritdoc}
+ */
+ public static $testViews = ['test_sort_datetime'];
+
+ /**
+ * {@inheritdoc}
+ */
+ public function setUp() {
+ parent::setUp();
+
+ // Add some basic test nodes.
+ $dates = [
+ '2014-10-10T00:03:00',
+ '2000-10-10T00:01:00',
+ '2000-10-10T00:02:00',
+ '2000-10-10T00:03:00',
+ ];
+ foreach ($dates as $date) {
+ $this->nodes[] = $this->drupalCreateNode([
+ 'field_date' => [
+ 'value' => $date,
+ ]
+ ]);
+ }
+ }
+
+ /**
+ * Tests the datetime sort handler.
+ */
+ public function testDateTimeSort() {
+ $field = static::$field_name . '_value';
+ $view = Views::getView('test_sort_datetime');
+
+ // Sort order is DESC.
+ $view->initHandlers();
+ $view->sort[$field]->options['granularity'] = 'minute';
+ $view->setDisplay('default');
+ $this->executeView($view);
+ $expected_result = [
+ ['nid' => $this->nodes[0]->id()],
+ ['nid' => $this->nodes[3]->id()],
+ ['nid' => $this->nodes[2]->id()],
+ ['nid' => $this->nodes[1]->id()],
+ ];
+ $this->assertIdenticalResultset($view, $expected_result, $this->map);
+ $view->destroy();
+
+ // Check ASC.
+ $view->initHandlers();
+ $field = static::$field_name . '_value';
+ $view->sort[$field]->options['order'] = 'ASC';
+ $view->setDisplay('default');
+ $this->executeView($view);
+ $expected_result = [
+ ['nid' => $this->nodes[1]->id()],
+ ['nid' => $this->nodes[2]->id()],
+ ['nid' => $this->nodes[3]->id()],
+ ['nid' => $this->nodes[0]->id()],
+ ];
+ $this->assertIdenticalResultset($view, $expected_result, $this->map);
+ $view->destroy();
+
+ // Change granularity to 'year', and the secondary node ID order should
+ // define the order of nodes with the same year.
+ $view->initHandlers();
+ $view->sort[$field]->options['granularity'] = 'year';
+ $view->sort[$field]->options['order'] = 'DESC';
+ $view->setDisplay('default');
+ $this->executeView($view);
+ $expected_result = [
+ ['nid' => $this->nodes[0]->id()],
+ ['nid' => $this->nodes[1]->id()],
+ ['nid' => $this->nodes[2]->id()],
+ ['nid' => $this->nodes[3]->id()],
+ ];
+ $this->assertIdenticalResultset($view, $expected_result, $this->map);
+ $view->destroy();
+ }
+
+}
diff --git a/core/modules/datetime/tests/modules/datetime_test/datetime_test.info.yml b/core/modules/datetime/tests/modules/datetime_test/datetime_test.info.yml
new file mode 100644
index 000000000000..84ba9e41d1a7
--- /dev/null
+++ b/core/modules/datetime/tests/modules/datetime_test/datetime_test.info.yml
@@ -0,0 +1,8 @@
+name: 'Datetime test'
+type: module
+description: 'Provides default views for tests.'
+package: Testing
+version: VERSION
+core: 8.x
+dependencies:
+ - views
diff --git a/core/modules/datetime/tests/modules/datetime_test/test_views/views.view.test_argument_datetime.yml b/core/modules/datetime/tests/modules/datetime_test/test_views/views.view.test_argument_datetime.yml
new file mode 100644
index 000000000000..e22ad30c810d
--- /dev/null
+++ b/core/modules/datetime/tests/modules/datetime_test/test_views/views.view.test_argument_datetime.yml
@@ -0,0 +1,99 @@
+langcode: und
+status: true
+dependencies: { }
+id: test_argument_datetime
+label: ''
+module: views
+description: ''
+tag: ''
+base_table: node_field_data
+base_field: nid
+core: '8'
+display:
+ default:
+ display_options:
+ defaults:
+ fields: false
+ pager: false
+ sorts: false
+ arguments:
+ field_date_value_year:
+ field: field_date_value_year
+ id: field_date_value
+ table: node__field_date
+ plugin_id: datetime_year
+ fields:
+ id:
+ field: nid
+ id: nid
+ relationship: none
+ table: node
+ plugin_id: numeric
+ pager:
+ options:
+ offset: 0
+ type: none
+ sorts:
+ id:
+ field: nid
+ id: nid
+ order: ASC
+ relationship: none
+ table: node
+ plugin_id: numeric
+ display_plugin: default
+ display_title: Master
+ id: default
+ position: 0
+ embed_1:
+ display_options:
+ defaults:
+ arguments: false
+ arguments:
+ field_date_value_month:
+ field: field_date_value_month
+ id: field_date_value
+ table: node__field_date
+ plugin_id: datetime_month
+ display_plugin: embed
+ id: embed_1
+ display_title: ''
+ position: null
+ embed_2:
+ display_options:
+ defaults:
+ arguments: false
+ arguments:
+ field_date_value_day:
+ field: field_date_value_day
+ id: field_date_value
+ table: node__field_date
+ plugin_id: datetime_day
+ display_plugin: embed
+ id: embed_2
+ display_title: ''
+ position: null
+ embed_3:
+ display_options:
+ defaults:
+ arguments: false
+ arguments:
+ field_date_value_year:
+ field: field_date_value_year
+ id: field_date_value
+ table: node__field_date
+ plugin_id: datetime_year
+ field_date_value_month:
+ field: field_date_value_month
+ id: field_date_value
+ table: node__field_date
+ plugin_id: datetime_month
+ field_date_value_day:
+ field: field_date_value_day
+ id: field_date_value
+ table: node__field_date
+ plugin_id: datetime_day
+ display_plugin: embed
+ id: embed_2
+ display_title: ''
+ position: null
diff --git a/core/modules/datetime/tests/modules/datetime_test/test_views/views.view.test_filter_datetime.yml b/core/modules/datetime/tests/modules/datetime_test/test_views/views.view.test_filter_datetime.yml
new file mode 100644
index 000000000000..c9b23ded6fe2
--- /dev/null
+++ b/core/modules/datetime/tests/modules/datetime_test/test_views/views.view.test_filter_datetime.yml
@@ -0,0 +1,56 @@
+langcode: und
+status: true
+dependencies:
+ module:
+ - node
+id: test_filter_datetime
+label: ''
+module: views
+description: ''
+tag: ''
+base_table: node_field_data
+base_field: nid
+core: '8'
+display:
+ default:
+ display_options:
+ access:
+ type: none
+ cache:
+ type: none
+ exposed_form:
+ type: basic
+ fields:
+ nid:
+ field: nid
+ id: nid
+ table: node
+ plugin_id: node
+ filters:
+ field_date_value:
+ id: field_date_value
+ table: node__field_date
+ field: field_date_value
+ plugin_id: datetime
+ sorts:
+ id:
+ field: nid
+ id: nid
+ order: ASC
+ relationship: none
+ table: node
+ plugin_id: numeric
+ pager:
+ type: full
+ query:
+ options:
+ query_comment: ''
+ type: views_query
+ style:
+ type: default
+ row:
+ type: fields
+ display_plugin: default
+ display_title: Master
+ id: default
+ position: 0
diff --git a/core/modules/datetime/tests/modules/datetime_test/test_views/views.view.test_sort_datetime.yml b/core/modules/datetime/tests/modules/datetime_test/test_views/views.view.test_sort_datetime.yml
new file mode 100644
index 000000000000..8b8d052ae762
--- /dev/null
+++ b/core/modules/datetime/tests/modules/datetime_test/test_views/views.view.test_sort_datetime.yml
@@ -0,0 +1,57 @@
+langcode: und
+status: true
+dependencies:
+ module:
+ - node
+id: test_sort_datetime
+label: ''
+module: views
+description: ''
+tag: ''
+base_table: node_field_data
+base_field: nid
+core: '8'
+display:
+ default:
+ display_options:
+ access:
+ type: none
+ cache:
+ type: none
+ exposed_form:
+ type: basic
+ fields:
+ nid:
+ field: nid
+ id: nid
+ table: node
+ plugin_id: node
+ sorts:
+ field_date_value:
+ field: field_date_value
+ id: field_date_value
+ relationship: none
+ table: node__field_date
+ order: DESC
+ plugin_id: datetime
+ id:
+ field: nid
+ id: nid
+ order: ASC
+ relationship: none
+ table: node
+ plugin_id: numeric
+ pager:
+ type: full
+ query:
+ options:
+ query_comment: ''
+ type: views_query
+ style:
+ type: default
+ row:
+ type: fields
+ display_plugin: default
+ display_title: Master
+ id: default
+ position: 0
diff --git a/core/modules/views/src/Plugin/views/query/QueryPluginBase.php b/core/modules/views/src/Plugin/views/query/QueryPluginBase.php
index 0d6d9f86286c..97498e95ca1b 100644
--- a/core/modules/views/src/Plugin/views/query/QueryPluginBase.php
+++ b/core/modules/views/src/Plugin/views/query/QueryPluginBase.php
@@ -237,12 +237,15 @@ public function setupTimezone() {
* An appropriate query expression pointing to the date field.
* @param string $format
* A format string for the result, like 'Y-m-d H:i:s'.
+ * @param boolean $string_date
+ * For certain databases, date format functions vary depending on string or
+ * numeric storage.
*
* @return string
* A string representing the field formatted as a date in the format
* specified by $format.
*/
- public function getDateFormat($field, $format) {
+ public function getDateFormat($field, $format, $string_date = FALSE) {
return $field;
}
diff --git a/core/modules/views/src/Plugin/views/query/Sql.php b/core/modules/views/src/Plugin/views/query/Sql.php
index 2ddfd2199161..a61b8506f533 100644
--- a/core/modules/views/src/Plugin/views/query/Sql.php
+++ b/core/modules/views/src/Plugin/views/query/Sql.php
@@ -1748,9 +1748,9 @@ public function setupTimezone() {
}
/**
- * Overrides \Drupal\views\Plugin\views\query\QueryPluginBase::getDateFormat().
+ * {@inheritdoc}
*/
- public function getDateFormat($field, $format) {
+ public function getDateFormat($field, $format, $string_date = FALSE) {
$db_type = Database::getConnection()->databaseType();
switch ($db_type) {
case 'mysql':
@@ -1797,7 +1797,12 @@ public function getDateFormat($field, $format) {
'A' => 'AM',
);
$format = strtr($format, $replace);
- return "TO_CHAR($field, '$format')";
+ if (!$string_date) {
+ return "TO_CHAR($field, '$format')";
+ }
+ // In order to allow for partials (eg, only the year), transform to a
+ // date, back to a string again.
+ return "TO_CHAR(TO_TIMESTAMP($field, 'YYYY-MM-DD HH24:MI:SS'), '$format')";
case 'sqlite':
$replace = array(
'Y' => '%Y',
@@ -1827,15 +1832,19 @@ public function getDateFormat($field, $format) {
'A' => '',
);
$format = strtr($format, $replace);
+
+ // Don't use the 'unixepoch' flag for string date comparisons.
+ $unixepoch = $string_date ? '' : ", 'unixepoch'";
+
// SQLite does not have a ISO week substitution string, so it needs
// special handling.
// @see http://en.wikipedia.org/wiki/ISO_week_date#Calculation
// @see http://stackoverflow.com/a/15511864/1499564
if ($format === '%W') {
- $expression = "((strftime('%j', date(strftime('%Y-%m-%d', $field, 'unixepoch'), '-3 days', 'weekday 4')) - 1) / 7 + 1)";
+ $expression = "((strftime('%j', date(strftime('%Y-%m-%d', $field" . $unixepoch . "), '-3 days', 'weekday 4')) - 1) / 7 + 1)";
}
else {
- $expression = "strftime('$format', $field, 'unixepoch')";
+ $expression = "strftime('$format', $field" . $unixepoch . ")";
}
// The expression yields a string, but the comparison value is an
// integer in case the comparison value is a float, integer, or numeric.
--
GitLab