3 namespace Drupal\Tests\views\Kernel\Handler;
5 use Drupal\Tests\views\Kernel\ViewsKernelTestBase;
6 use Drupal\views\Views;
9 * Tests the core Drupal\views\Plugin\views\filter\StringFilter handler.
13 class FilterStringTest extends ViewsKernelTestBase {
15 public static $modules = ['system'];
18 * Views used by this test.
22 public static $testViews = ['test_view'];
29 protected $columnMap = [
30 'views_test_data_name' => 'name',
33 public function viewsData() {
34 $data = parent::viewsData();
35 $data['views_test_data']['name']['filter']['allow empty'] = TRUE;
36 $data['views_test_data']['job']['filter']['allow empty'] = FALSE;
37 $data['views_test_data']['description'] = $data['views_test_data']['name'];
45 protected function schemaDefinition() {
46 $schema = parent::schemaDefinition();
47 $schema['views_test_data']['fields']['description'] = [
48 'description' => "A person's description",
58 * An extended test dataset.
60 protected function dataSet() {
61 $dataset = parent::dataSet();
62 $dataset[0]['description'] = 'John Winston Ono Lennon, MBE (9 October 1940 – 8 December 1980) was an English musician and singer-songwriter who rose to worldwide fame as one of the founding members of The Beatles, one of the most commercially successful and critically acclaimed acts in the history of popular music. Along with fellow Beatle Paul McCartney, he formed one of the most successful songwriting partnerships of the 20th century.';
63 $dataset[1]['description'] = 'George Harrison,[1] MBE (25 February 1943 – 29 November 2001)[2] was an English rock guitarist, singer-songwriter, actor and film producer who achieved international fame as lead guitarist of The Beatles.';
64 $dataset[2]['description'] = 'Richard Starkey, MBE (born 7 July 1940), better known by his stage name Ringo Starr, is an English musician, singer-songwriter, and actor who gained worldwide fame as the drummer for The Beatles.';
65 $dataset[3]['description'] = 'Sir James Paul McCartney, MBE (born 18 June 1942) is an English musician, singer-songwriter and composer. Formerly of The Beatles (1960–1970) and Wings (1971–1981), McCartney is the most commercially successful songwriter in the history of popular music, according to Guinness World Records.[1]';
66 $dataset[4]['description'] = NULL;
72 * Build and return a Page view of the views_test_data table.
76 protected function getBasicPageView() {
77 $view = Views::getView('test_view');
79 // In order to test exposed filters, we have to disable
80 // the exposed forms cache.
81 \Drupal::service('views.exposed_form_cache')->reset();
83 $view->newDisplay('page', 'Page', 'page_1');
87 public function testFilterStringEqual() {
88 $view = Views::getView('test_view');
91 // Change the filtering
92 $view->displayHandlers->get('default')->overrideOption('filters', [
95 'table' => 'views_test_data',
97 'relationship' => 'none',
103 $this->executeView($view);
109 $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
112 public function testFilterStringGroupedExposedEqual() {
113 $filters = $this->getGroupedExposedFilters();
114 $view = $this->getBasicPageView();
116 // Filter: Name, Operator: =, Value: Ringo
117 $filters['name']['group_info']['default_group'] = 1;
118 $view->setDisplay('page_1');
119 $view->displayHandlers->get('page_1')->overrideOption('filters', $filters);
121 $this->container->get('router.builder')->rebuild();
123 $this->executeView($view);
131 $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
134 public function testFilterStringNotEqual() {
135 $view = Views::getView('test_view');
138 // Change the filtering
139 $view->displayHandlers->get('default')->overrideOption('filters', [
142 'table' => 'views_test_data',
144 'relationship' => 'none',
150 $this->executeView($view);
162 'name' => 'Meredith',
165 $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
168 public function testFilterStringGroupedExposedNotEqual() {
169 $filters = $this->getGroupedExposedFilters();
170 $view = $this->getBasicPageView();
172 // Filter: Name, Operator: !=, Value: Ringo
173 $filters['name']['group_info']['default_group'] = '2';
175 $view->setDisplay('page_1');
176 $view->displayHandlers->get('page_1')->overrideOption('filters', $filters);
178 $this->container->get('router.builder')->rebuild();
180 $this->executeView($view);
193 'name' => 'Meredith',
197 $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
200 public function testFilterStringContains() {
201 $view = Views::getView('test_view');
204 // Change the filtering
205 $view->displayHandlers->get('default')->overrideOption('filters', [
208 'table' => 'views_test_data',
210 'relationship' => 'none',
211 'operator' => 'contains',
216 $this->executeView($view);
222 $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
226 public function testFilterStringGroupedExposedContains() {
227 $filters = $this->getGroupedExposedFilters();
228 $view = $this->getBasicPageView();
230 // Filter: Name, Operator: contains, Value: ing
231 $filters['name']['group_info']['default_group'] = '3';
232 $view->setDisplay('page_1');
233 $view->displayHandlers->get('page_1')->overrideOption('filters', $filters);
235 $this->container->get('router.builder')->rebuild();
237 $this->executeView($view);
245 $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
249 public function testFilterStringWord() {
250 $view = Views::getView('test_view');
253 // Change the filtering
254 $view->displayHandlers->get('default')->overrideOption('filters', [
256 'id' => 'description',
257 'table' => 'views_test_data',
258 'field' => 'description',
259 'relationship' => 'none',
260 'operator' => 'word',
265 $this->executeView($view);
274 $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
277 $view = Views::getView('test_view');
280 // Change the filtering
281 $view->displayHandlers->get('default')->overrideOption('filters', [
283 'id' => 'description',
284 'table' => 'views_test_data',
285 'field' => 'description',
286 'relationship' => 'none',
287 'operator' => 'allwords',
288 'value' => 'Richard Starkey',
292 $this->executeView($view);
298 $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
301 $view = Views::getView('test_view');
304 // Change the filtering to a sting containing only illegal characters.
305 $view->displayHandlers->get('default')->overrideOption('filters', [
307 'id' => 'description',
308 'table' => 'views_test_data',
309 'field' => 'description',
310 'relationship' => 'none',
311 'operator' => 'allwords',
316 $this->executeView($view);
331 'name' => 'Meredith',
334 $this->assertIdenticalResultset($view, $resultset);
338 public function testFilterStringGroupedExposedWord() {
339 $filters = $this->getGroupedExposedFilters();
340 $view = $this->getBasicPageView();
342 // Filter: Name, Operator: contains, Value: ing
343 $filters['name']['group_info']['default_group'] = '3';
344 $view->setDisplay('page_1');
345 $view->displayHandlers->get('page_1')->overrideOption('filters', $filters);
347 $this->container->get('router.builder')->rebuild();
349 $this->executeView($view);
357 $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
360 $filters = $this->getGroupedExposedFilters();
361 $view = $this->getBasicPageView();
363 // Filter: Description, Operator: contains, Value: actor
364 $filters['description']['group_info']['default_group'] = '1';
365 $view->setDisplay('page_1');
366 $view->displayHandlers->get('page_1')->overrideOption('filters', $filters);
368 $this->executeView($view);
377 $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
380 public function testFilterStringStarts() {
381 $view = Views::getView('test_view');
384 // Change the filtering
385 $view->displayHandlers->get('default')->overrideOption('filters', [
387 'id' => 'description',
388 'table' => 'views_test_data',
389 'field' => 'description',
390 'relationship' => 'none',
391 'operator' => 'starts',
396 $this->executeView($view);
402 $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
405 public function testFilterStringGroupedExposedStarts() {
406 $filters = $this->getGroupedExposedFilters();
407 $view = $this->getBasicPageView();
409 // Filter: Name, Operator: starts, Value: George
410 $filters['description']['group_info']['default_group'] = 2;
411 $view->setDisplay('page_1');
412 $view->displayHandlers->get('page_1')->overrideOption('filters', $filters);
414 $this->container->get('router.builder')->rebuild();
416 $this->executeView($view);
423 $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
426 public function testFilterStringNotStarts() {
427 $view = Views::getView('test_view');
430 // Change the filtering
431 $view->displayHandlers->get('default')->overrideOption('filters', [
433 'id' => 'description',
434 'table' => 'views_test_data',
435 'field' => 'description',
436 'relationship' => 'none',
437 'operator' => 'not_starts',
442 $this->executeView($view);
453 // There is no Meredith returned because his description is empty
455 $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
458 public function testFilterStringGroupedExposedNotStarts() {
459 $filters = $this->getGroupedExposedFilters();
460 $view = $this->getBasicPageView();
462 // Filter: Name, Operator: not_starts, Value: George
463 $filters['description']['group_info']['default_group'] = 3;
464 $view->setDisplay('page_1');
465 $view->displayHandlers->get('page_1')->overrideOption('filters', $filters);
467 $this->container->get('router.builder')->rebuild();
469 $this->executeView($view);
481 // There is no Meredith returned because his description is empty
483 $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
486 public function testFilterStringEnds() {
487 $view = Views::getView('test_view');
490 // Change the filtering
491 $view->displayHandlers->get('default')->overrideOption('filters', [
493 'id' => 'description',
494 'table' => 'views_test_data',
495 'field' => 'description',
496 'relationship' => 'none',
497 'operator' => 'ends',
498 'value' => 'Beatles.',
502 $this->executeView($view);
511 $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
514 public function testFilterStringGroupedExposedEnds() {
515 $filters = $this->getGroupedExposedFilters();
516 $view = $this->getBasicPageView();
518 // Filter: Description, Operator: ends, Value: Beatles
519 $filters['description']['group_info']['default_group'] = 4;
520 $view->setDisplay('page_1');
521 $view->displayHandlers->get('page_1')->overrideOption('filters', $filters);
523 $this->container->get('router.builder')->rebuild();
525 $this->executeView($view);
535 $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
538 public function testFilterStringNotEnds() {
539 $view = Views::getView('test_view');
542 // Change the filtering
543 $view->displayHandlers->get('default')->overrideOption('filters', [
545 'id' => 'description',
546 'table' => 'views_test_data',
547 'field' => 'description',
548 'relationship' => 'none',
549 'operator' => 'not_ends',
550 'value' => 'Beatles.',
554 $this->executeView($view);
562 // There is no Meredith returned because his description is empty
564 $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
567 public function testFilterStringGroupedExposedNotEnds() {
568 $filters = $this->getGroupedExposedFilters();
569 $view = $this->getBasicPageView();
571 // Filter: Description, Operator: not_ends, Value: Beatles
572 $filters['description']['group_info']['default_group'] = 5;
573 $view->setDisplay('page_1');
574 $view->displayHandlers->get('page_1')->overrideOption('filters', $filters);
576 $this->container->get('router.builder')->rebuild();
578 $this->executeView($view);
587 // There is no Meredith returned because his description is empty
589 $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
592 public function testFilterStringNot() {
593 $view = Views::getView('test_view');
596 // Change the filtering
597 $view->displayHandlers->get('default')->overrideOption('filters', [
599 'id' => 'description',
600 'table' => 'views_test_data',
601 'field' => 'description',
602 'relationship' => 'none',
604 'value' => 'Beatles.',
608 $this->executeView($view);
616 // There is no Meredith returned because his description is empty
618 $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
622 public function testFilterStringGroupedExposedNot() {
623 $filters = $this->getGroupedExposedFilters();
624 $view = $this->getBasicPageView();
626 // Filter: Description, Operator: not (does not contains), Value: Beatles
627 $filters['description']['group_info']['default_group'] = 6;
628 $view->setDisplay('page_1');
629 $view->displayHandlers->get('page_1')->overrideOption('filters', $filters);
631 $this->container->get('router.builder')->rebuild();
633 $this->executeView($view);
642 // There is no Meredith returned because his description is empty
644 $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
648 public function testFilterStringShorter() {
649 $view = Views::getView('test_view');
652 // Change the filtering
653 $view->displayHandlers->get('default')->overrideOption('filters', [
656 'table' => 'views_test_data',
658 'relationship' => 'none',
659 'operator' => 'shorterthan',
664 $this->executeView($view);
673 $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
676 public function testFilterStringGroupedExposedShorter() {
677 $filters = $this->getGroupedExposedFilters();
678 $view = $this->getBasicPageView();
680 // Filter: Name, Operator: shorterthan, Value: 5
681 $filters['name']['group_info']['default_group'] = 4;
682 $view->setDisplay('page_1');
683 $view->displayHandlers->get('page_1')->overrideOption('filters', $filters);
685 $this->container->get('router.builder')->rebuild();
687 $this->executeView($view);
696 $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
699 public function testFilterStringLonger() {
700 $view = Views::getView('test_view');
703 // Change the filtering
704 $view->displayHandlers->get('default')->overrideOption('filters', [
707 'table' => 'views_test_data',
709 'relationship' => 'none',
710 'operator' => 'longerthan',
715 $this->executeView($view);
718 'name' => 'Meredith',
721 $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
724 public function testFilterStringGroupedExposedLonger() {
725 $filters = $this->getGroupedExposedFilters();
726 $view = $this->getBasicPageView();
728 // Filter: Name, Operator: longerthan, Value: 4
729 $filters['name']['group_info']['default_group'] = 5;
730 $view->setDisplay('page_1');
731 $view->displayHandlers->get('page_1')->overrideOption('filters', $filters);
733 $this->container->get('router.builder')->rebuild();
735 $this->executeView($view);
738 'name' => 'Meredith',
741 $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
745 public function testFilterStringEmpty() {
746 $view = Views::getView('test_view');
749 // Change the filtering
750 $view->displayHandlers->get('default')->overrideOption('filters', [
752 'id' => 'description',
753 'table' => 'views_test_data',
754 'field' => 'description',
755 'relationship' => 'none',
756 'operator' => 'empty',
760 $this->executeView($view);
763 'name' => 'Meredith',
766 $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
769 public function testFilterStringGroupedExposedEmpty() {
770 $filters = $this->getGroupedExposedFilters();
771 $view = $this->getBasicPageView();
773 // Filter: Description, Operator: empty, Value:
774 $filters['description']['group_info']['default_group'] = 7;
775 $view->setDisplay('page_1');
776 $view->displayHandlers->get('page_1')->overrideOption('filters', $filters);
778 $this->container->get('router.builder')->rebuild();
780 $this->executeView($view);
783 'name' => 'Meredith',
786 $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
789 protected function getGroupedExposedFilters() {
793 'plugin_id' => 'string',
794 'table' => 'views_test_data',
796 'relationship' => 'none',
799 'operator' => 'name_op',
801 'identifier' => 'name',
803 'is_grouped' => TRUE,
806 'identifier' => 'name',
807 'default_group' => 'All',
810 'title' => 'Is Ringo',
815 'title' => 'Is not Ringo',
820 'title' => 'Contains ing',
821 'operator' => 'contains',
825 'title' => 'Shorter than 5 letters',
826 'operator' => 'shorterthan',
830 'title' => 'Longer than 7 letters',
831 'operator' => 'longerthan',
838 'id' => 'description',
839 'plugin_id' => 'string',
840 'table' => 'views_test_data',
841 'field' => 'description',
842 'relationship' => 'none',
845 'operator' => 'description_op',
846 'label' => 'description',
847 'identifier' => 'description',
849 'is_grouped' => TRUE,
851 'label' => 'description',
852 'identifier' => 'description',
853 'default_group' => 'All',
856 'title' => 'Contains the word: Actor',
857 'operator' => 'word',
861 'title' => 'Starts with George',
862 'operator' => 'starts',
866 'title' => 'Not Starts with: George',
867 'operator' => 'not_starts',
871 'title' => 'Ends with: Beatles',
872 'operator' => 'ends',
873 'value' => 'Beatles.',
876 'title' => 'Not Ends with: Beatles',
877 'operator' => 'not_ends',
878 'value' => 'Beatles.',
881 'title' => 'Does not contain: Beatles',
883 'value' => 'Beatles.',
886 'title' => 'Empty description',
887 'operator' => 'empty',