Version 1
[yaffs-website] / web / core / modules / views / tests / src / Kernel / Handler / FilterCombineTest.php
diff --git a/web/core/modules/views/tests/src/Kernel/Handler/FilterCombineTest.php b/web/core/modules/views/tests/src/Kernel/Handler/FilterCombineTest.php
new file mode 100644 (file)
index 0000000..e5d3711
--- /dev/null
@@ -0,0 +1,300 @@
+<?php
+
+namespace Drupal\Tests\views\Kernel\Handler;
+
+use Drupal\Tests\views\Kernel\ViewsKernelTestBase;
+use Drupal\views\Views;
+
+/**
+ * Tests the combine filter handler.
+ *
+ * @group views
+ */
+class FilterCombineTest extends ViewsKernelTestBase {
+
+  /**
+   * {@inheritdoc}
+   */
+  public static $modules = ['entity_test'];
+
+  /**
+   * Views used by this test.
+   *
+   * @var array
+   */
+  public static $testViews = ['test_view', 'entity_test_fields'];
+
+  /**
+   * Map column names.
+   *
+   * @var array
+   */
+  protected $columnMap = [
+    'views_test_data_name' => 'name',
+    'views_test_data_job' => 'job',
+  ];
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function setUp($import_test_views = TRUE) {
+    parent::setUp($import_test_views);
+
+    $this->installEntitySchema('entity_test');
+  }
+
+  public function testFilterCombineContains() {
+    $view = Views::getView('test_view');
+    $view->setDisplay();
+
+    $fields = $view->displayHandlers->get('default')->getOption('fields');
+    $view->displayHandlers->get('default')->overrideOption('fields', $fields + [
+      'job' => [
+        'id' => 'job',
+        'table' => 'views_test_data',
+        'field' => 'job',
+        'relationship' => 'none',
+      ],
+    ]);
+
+    // Change the filtering.
+    $view->displayHandlers->get('default')->overrideOption('filters', [
+      'age' => [
+        'id' => 'combine',
+        'table' => 'views',
+        'field' => 'combine',
+        'relationship' => 'none',
+        'operator' => 'contains',
+        'fields' => [
+          'name',
+          'job',
+        ],
+        'value' => 'ing',
+      ],
+    ]);
+
+    $this->executeView($view);
+    $resultset = [
+      [
+        'name' => 'John',
+        'job' => 'Singer',
+      ],
+      [
+        'name' => 'George',
+        'job' => 'Singer',
+      ],
+      [
+        'name' => 'Ringo',
+        'job' => 'Drummer',
+      ],
+      [
+        'name' => 'Ginger',
+        'job' => NULL,
+      ],
+    ];
+    $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
+  }
+
+  /**
+   * Tests the Combine field filter with the 'word' operator.
+   */
+  public function testFilterCombineWord() {
+    $view = Views::getView('test_view');
+    $view->setDisplay();
+
+    $fields = $view->displayHandlers->get('default')->getOption('fields');
+    $view->displayHandlers->get('default')->overrideOption('fields', $fields + [
+        'job' => [
+          'id' => 'job',
+          'table' => 'views_test_data',
+          'field' => 'job',
+          'relationship' => 'none',
+        ],
+      ]);
+
+    // Change the filtering.
+    $view->displayHandlers->get('default')->overrideOption('filters', [
+      'age' => [
+        'id' => 'combine',
+        'table' => 'views',
+        'field' => 'combine',
+        'relationship' => 'none',
+        'operator' => 'word',
+        'fields' => [
+          'name',
+          'job',
+        ],
+        'value' => 'singer ringo',
+      ],
+    ]);
+
+    $this->executeView($view);
+    $resultset = [
+      [
+        'name' => 'John',
+        'job' => 'Singer',
+      ],
+      [
+        'name' => 'George',
+        'job' => 'Singer',
+      ],
+      [
+        'name' => 'Ringo',
+        'job' => 'Drummer',
+      ],
+    ];
+    $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
+  }
+
+  /**
+   * Tests the Combine field filter with the 'allwords' operator.
+   */
+  public function testFilterCombineAllWords() {
+    $view = Views::getView('test_view');
+    $view->setDisplay();
+
+    $fields = $view->displayHandlers->get('default')->getOption('fields');
+    $view->displayHandlers->get('default')->overrideOption('fields', $fields + [
+        'job' => [
+          'id' => 'job',
+          'table' => 'views_test_data',
+          'field' => 'job',
+          'relationship' => 'none',
+        ],
+      ]);
+
+    // Set the filtering to allwords and simulate searching for a phrase.
+    $view->displayHandlers->get('default')->overrideOption('filters', [
+      'age' => [
+        'id' => 'combine',
+        'table' => 'views',
+        'field' => 'combine',
+        'relationship' => 'none',
+        'operator' => 'allwords',
+        'fields' => [
+          'name',
+          'job',
+          'age',
+        ],
+        'value' => '25 "john   singer"',
+      ],
+    ]);
+
+    $this->executeView($view);
+    $resultset = [
+      [
+        'name' => 'John',
+        'job' => 'Singer',
+      ],
+    ];
+    $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
+  }
+
+  /**
+   * Tests if the filter can handle removed fields.
+   *
+   * Tests the combined filter handler when a field overwrite is done
+   * and fields set in the combine filter are removed from the display
+   * but not from the combined filter settings.
+   */
+  public function testFilterCombineContainsFieldsOverwritten() {
+    $view = Views::getView('test_view');
+    $view->setDisplay();
+
+    $fields = $view->displayHandlers->get('default')->getOption('fields');
+    $view->displayHandlers->get('default')->overrideOption('fields', $fields + [
+      'job' => [
+        'id' => 'job',
+        'table' => 'views_test_data',
+        'field' => 'job',
+        'relationship' => 'none',
+      ],
+    ]);
+
+    // Change the filtering.
+    $view->displayHandlers->get('default')->overrideOption('filters', [
+      'age' => [
+        'id' => 'combine',
+        'table' => 'views',
+        'field' => 'combine',
+        'relationship' => 'none',
+        'operator' => 'contains',
+        'fields' => [
+          'name',
+          'job',
+          // Add a dummy field to the combined fields to simulate
+          // a removed or deleted field.
+          'dummy',
+        ],
+        'value' => 'ing',
+      ],
+    ]);
+
+    $this->executeView($view);
+    // Make sure this view will not get displayed.
+    $this->assertTrue($view->build_info['fail'], "View build has been marked as failed.");
+    // Make sure this view does not pass validation with the right error.
+    $errors = $view->validate();
+    $this->assertEquals(t('Field %field set in %filter is not set in display %display.', ['%field' => 'dummy', '%filter' => 'Global: Combine fields filter', '%display' => 'Master']), reset($errors['default']));
+  }
+
+  /**
+   * Tests that the combine field filter is not valid on displays that don't use
+   * fields.
+   */
+  public function testNonFieldsRow() {
+    $view = Views::getView('entity_test_fields');
+    $view->setDisplay();
+
+    // Set the rows to a plugin type that doesn't support fields.
+    $view->displayHandlers->get('default')->overrideOption('row', [
+      'type' => 'entity:entity_test',
+      'options' => [
+        'view_mode' => 'teaser',
+      ],
+    ]);
+    // Change the filtering.
+    $view->displayHandlers->get('default')->overrideOption('filters', [
+      'name' => [
+        'id' => 'combine',
+        'table' => 'views',
+        'field' => 'combine',
+        'relationship' => 'none',
+        'operator' => 'contains',
+        'fields' => [
+          'name',
+        ],
+        'value' => 'ing',
+      ],
+    ]);
+    $this->executeView($view);
+    $errors = $view->validate();
+    // Check that the right error is shown.
+    $this->assertEquals(t('%display: %filter can only be used on displays that use fields. Set the style or row format for that display to one using fields to use the combine field filter.', ['%filter' => 'Global: Combine fields filter', '%display' => 'Master']), reset($errors['default']));
+  }
+
+  /**
+   * Additional data to test the NULL issue.
+   */
+  protected function dataSet() {
+    $data_set = parent::dataSet();
+    $data_set[] = [
+      'name' => 'Ginger',
+      'age' => 25,
+      'job' => NULL,
+      'created' => gmmktime(0, 0, 0, 1, 2, 2000),
+      'status' => 1,
+    ];
+    return $data_set;
+  }
+
+  /**
+   * Allow {views_test_data}.job to be NULL.
+   */
+  protected function schemaDefinition() {
+    $schema = parent::schemaDefinition();
+    unset($schema['views_test_data']['fields']['job']['not null']);
+    return $schema;
+  }
+
+}