class FilterStringTest

Same name and namespace in other branches
  1. 11.x core/modules/views/tests/src/Kernel/Handler/FilterStringTest.php \Drupal\Tests\views\Kernel\Handler\FilterStringTest
  2. 10 core/modules/views/tests/src/Kernel/Handler/FilterStringTest.php \Drupal\Tests\views\Kernel\Handler\FilterStringTest
  3. 9 core/modules/views/tests/src/Kernel/Handler/FilterStringTest.php \Drupal\Tests\views\Kernel\Handler\FilterStringTest
  4. 8.9.x core/modules/views/tests/src/Kernel/Handler/FilterStringTest.php \Drupal\Tests\views\Kernel\Handler\FilterStringTest

Tests the core Drupal\views\Plugin\views\filter\StringFilter handler.

Attributes

#[Group('views')] #[RunTestsInSeparateProcesses]

Hierarchy

Expanded class hierarchy of FilterStringTest

File

core/modules/views/tests/src/Kernel/Handler/FilterStringTest.php, line 16

Namespace

Drupal\Tests\views\Kernel\Handler
View source
class FilterStringTest extends ViewsKernelTestBase {
  
  /**
   * Views used by this test.
   *
   * @var array
   */
  public static $testViews = [
    'test_view',
  ];
  
  /**
   * Map column names.
   *
   * @var array
   */
  protected $columnMap = [
    'views_test_data_name' => 'name',
  ];
  
  /**
   * Defines Views data for the custom entity.
   */
  public function viewsData() {
    $data = parent::viewsData();
    $data['views_test_data']['name']['filter']['allow empty'] = TRUE;
    $data['views_test_data']['job']['filter']['allow empty'] = FALSE;
    $data['views_test_data']['description'] = $data['views_test_data']['name'];
    return $data;
  }
  
  /**
   * {@inheritdoc}
   */
  protected function schemaDefinition() {
    $schema = parent::schemaDefinition();
    $schema['views_test_data']['fields']['description'] = [
      'description' => "A person's description",
      'type' => 'text',
      'not null' => FALSE,
      'size' => 'big',
    ];
    return $schema;
  }
  
  /**
   * An extended test dataset.
   */
  protected function dataSet() {
    $dataset = parent::dataSet();
    $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.';
    $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.';
    $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.';
    $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]';
    $dataset[4]['description'] = NULL;
    return $dataset;
  }
  
  /**
   * Build and return a Page view of the views_test_data table.
   *
   * @return \Drupal\views\ViewExecutable
   *   The page view object.
   */
  protected function getBasicPageView() {
    $view = Views::getView('test_view');
    // In order to test exposed filters, we have to disable
    // the exposed forms cache.
    \Drupal::service('views.exposed_form_cache')->reset();
    $view->newDisplay('page', 'Page', 'page_1');
    return $view;
  }
  
  /**
   * Tests the string filter with the 'equal' operator.
   */
  public function testFilterStringEqual() : void {
    $view = Views::getView('test_view');
    $view->setDisplay();
    // Change the filtering.
    $view->displayHandlers
      ->get('default')
      ->overrideOption('filters', [
      'name' => [
        'id' => 'name',
        'table' => 'views_test_data',
        'field' => 'name',
        'relationship' => 'none',
        'operator' => '=',
        'value' => 'Ringo',
      ],
    ]);
    $this->executeView($view);
    $resultset = [
      [
        'name' => 'Ringo',
      ],
    ];
    $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
    $view->destroy();
    // Get the original dataset.
    $data_set = $this->dataSet();
    // Adds a new data point in the views_test_data table.
    $query = Database::getConnection()->insert('views_test_data')
      ->fields(array_keys($data_set[0]));
    $query->values([
      'name' => 'Ringo%',
      'age' => 31,
      'job' => 'Drummer',
      'created' => gmmktime(6, 30, 10, 1, 1, 2000),
      'status' => 1,
      'description' => NULL,
    ]);
    $query->execute();
    $view = Views::getView('test_view');
    $view->setDisplay();
    // Change the filtering.
    $view->displayHandlers
      ->get('default')
      ->overrideOption('filters', [
      'name' => [
        'id' => 'name',
        'table' => 'views_test_data',
        'field' => 'name',
        'relationship' => 'none',
        'operator' => '=',
        'value' => 'Ringo%',
      ],
    ]);
    $this->executeView($view);
    $resultset = [
      [
        'name' => 'Ringo%',
      ],
    ];
    $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
  }
  
  /**
   * Returns a set of grouped exposed filters.
   */
  public function testFilterStringGroupedExposedEqual() : void {
    $filters = $this->getGroupedExposedFilters();
    $view = $this->getBasicPageView();
    // Filter: Name, Operator: =, Value: Ringo.
    $filters['name']['group_info']['default_group'] = 1;
    $view->setDisplay('page_1');
    $view->displayHandlers
      ->get('page_1')
      ->overrideOption('filters', $filters);
    $view->save();
    $this->executeView($view);
    $resultset = [
      [
        'name' => 'Ringo',
      ],
    ];
    $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
    // Test that leading and trailing whitespace in non-grouped exposed input is
    // trimmed before filtering.
    $view->destroy();
    $filters['name']['is_grouped'] = FALSE;
    $filters['name']['operator'] = '=';
    $view = $this->getBasicPageView();
    $view->setExposedInput([
      'name' => ' Ringo ',
    ]);
    $view->setDisplay('page_1');
    $view->displayHandlers
      ->get('page_1')
      ->overrideOption('filters', $filters);
    $view->save();
    $this->executeView($view);
    $this->assertIdenticalResultset($view, [
      [
        'name' => 'Ringo',
      ],
    ], $this->columnMap);
  }
  
  /**
   * Tests the string filter with the 'not equal' operator.
   */
  public function testFilterStringNotEqual() : void {
    $view = Views::getView('test_view');
    $view->setDisplay();
    // Change the filtering.
    $view->displayHandlers
      ->get('default')
      ->overrideOption('filters', [
      'name' => [
        'id' => 'name',
        'table' => 'views_test_data',
        'field' => 'name',
        'relationship' => 'none',
        'operator' => '!=',
        'value' => 'Ringo',
      ],
    ]);
    $this->executeView($view);
    $resultset = [
      [
        'name' => 'John',
      ],
      [
        'name' => 'George',
      ],
      [
        'name' => 'Paul',
      ],
      [
        'name' => 'Meredith',
      ],
    ];
    $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
  }
  
  /**
   * Tests grouped, exposed filtering with not equal operator.
   */
  public function testFilterStringGroupedExposedNotEqual() : void {
    $filters = $this->getGroupedExposedFilters();
    $view = $this->getBasicPageView();
    // Filter: Name, Operator: !=, Value: Ringo.
    $filters['name']['group_info']['default_group'] = '2';
    $view->setDisplay('page_1');
    $view->displayHandlers
      ->get('page_1')
      ->overrideOption('filters', $filters);
    $view->save();
    $this->executeView($view);
    $resultset = [
      [
        'name' => 'John',
      ],
      [
        'name' => 'George',
      ],
      [
        'name' => 'Paul',
      ],
      [
        'name' => 'Meredith',
      ],
    ];
    $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
  }
  
  /**
   * Tests the string filter with the 'contains' operator.
   */
  public function testFilterStringContains() : void {
    $view = Views::getView('test_view');
    $view->setDisplay();
    // Change the filtering.
    $view->displayHandlers
      ->get('default')
      ->overrideOption('filters', [
      'name' => [
        'id' => 'name',
        'table' => 'views_test_data',
        'field' => 'name',
        'relationship' => 'none',
        'operator' => 'contains',
        'value' => 'iNg',
      ],
    ]);
    $this->executeView($view);
    $resultset = [
      [
        'name' => 'Ringo',
      ],
    ];
    $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
  }
  
  /**
   * Tests grouped, exposed filtering with contains operator.
   */
  public function testFilterStringGroupedExposedContains() : void {
    $filters = $this->getGroupedExposedFilters();
    $view = $this->getBasicPageView();
    // Filter: Name, Operator: contains, Value: ing.
    $filters['name']['group_info']['default_group'] = '3';
    $view->setDisplay('page_1');
    $view->displayHandlers
      ->get('page_1')
      ->overrideOption('filters', $filters);
    $view->save();
    $this->executeView($view);
    $resultset = [
      [
        'name' => 'Ringo',
      ],
    ];
    $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
  }
  
  /**
   * Tests filtering by a word in the "description" field.
   */
  public function testFilterStringWord() : void {
    $view = Views::getView('test_view');
    $view->setDisplay();
    // Change the filtering.
    $view->displayHandlers
      ->get('default')
      ->overrideOption('filters', [
      'description' => [
        'id' => 'description',
        'table' => 'views_test_data',
        'field' => 'description',
        'relationship' => 'none',
        'operator' => 'word',
        'value' => 'aCtor',
      ],
    ]);
    $this->executeView($view);
    $resultset = [
      [
        'name' => 'George',
      ],
      [
        'name' => 'Ringo',
      ],
    ];
    $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
    $view->destroy();
    $view = Views::getView('test_view');
    $view->setDisplay();
    // Change the filtering.
    $view->displayHandlers
      ->get('default')
      ->overrideOption('filters', [
      'description' => [
        'id' => 'description',
        'table' => 'views_test_data',
        'field' => 'description',
        'relationship' => 'none',
        'operator' => 'allwords',
        'value' => 'Richard Starkey',
      ],
    ]);
    $this->executeView($view);
    $resultset = [
      [
        'name' => 'Ringo',
      ],
    ];
    $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
    $view->destroy();
    $view = Views::getView('test_view');
    $view->setDisplay();
    // Change the filtering to a sting containing only invalid characters.
    $view->displayHandlers
      ->get('default')
      ->overrideOption('filters', [
      'description' => [
        'id' => 'description',
        'table' => 'views_test_data',
        'field' => 'description',
        'relationship' => 'none',
        'operator' => 'allwords',
        'value' => ':-)',
      ],
    ]);
    $this->executeView($view);
    $resultset = [
      [
        'name' => 'Ringo',
      ],
      [
        'name' => 'John',
      ],
      [
        'name' => 'George',
      ],
      [
        'name' => 'Paul',
      ],
      [
        'name' => 'Meredith',
      ],
    ];
    $this->assertIdenticalResultset($view, $resultset);
  }
  
  /**
   * Tests grouped and exposed filters with word-based filtering.
   */
  public function testFilterStringGroupedExposedWord() : void {
    $filters = $this->getGroupedExposedFilters();
    $view = $this->getBasicPageView();
    // Filter: Name, Operator: contains, Value: ing.
    $filters['name']['group_info']['default_group'] = '3';
    $view->setDisplay('page_1');
    $view->displayHandlers
      ->get('page_1')
      ->overrideOption('filters', $filters);
    $view->save();
    $this->executeView($view);
    $resultset = [
      [
        'name' => 'Ringo',
      ],
    ];
    $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
    $view->destroy();
    $filters = $this->getGroupedExposedFilters();
    $view = $this->getBasicPageView();
    // Filter: Description, Operator: contains, Value: actor.
    $filters['description']['group_info']['default_group'] = '1';
    $view->setDisplay('page_1');
    $view->displayHandlers
      ->get('page_1')
      ->overrideOption('filters', $filters);
    $this->executeView($view);
    $resultset = [
      [
        'name' => 'George',
      ],
      [
        'name' => 'Ringo',
      ],
    ];
    $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
  }
  
  /**
   * Tests filtering by string using the "starts with" operator.
   */
  public function testFilterStringStarts() : void {
    $view = Views::getView('test_view');
    $view->setDisplay();
    // Change the filtering.
    $view->displayHandlers
      ->get('default')
      ->overrideOption('filters', [
      'description' => [
        'id' => 'description',
        'table' => 'views_test_data',
        'field' => 'description',
        'relationship' => 'none',
        'operator' => 'starts',
        'value' => 'gEorge',
      ],
    ]);
    $this->executeView($view);
    $resultset = [
      [
        'name' => 'George',
      ],
    ];
    $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
  }
  
  /**
   * Tests grouped and exposed filters with the "starts with" operator.
   */
  public function testFilterStringGroupedExposedStarts() : void {
    $filters = $this->getGroupedExposedFilters();
    $view = $this->getBasicPageView();
    // Filter: Name, Operator: starts, Value: George.
    $filters['description']['group_info']['default_group'] = 2;
    $view->setDisplay('page_1');
    $view->displayHandlers
      ->get('page_1')
      ->overrideOption('filters', $filters);
    $view->save();
    $this->executeView($view);
    $resultset = [
      [
        'name' => 'George',
      ],
    ];
    $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
  }
  
  /**
   * Tests the string filter with negated 'regular_expression' operator.
   */
  public function testFilterStringGroupedNotRegularExpression() : void {
    $filters = $this->getGroupedExposedFilters();
    $view = $this->getBasicPageView();
    // Filter: Name, Operator: not_regular_expression, Value: ^Rin.
    $filters['name']['group_info']['default_group'] = 6;
    $view->setDisplay('page_1');
    $view->displayHandlers
      ->get('page_1')
      ->overrideOption('filters', $filters);
    $view->save();
    $this->container
      ->get('router.builder')
      ->rebuild();
    $this->executeView($view);
    $resultset = [
      [
        'name' => 'John',
      ],
      [
        'name' => 'George',
      ],
      [
        'name' => 'Paul',
      ],
      [
        'name' => 'Meredith',
      ],
    ];
    $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
  }
  
  /**
   * Tests filtering by string using the "does not start with" operator.
   */
  public function testFilterStringNotStarts() : void {
    $view = Views::getView('test_view');
    $view->setDisplay();
    // Change the filtering.
    $view->displayHandlers
      ->get('default')
      ->overrideOption('filters', [
      'description' => [
        'id' => 'description',
        'table' => 'views_test_data',
        'field' => 'description',
        'relationship' => 'none',
        'operator' => 'not_starts',
        'value' => 'gEorge',
      ],
    ]);
    $this->executeView($view);
    $resultset = [
      [
        'name' => 'John',
      ],
      [
        'name' => 'Ringo',
      ],
      [
        'name' => 'Paul',
      ],
    ];
    $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
  }
  
  /**
   * Tests grouped and exposed filters with the "does not start with" operator.
   */
  public function testFilterStringGroupedExposedNotStarts() : void {
    $filters = $this->getGroupedExposedFilters();
    $view = $this->getBasicPageView();
    // Filter: Name, Operator: not_starts, Value: George.
    $filters['description']['group_info']['default_group'] = 3;
    $view->setDisplay('page_1');
    $view->displayHandlers
      ->get('page_1')
      ->overrideOption('filters', $filters);
    $view->save();
    $this->executeView($view);
    $resultset = [
      [
        'name' => 'John',
      ],
      [
        'name' => 'Ringo',
      ],
      [
        'name' => 'Paul',
      ],
    ];
    $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
  }
  
  /**
   * Tests filtering by string using the "ends with" operator.
   */
  public function testFilterStringEnds() : void {
    $view = Views::getView('test_view');
    $view->setDisplay();
    // Change the filtering.
    $view->displayHandlers
      ->get('default')
      ->overrideOption('filters', [
      'description' => [
        'id' => 'description',
        'table' => 'views_test_data',
        'field' => 'description',
        'relationship' => 'none',
        'operator' => 'ends',
        'value' => 'bEatles.',
      ],
    ]);
    $this->executeView($view);
    $resultset = [
      [
        'name' => 'George',
      ],
      [
        'name' => 'Ringo',
      ],
    ];
    $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
  }
  
  /**
   * Tests grouped and exposed filters with the "ends with" operator.
   */
  public function testFilterStringGroupedExposedEnds() : void {
    $filters = $this->getGroupedExposedFilters();
    $view = $this->getBasicPageView();
    // Filter: Description, Operator: ends, Value: Beatles.
    $filters['description']['group_info']['default_group'] = 4;
    $view->setDisplay('page_1');
    $view->displayHandlers
      ->get('page_1')
      ->overrideOption('filters', $filters);
    $view->save();
    $this->executeView($view);
    $resultset = [
      [
        'name' => 'George',
      ],
      [
        'name' => 'Ringo',
      ],
    ];
    $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
  }
  
  /**
   * Tests filtering by string using the "does not end with" operator.
   */
  public function testFilterStringNotEnds() : void {
    $view = Views::getView('test_view');
    $view->setDisplay();
    // Change the filtering.
    $view->displayHandlers
      ->get('default')
      ->overrideOption('filters', [
      'description' => [
        'id' => 'description',
        'table' => 'views_test_data',
        'field' => 'description',
        'relationship' => 'none',
        'operator' => 'not_ends',
        'value' => 'bEatles.',
      ],
    ]);
    $this->executeView($view);
    $resultset = [
      [
        'name' => 'John',
      ],
      [
        'name' => 'Paul',
      ],
    ];
    $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
  }
  
  /**
   * Tests grouped and exposed filters with the "does not end with" operator.
   */
  public function testFilterStringGroupedExposedNotEnds() : void {
    $filters = $this->getGroupedExposedFilters();
    $view = $this->getBasicPageView();
    // Filter: Description, Operator: not_ends, Value: Beatles.
    $filters['description']['group_info']['default_group'] = 5;
    $view->setDisplay('page_1');
    $view->displayHandlers
      ->get('page_1')
      ->overrideOption('filters', $filters);
    $view->save();
    $this->executeView($view);
    $resultset = [
      [
        'name' => 'John',
      ],
      [
        'name' => 'Paul',
      ],
    ];
    $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
  }
  
  /**
   * Tests filtering by string using the "does not contain" operator.
   */
  public function testFilterStringNot() : void {
    $view = Views::getView('test_view');
    $view->setDisplay();
    // Change the filtering.
    $view->displayHandlers
      ->get('default')
      ->overrideOption('filters', [
      'description' => [
        'id' => 'description',
        'table' => 'views_test_data',
        'field' => 'description',
        'relationship' => 'none',
        'operator' => 'not',
        'value' => 'bEatles.',
      ],
    ]);
    $this->executeView($view);
    $resultset = [
      [
        'name' => 'John',
      ],
      [
        'name' => 'Paul',
      ],
    ];
    $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
  }
  
  /**
   * Tests grouped and exposed filters with the "does not contain" operator.
   */
  public function testFilterStringGroupedExposedNot() : void {
    $filters = $this->getGroupedExposedFilters();
    $view = $this->getBasicPageView();
    // Filter: Description, Operator: not (does not contains), Value: Beatles.
    $filters['description']['group_info']['default_group'] = 6;
    $view->setDisplay('page_1');
    $view->displayHandlers
      ->get('page_1')
      ->overrideOption('filters', $filters);
    $view->save();
    $this->executeView($view);
    $resultset = [
      [
        'name' => 'John',
      ],
      [
        'name' => 'Paul',
      ],
    ];
    $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
  }
  
  /**
   * Tests filtering by string using the "shorter than" operator.
   */
  public function testFilterStringShorter() : void {
    $view = Views::getView('test_view');
    $view->setDisplay();
    // Change the filtering.
    $view->displayHandlers
      ->get('default')
      ->overrideOption('filters', [
      'name' => [
        'id' => 'name',
        'table' => 'views_test_data',
        'field' => 'name',
        'relationship' => 'none',
        'operator' => 'shorterthan',
        'value' => 5,
      ],
    ]);
    $this->executeView($view);
    $resultset = [
      [
        'name' => 'John',
      ],
      [
        'name' => 'Paul',
      ],
    ];
    $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
  }
  
  /**
   * Tests grouped and exposed filters with the "shorter than" operator.
   */
  public function testFilterStringGroupedExposedShorter() : void {
    $filters = $this->getGroupedExposedFilters();
    $view = $this->getBasicPageView();
    // Filter: Name, Operator: shorterthan, Value: 5.
    $filters['name']['group_info']['default_group'] = 4;
    $view->setDisplay('page_1');
    $view->displayHandlers
      ->get('page_1')
      ->overrideOption('filters', $filters);
    $view->save();
    $this->executeView($view);
    $resultset = [
      [
        'name' => 'John',
      ],
      [
        'name' => 'Paul',
      ],
    ];
    $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
  }
  
  /**
   * Tests filtering by string using the "longer than" operator.
   */
  public function testFilterStringLonger() : void {
    $view = Views::getView('test_view');
    $view->setDisplay();
    // Change the filtering.
    $view->displayHandlers
      ->get('default')
      ->overrideOption('filters', [
      'name' => [
        'id' => 'name',
        'table' => 'views_test_data',
        'field' => 'name',
        'relationship' => 'none',
        'operator' => 'longerthan',
        'value' => 7,
      ],
    ]);
    $this->executeView($view);
    $resultset = [
      [
        'name' => 'Meredith',
      ],
    ];
    $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
  }
  
  /**
   * Tests grouped and exposed filters with the "longer than" operator.
   */
  public function testFilterStringGroupedExposedLonger() : void {
    $filters = $this->getGroupedExposedFilters();
    $view = $this->getBasicPageView();
    // Filter: Name, Operator: longerthan, Value: 4.
    $filters['name']['group_info']['default_group'] = 5;
    $view->setDisplay('page_1');
    $view->displayHandlers
      ->get('page_1')
      ->overrideOption('filters', $filters);
    $view->save();
    $this->executeView($view);
    $resultset = [
      [
        'name' => 'Meredith',
      ],
    ];
    $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
  }
  
  /**
   * Tests filtering by string using the "empty" operator.
   */
  public function testFilterStringEmpty() : void {
    $view = Views::getView('test_view');
    $view->setDisplay();
    // Change the filtering.
    $view->displayHandlers
      ->get('default')
      ->overrideOption('filters', [
      'description' => [
        'id' => 'description',
        'table' => 'views_test_data',
        'field' => 'description',
        'relationship' => 'none',
        'operator' => 'empty',
      ],
    ]);
    $this->executeView($view);
    $resultset = [
      [
        'name' => 'Meredith',
      ],
    ];
    $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
  }
  
  /**
   * Tests grouped and exposed filters with the "empty" operator.
   */
  public function testFilterStringGroupedExposedEmpty() : void {
    $filters = $this->getGroupedExposedFilters();
    $view = $this->getBasicPageView();
    // Filter: Description, Operator: empty, Value:
    $filters['description']['group_info']['default_group'] = 7;
    $view->setDisplay('page_1');
    $view->displayHandlers
      ->get('page_1')
      ->overrideOption('filters', $filters);
    $view->save();
    $this->executeView($view);
    $resultset = [
      [
        'name' => 'Meredith',
      ],
    ];
    $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
  }
  
  /**
   * Tests the string filter handler with the negated 'regular_expression' operator.
   */
  public function testFilterStringNotRegularExpression() : void {
    $view = Views::getView('test_view');
    $view->setDisplay();
    // Filtering by regular expression pattern.
    $view->displayHandlers
      ->get('default')
      ->overrideOption('filters', [
      'age' => [
        'id' => 'name',
        'table' => 'views_test_data',
        'field' => 'name',
        'relationship' => 'none',
        'operator' => 'not_regular_expression',
        'value' => [
          'value' => '^Rin',
        ],
      ],
    ]);
    $this->executeView($view);
    $resultset = [
      [
        'name' => 'John',
        'age' => 25,
      ],
      [
        'name' => 'George',
        'age' => 27,
      ],
      [
        'name' => 'Paul',
        'age' => 26,
      ],
      [
        'name' => 'Meredith',
        'age' => 30,
      ],
    ];
    $this->assertIdenticalResultset($view, $resultset, $this->columnMap);
  }
  
  /**
   * Returns a set of grouped exposed filters.
   */
  protected function getGroupedExposedFilters() : array {
    $filters = [
      'name' => [
        'id' => 'name',
        'plugin_id' => 'string',
        'table' => 'views_test_data',
        'field' => 'name',
        'relationship' => 'none',
        'exposed' => TRUE,
        'expose' => [
          'operator' => 'name_op',
          'label' => 'name',
          'identifier' => 'name',
        ],
        'is_grouped' => TRUE,
        'group_info' => [
          'label' => 'name',
          'identifier' => 'name',
          'default_group' => 'All',
          'group_items' => [
            1 => [
              'title' => 'Is Ringo',
              'operator' => '=',
              'value' => 'Ringo',
            ],
            2 => [
              'title' => 'Is not Ringo',
              'operator' => '!=',
              'value' => 'Ringo',
            ],
            3 => [
              'title' => 'Contains ing',
              'operator' => 'contains',
              'value' => 'ing',
            ],
            4 => [
              'title' => 'Shorter than 5 letters',
              'operator' => 'shorterthan',
              'value' => 5,
            ],
            5 => [
              'title' => 'Longer than 7 letters',
              'operator' => 'longerthan',
              'value' => 7,
            ],
            6 => [
              'title' => 'Does not start with Rin',
              'operator' => 'not_regular_expression',
              'value' => '^Rin',
            ],
          ],
        ],
      ],
      'description' => [
        'id' => 'description',
        'plugin_id' => 'string',
        'table' => 'views_test_data',
        'field' => 'description',
        'relationship' => 'none',
        'exposed' => TRUE,
        'expose' => [
          'operator' => 'description_op',
          'label' => 'description',
          'identifier' => 'description',
        ],
        'is_grouped' => TRUE,
        'group_info' => [
          'label' => 'description',
          'identifier' => 'description',
          'default_group' => 'All',
          'group_items' => [
            1 => [
              'title' => 'Contains the word: Actor',
              'operator' => 'word',
              'value' => 'actor',
            ],
            2 => [
              'title' => 'Starts with George',
              'operator' => 'starts',
              'value' => 'George',
            ],
            3 => [
              'title' => 'Not Starts with: George',
              'operator' => 'not_starts',
              'value' => 'George',
            ],
            4 => [
              'title' => 'Ends with: Beatles',
              'operator' => 'ends',
              'value' => 'Beatles.',
            ],
            5 => [
              'title' => 'Not Ends with: Beatles',
              'operator' => 'not_ends',
              'value' => 'Beatles.',
            ],
            6 => [
              'title' => 'Does not contain: Beatles',
              'operator' => 'not',
              'value' => 'Beatles.',
            ],
            7 => [
              'title' => 'Empty description',
              'operator' => 'empty',
              'value' => '',
            ],
          ],
        ],
      ],
    ];
    return $filters;
  }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content.
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output enabled.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
BrowserHtmlDebugTrait::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received.
BrowserHtmlDebugTrait::getTestMethodCaller protected function Retrieves the current calling line in the class under test. 1
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
DrupalTestCaseTrait::$root protected property The Drupal root directory.
DrupalTestCaseTrait::checkErrorHandlerOnTearDown public function Checks the test error handler after test execution. 1
DrupalTestCaseTrait::getDrupalRoot Deprecated protected static function Returns the Drupal root directory. 1
DrupalTestCaseTrait::setDebugDumpHandler public static function Registers the dumper CLI handler when the DebugDump extension is enabled.
DrupalTestCaseTrait::setUpRoot final protected function Ensure that the $root property is set initially.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
FilterStringTest::$columnMap protected property Map column names.
FilterStringTest::$testViews public static property Views used by this test. Overrides ViewsKernelTestBase::$testViews
FilterStringTest::dataSet protected function An extended test dataset. Overrides ViewsKernelTestBase::dataSet
FilterStringTest::getBasicPageView protected function Build and return a Page view of the views_test_data table.
FilterStringTest::getGroupedExposedFilters protected function Returns a set of grouped exposed filters.
FilterStringTest::schemaDefinition protected function Returns the schema definition. Overrides ViewsKernelTestBase::schemaDefinition
FilterStringTest::testFilterStringContains public function Tests the string filter with the 'contains' operator.
FilterStringTest::testFilterStringEmpty public function Tests filtering by string using the "empty" operator.
FilterStringTest::testFilterStringEnds public function Tests filtering by string using the "ends with" operator.
FilterStringTest::testFilterStringEqual public function Tests the string filter with the 'equal' operator.
FilterStringTest::testFilterStringGroupedExposedContains public function Tests grouped, exposed filtering with contains operator.
FilterStringTest::testFilterStringGroupedExposedEmpty public function Tests grouped and exposed filters with the "empty" operator.
FilterStringTest::testFilterStringGroupedExposedEnds public function Tests grouped and exposed filters with the "ends with" operator.
FilterStringTest::testFilterStringGroupedExposedEqual public function Returns a set of grouped exposed filters.
FilterStringTest::testFilterStringGroupedExposedLonger public function Tests grouped and exposed filters with the "longer than" operator.
FilterStringTest::testFilterStringGroupedExposedNot public function Tests grouped and exposed filters with the "does not contain" operator.
FilterStringTest::testFilterStringGroupedExposedNotEnds public function Tests grouped and exposed filters with the "does not end with" operator.
FilterStringTest::testFilterStringGroupedExposedNotEqual public function Tests grouped, exposed filtering with not equal operator.
FilterStringTest::testFilterStringGroupedExposedNotStarts public function Tests grouped and exposed filters with the "does not start with" operator.
FilterStringTest::testFilterStringGroupedExposedShorter public function Tests grouped and exposed filters with the "shorter than" operator.
FilterStringTest::testFilterStringGroupedExposedStarts public function Tests grouped and exposed filters with the "starts with" operator.
FilterStringTest::testFilterStringGroupedExposedWord public function Tests grouped and exposed filters with word-based filtering.
FilterStringTest::testFilterStringGroupedNotRegularExpression public function Tests the string filter with negated 'regular_expression' operator.
FilterStringTest::testFilterStringLonger public function Tests filtering by string using the "longer than" operator.
FilterStringTest::testFilterStringNot public function Tests filtering by string using the "does not contain" operator.
FilterStringTest::testFilterStringNotEnds public function Tests filtering by string using the "does not end with" operator.
FilterStringTest::testFilterStringNotEqual public function Tests the string filter with the 'not equal' operator.
FilterStringTest::testFilterStringNotRegularExpression public function Tests the string filter handler with the negated 'regular_expression' operator.
FilterStringTest::testFilterStringNotStarts public function Tests filtering by string using the "does not start with" operator.
FilterStringTest::testFilterStringShorter public function Tests filtering by string using the "shorter than" operator.
FilterStringTest::testFilterStringStarts public function Tests filtering by string using the "starts with" operator.
FilterStringTest::testFilterStringWord public function Tests filtering by a word in the "description" field.
FilterStringTest::viewsData public function Defines Views data for the custom entity. Overrides ViewsKernelTestBase::viewsData
HttpKernelUiHelperTrait::$mink protected property Mink session manager.
HttpKernelUiHelperTrait::assertSession public function Returns WebAssert object.
HttpKernelUiHelperTrait::buildUrl protected function Builds a URL from a system path or a URL object.
HttpKernelUiHelperTrait::clickLink protected function Follows a link by complete name.
HttpKernelUiHelperTrait::drupalGet protected function Retrieves a Drupal path.
HttpKernelUiHelperTrait::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
HttpKernelUiHelperTrait::getNodeElementsByXpath protected function Performs an xpath search on the contents of the internal browser.
HttpKernelUiHelperTrait::getSession public function Returns Mink session.
HttpKernelUiHelperTrait::getUrl protected function Gets the current URL from the browser.
HttpKernelUiHelperTrait::initMink protected function Initializes Mink sessions.
HttpKernelUiHelperTrait::rebuildContainer protected function Rebuilds the container.
KernelTestBase::$classLoader protected property The class loader.
KernelTestBase::$configImporter protected property The configuration importer.
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 4
KernelTestBase::$container protected property The test container.
KernelTestBase::$databasePrefix protected property The test database prefix.
KernelTestBase::$keyValue protected property The key_value service that must persist between container rebuilds.
KernelTestBase::$siteDirectory protected property The relative path to the test site directory.
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 9
KernelTestBase::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 1
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel protected function Bootstraps a kernel for a test. 1
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test. 2
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 3
KernelTestBase::getDatabasePrefix public function Gets the database prefix used for test isolation.
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to install.
KernelTestBase::getModulesToEnable protected static function Returns the modules to install for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 42
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 3
KernelTestBase::tearDown protected function 10
KernelTestBase::tearDownCloseDatabaseConnection public function Additional tear down method to close the connection at the end.
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__sleep public function Prevents serializing any properties.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers.
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
ViewResultAssertionTrait::assertIdenticalResultset protected function Verifies that a result set returned by a View matches expected values.
ViewResultAssertionTrait::assertIdenticalResultsetHelper protected function Performs View result assertions.
ViewResultAssertionTrait::assertNotIdenticalResultset protected function Verifies that a result set returned by a View differs from certain values.
ViewsKernelTestBase::$modules protected static property Modules to install. Overrides KernelTestBase::$modules 99
ViewsKernelTestBase::executeView protected function Executes a view.
ViewsKernelTestBase::orderResultSet protected function Orders a nested array containing a result set based on a given column.
ViewsKernelTestBase::setUp protected function Overrides KernelTestBase::setUp 82
ViewsKernelTestBase::setUpFixtures protected function Sets up the configuration and schema of views and views_test_data modules. 6

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.