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);
225 public function testFilterStringGroupedExposedContains() {
226 $filters = $this->getGroupedExposedFilters();
227 $view = $this->getBasicPageView();
229 // Filter: Name, Operator: contains, Value: ing
230 $filters['name']['group_info']['default_group'] = '3';
231 $view->setDisplay('page_1');
232 $view->displayHandlers->get('page_1')->overrideOption('filters', $filters);
234 $this->container->get('router.builder')->rebuild();
236 $this->executeView($view);
244 $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
247 public function testFilterStringWord() {
248 $view = Views::getView('test_view');
251 // Change the filtering
252 $view->displayHandlers->get('default')->overrideOption('filters', [
254 'id' => 'description',
255 'table' => 'views_test_data',
256 'field' => 'description',
257 'relationship' => 'none',
258 'operator' => 'word',
263 $this->executeView($view);
272 $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
275 $view = Views::getView('test_view');
278 // Change the filtering
279 $view->displayHandlers->get('default')->overrideOption('filters', [
281 'id' => 'description',
282 'table' => 'views_test_data',
283 'field' => 'description',
284 'relationship' => 'none',
285 'operator' => 'allwords',
286 'value' => 'Richard Starkey',
290 $this->executeView($view);
296 $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
299 $view = Views::getView('test_view');
302 // Change the filtering to a sting containing only illegal characters.
303 $view->displayHandlers->get('default')->overrideOption('filters', [
305 'id' => 'description',
306 'table' => 'views_test_data',
307 'field' => 'description',
308 'relationship' => 'none',
309 'operator' => 'allwords',
314 $this->executeView($view);
329 'name' => 'Meredith',
332 $this->assertIdenticalResultset($view, $resultset);
335 public function testFilterStringGroupedExposedWord() {
336 $filters = $this->getGroupedExposedFilters();
337 $view = $this->getBasicPageView();
339 // Filter: Name, Operator: contains, Value: ing
340 $filters['name']['group_info']['default_group'] = '3';
341 $view->setDisplay('page_1');
342 $view->displayHandlers->get('page_1')->overrideOption('filters', $filters);
344 $this->container->get('router.builder')->rebuild();
346 $this->executeView($view);
354 $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
357 $filters = $this->getGroupedExposedFilters();
358 $view = $this->getBasicPageView();
360 // Filter: Description, Operator: contains, Value: actor
361 $filters['description']['group_info']['default_group'] = '1';
362 $view->setDisplay('page_1');
363 $view->displayHandlers->get('page_1')->overrideOption('filters', $filters);
365 $this->executeView($view);
374 $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
377 public function testFilterStringStarts() {
378 $view = Views::getView('test_view');
381 // Change the filtering
382 $view->displayHandlers->get('default')->overrideOption('filters', [
384 'id' => 'description',
385 'table' => 'views_test_data',
386 'field' => 'description',
387 'relationship' => 'none',
388 'operator' => 'starts',
393 $this->executeView($view);
399 $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
402 public function testFilterStringGroupedExposedStarts() {
403 $filters = $this->getGroupedExposedFilters();
404 $view = $this->getBasicPageView();
406 // Filter: Name, Operator: starts, Value: George
407 $filters['description']['group_info']['default_group'] = 2;
408 $view->setDisplay('page_1');
409 $view->displayHandlers->get('page_1')->overrideOption('filters', $filters);
411 $this->container->get('router.builder')->rebuild();
413 $this->executeView($view);
420 $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
423 public function testFilterStringNotStarts() {
424 $view = Views::getView('test_view');
427 // Change the filtering
428 $view->displayHandlers->get('default')->overrideOption('filters', [
430 'id' => 'description',
431 'table' => 'views_test_data',
432 'field' => 'description',
433 'relationship' => 'none',
434 'operator' => 'not_starts',
439 $this->executeView($view);
450 // There is no Meredith returned because his description is empty
452 $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
455 public function testFilterStringGroupedExposedNotStarts() {
456 $filters = $this->getGroupedExposedFilters();
457 $view = $this->getBasicPageView();
459 // Filter: Name, Operator: not_starts, Value: George
460 $filters['description']['group_info']['default_group'] = 3;
461 $view->setDisplay('page_1');
462 $view->displayHandlers->get('page_1')->overrideOption('filters', $filters);
464 $this->container->get('router.builder')->rebuild();
466 $this->executeView($view);
478 // There is no Meredith returned because his description is empty
480 $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
483 public function testFilterStringEnds() {
484 $view = Views::getView('test_view');
487 // Change the filtering
488 $view->displayHandlers->get('default')->overrideOption('filters', [
490 'id' => 'description',
491 'table' => 'views_test_data',
492 'field' => 'description',
493 'relationship' => 'none',
494 'operator' => 'ends',
495 'value' => 'Beatles.',
499 $this->executeView($view);
508 $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
511 public function testFilterStringGroupedExposedEnds() {
512 $filters = $this->getGroupedExposedFilters();
513 $view = $this->getBasicPageView();
515 // Filter: Description, Operator: ends, Value: Beatles
516 $filters['description']['group_info']['default_group'] = 4;
517 $view->setDisplay('page_1');
518 $view->displayHandlers->get('page_1')->overrideOption('filters', $filters);
520 $this->container->get('router.builder')->rebuild();
522 $this->executeView($view);
532 $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
535 public function testFilterStringNotEnds() {
536 $view = Views::getView('test_view');
539 // Change the filtering
540 $view->displayHandlers->get('default')->overrideOption('filters', [
542 'id' => 'description',
543 'table' => 'views_test_data',
544 'field' => 'description',
545 'relationship' => 'none',
546 'operator' => 'not_ends',
547 'value' => 'Beatles.',
551 $this->executeView($view);
559 // There is no Meredith returned because his description is empty
561 $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
564 public function testFilterStringGroupedExposedNotEnds() {
565 $filters = $this->getGroupedExposedFilters();
566 $view = $this->getBasicPageView();
568 // Filter: Description, Operator: not_ends, Value: Beatles
569 $filters['description']['group_info']['default_group'] = 5;
570 $view->setDisplay('page_1');
571 $view->displayHandlers->get('page_1')->overrideOption('filters', $filters);
573 $this->container->get('router.builder')->rebuild();
575 $this->executeView($view);
584 // There is no Meredith returned because his description is empty
586 $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
589 public function testFilterStringNot() {
590 $view = Views::getView('test_view');
593 // Change the filtering
594 $view->displayHandlers->get('default')->overrideOption('filters', [
596 'id' => 'description',
597 'table' => 'views_test_data',
598 'field' => 'description',
599 'relationship' => 'none',
601 'value' => 'Beatles.',
605 $this->executeView($view);
613 // There is no Meredith returned because his description is empty
615 $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
618 public function testFilterStringGroupedExposedNot() {
619 $filters = $this->getGroupedExposedFilters();
620 $view = $this->getBasicPageView();
622 // Filter: Description, Operator: not (does not contains), Value: Beatles
623 $filters['description']['group_info']['default_group'] = 6;
624 $view->setDisplay('page_1');
625 $view->displayHandlers->get('page_1')->overrideOption('filters', $filters);
627 $this->container->get('router.builder')->rebuild();
629 $this->executeView($view);
638 // There is no Meredith returned because his description is empty
640 $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
644 public function testFilterStringShorter() {
645 $view = Views::getView('test_view');
648 // Change the filtering
649 $view->displayHandlers->get('default')->overrideOption('filters', [
652 'table' => 'views_test_data',
654 'relationship' => 'none',
655 'operator' => 'shorterthan',
660 $this->executeView($view);
669 $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
672 public function testFilterStringGroupedExposedShorter() {
673 $filters = $this->getGroupedExposedFilters();
674 $view = $this->getBasicPageView();
676 // Filter: Name, Operator: shorterthan, Value: 5
677 $filters['name']['group_info']['default_group'] = 4;
678 $view->setDisplay('page_1');
679 $view->displayHandlers->get('page_1')->overrideOption('filters', $filters);
681 $this->container->get('router.builder')->rebuild();
683 $this->executeView($view);
692 $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
695 public function testFilterStringLonger() {
696 $view = Views::getView('test_view');
699 // Change the filtering
700 $view->displayHandlers->get('default')->overrideOption('filters', [
703 'table' => 'views_test_data',
705 'relationship' => 'none',
706 'operator' => 'longerthan',
711 $this->executeView($view);
714 'name' => 'Meredith',
717 $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
720 public function testFilterStringGroupedExposedLonger() {
721 $filters = $this->getGroupedExposedFilters();
722 $view = $this->getBasicPageView();
724 // Filter: Name, Operator: longerthan, Value: 4
725 $filters['name']['group_info']['default_group'] = 5;
726 $view->setDisplay('page_1');
727 $view->displayHandlers->get('page_1')->overrideOption('filters', $filters);
729 $this->container->get('router.builder')->rebuild();
731 $this->executeView($view);
734 'name' => 'Meredith',
737 $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
740 public function testFilterStringEmpty() {
741 $view = Views::getView('test_view');
744 // Change the filtering
745 $view->displayHandlers->get('default')->overrideOption('filters', [
747 'id' => 'description',
748 'table' => 'views_test_data',
749 'field' => 'description',
750 'relationship' => 'none',
751 'operator' => 'empty',
755 $this->executeView($view);
758 'name' => 'Meredith',
761 $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
764 public function testFilterStringGroupedExposedEmpty() {
765 $filters = $this->getGroupedExposedFilters();
766 $view = $this->getBasicPageView();
768 // Filter: Description, Operator: empty, Value:
769 $filters['description']['group_info']['default_group'] = 7;
770 $view->setDisplay('page_1');
771 $view->displayHandlers->get('page_1')->overrideOption('filters', $filters);
773 $this->container->get('router.builder')->rebuild();
775 $this->executeView($view);
778 'name' => 'Meredith',
781 $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
784 protected function getGroupedExposedFilters() {
788 'plugin_id' => 'string',
789 'table' => 'views_test_data',
791 'relationship' => 'none',
794 'operator' => 'name_op',
796 'identifier' => 'name',
798 'is_grouped' => TRUE,
801 'identifier' => 'name',
802 'default_group' => 'All',
805 'title' => 'Is Ringo',
810 'title' => 'Is not Ringo',
815 'title' => 'Contains ing',
816 'operator' => 'contains',
820 'title' => 'Shorter than 5 letters',
821 'operator' => 'shorterthan',
825 'title' => 'Longer than 7 letters',
826 'operator' => 'longerthan',
833 'id' => 'description',
834 'plugin_id' => 'string',
835 'table' => 'views_test_data',
836 'field' => 'description',
837 'relationship' => 'none',
840 'operator' => 'description_op',
841 'label' => 'description',
842 'identifier' => 'description',
844 'is_grouped' => TRUE,
846 'label' => 'description',
847 'identifier' => 'description',
848 'default_group' => 'All',
851 'title' => 'Contains the word: Actor',
852 'operator' => 'word',
856 'title' => 'Starts with George',
857 'operator' => 'starts',
861 'title' => 'Not Starts with: George',
862 'operator' => 'not_starts',
866 'title' => 'Ends with: Beatles',
867 'operator' => 'ends',
868 'value' => 'Beatles.',
871 'title' => 'Not Ends with: Beatles',
872 'operator' => 'not_ends',
873 'value' => 'Beatles.',
876 'title' => 'Does not contain: Beatles',
878 'value' => 'Beatles.',
881 'title' => 'Empty description',
882 'operator' => 'empty',