ExposedFormTest.php 13.1 KB
Newer Older
1 2
<?php

3
namespace Drupal\Tests\views\Functional\Plugin;
4

5
use Drupal\Component\Utility\Html;
6
use Drupal\entity_test\Entity\EntityTest;
7
use Drupal\Tests\system\Functional\Cache\AssertPageCacheContextsAndTagsTrait;
8
use Drupal\Tests\views\Functional\ViewTestBase;
9 10
use Drupal\views\ViewExecutable;
use Drupal\views\Views;
11
use Drupal\views\Entity\View;
12

13
/**
14 15 16
 * Tests exposed forms functionality.
 *
 * @group views
17
 */
18
class ExposedFormTest extends ViewTestBase {
19

20 21
  use AssertPageCacheContextsAndTagsTrait;

22 23 24 25 26
  /**
   * Views used by this test.
   *
   * @var array
   */
27
  public static $testViews = ['test_exposed_form_buttons', 'test_exposed_block', 'test_exposed_form_sort_items_per_page'];
28

29 30 31 32 33
  /**
   * Modules to enable.
   *
   * @var array
   */
34
  public static $modules = ['node', 'views_ui', 'block', 'entity_test'];
35

36 37
  protected function setUp($import_test_views = TRUE) {
    parent::setUp($import_test_views);
38

39 40
    $this->enableViewsTestModule();

41
    $this->drupalCreateContentType(['type' => 'article']);
42 43 44

    // Create some random nodes.
    for ($i = 0; $i < 5; $i++) {
45
      $this->drupalCreateNode(['type' => 'article']);
46 47 48
    }
  }

49 50 51 52
  /**
   * Tests the submit button.
   */
  public function testSubmitButton() {
53
    // Test the submit button value defaults to 'Apply'.
54 55
    $this->drupalGet('test_exposed_form_buttons');
    $this->assertResponse(200);
56
    $this->helperButtonHasLabel('edit-submit-test-exposed-form-buttons', t('Apply'));
57 58 59 60 61 62

    // Rename the label of the submit button.
    $view = Views::getView('test_exposed_form_buttons');
    $view->setDisplay();

    $exposed_form = $view->display_handler->getOption('exposed_form');
63
    $exposed_form['options']['submit_button'] = $expected_label = $this->randomMachineName();
64 65 66 67 68 69 70
    $view->display_handler->setOption('exposed_form', $exposed_form);
    $view->save();

    // Make sure the submit button label changed.
    $this->drupalGet('test_exposed_form_buttons');
    $this->helperButtonHasLabel('edit-submit-test-exposed-form-buttons', $expected_label);

71
    // Make sure an empty label uses the default 'Apply' button value too.
72 73 74 75 76 77 78 79
    $view = Views::getView('test_exposed_form_buttons');
    $view->setDisplay();

    $exposed_form = $view->display_handler->getOption('exposed_form');
    $exposed_form['options']['submit_button'] = '';
    $view->display_handler->setOption('exposed_form', $exposed_form);
    $view->save();

80
    // Make sure the submit button label shows 'Apply'.
81
    $this->drupalGet('test_exposed_form_buttons');
82
    $this->helperButtonHasLabel('edit-submit-test-exposed-form-buttons', t('Apply'));
83 84
  }

85 86 87 88 89 90 91 92
  /**
   * Tests the exposed form with a non-standard identifier.
   */
  public function testExposedIdentifier() {
    // Alter the identifier of the filter to a random string.
    $view = Views::getView('test_exposed_form_buttons');
    $view->setDisplay();
    $identifier = 'new_identifier';
93
    $view->displayHandlers->get('default')->overrideOption('filters', [
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
      'type' => [
        'exposed' => TRUE,
        'field' => 'type',
        'id' => 'type',
        'table' => 'node_field_data',
        'plugin_id' => 'in_operator',
        'entity_type' => 'node',
        'entity_field' => 'type',
        'expose' => [
          'identifier' => $identifier,
          'label' => 'Content: Type',
          'operator_id' => 'type_op',
          'reduce' => FALSE,
          'description' => 'Exposed overridden description'
        ],
      ]
110
    ]);
111
    $view->save();
112
    $this->drupalGet('test_exposed_form_buttons', ['query' => [$identifier => 'article']]);
113 114 115 116 117 118 119
    $this->assertFieldById(Html::getId('edit-' . $identifier), 'article', "Article type filter set with new identifier.");

    // Alter the identifier of the filter to a random string containing
    // restricted characters.
    $view = Views::getView('test_exposed_form_buttons');
    $view->setDisplay();
    $identifier = 'bad identifier';
120
    $view->displayHandlers->get('default')->overrideOption('filters', [
121
      'type' => [
122
        'exposed' => TRUE,
123 124 125 126 127 128 129 130 131 132 133 134 135 136
        'field' => 'type',
        'id' => 'type',
        'table' => 'node_field_data',
        'plugin_id' => 'in_operator',
        'entity_type' => 'node',
        'entity_field' => 'type',
        'expose' => [
          'identifier' => $identifier,
          'label' => 'Content: Type',
          'operator_id' => 'type_op',
          'reduce' => FALSE,
          'description' => 'Exposed overridden description'
        ],
      ]
137
    ]);
138 139 140 141 142 143 144 145 146 147
    $this->executeView($view);

    $errors = $view->validate();
    $expected = [
      'default' => ['This identifier has illegal characters.'],
      'page_1' => ['This identifier has illegal characters.'],
    ];
    $this->assertEqual($errors, $expected);
  }

148
  /**
149
   * Tests whether the reset button works on an exposed form.
150 151
   */
  public function testResetButton() {
152
    // Test the button is hidden when there is no exposed input.
153
    $this->drupalGet('test_exposed_form_buttons');
154 155
    $this->assertNoField('edit-reset');

156
    $this->drupalGet('test_exposed_form_buttons', ['query' => ['type' => 'article']]);
157 158 159 160
    // Test that the type has been set.
    $this->assertFieldById('edit-type', 'article', 'Article type filter set.');

    // Test the reset works.
161
    $this->drupalGet('test_exposed_form_buttons', ['query' => ['op' => 'Reset']]);
162 163 164
    $this->assertResponse(200);
    // Test the type has been reset.
    $this->assertFieldById('edit-type', 'All', 'Article type filter has been reset.');
165 166 167

    // Test the button is hidden after reset.
    $this->assertNoField('edit-reset');
168

169
    // Test the reset works with type set.
170
    $this->drupalGet('test_exposed_form_buttons', ['query' => ['type' => 'article', 'op' => 'Reset']]);
171 172 173
    $this->assertResponse(200);
    $this->assertFieldById('edit-type', 'All', 'Article type filter has been reset.');

174 175 176
    // Test the button is hidden after reset.
    $this->assertNoField('edit-reset');

177
    // Rename the label of the reset button.
178
    $view = Views::getView('test_exposed_form_buttons');
179
    $view->setDisplay();
180

181
    $exposed_form = $view->display_handler->getOption('exposed_form');
182
    $exposed_form['options']['reset_button_label'] = $expected_label = $this->randomMachineName();
183
    $exposed_form['options']['reset_button'] = TRUE;
184
    $view->display_handler->setOption('exposed_form', $exposed_form);
185 186
    $view->save();

187
    // Look whether the reset button label changed.
188
    $this->drupalGet('test_exposed_form_buttons', ['query' => ['type' => 'article']]);
189
    $this->assertResponse(200);
190 191 192 193

    $this->helperButtonHasLabel('edit-reset', $expected_label);
  }

194 195 196 197
  /**
   * Tests the exposed block functionality.
   */
  public function testExposedBlock() {
198
    $this->drupalCreateContentType(['type' => 'page']);
199 200 201 202 203 204
    $view = Views::getView('test_exposed_block');
    $view->setDisplay('page_1');
    $block = $this->drupalPlaceBlock('views_exposed_filter_block:test_exposed_block-page_1');
    $this->drupalGet('test_exposed_block');

    // Test there is an exposed form in a block.
205
    $xpath = $this->buildXPathQuery('//div[@id=:id]/form/@id', [':id' => Html::getUniqueId('block-' . $block->id())]);
206 207
    $result = $this->xpath($xpath);
    $this->assertEquals(1, count($result));
208 209

    // Test there is not an exposed form in the view page content area.
210
    $xpath = $this->buildXPathQuery('//div[@class="view-content"]/form/@id', [':id' => Html::getUniqueId('block-' . $block->id())]);
211 212 213
    $this->assertNoFieldByXpath($xpath, $this->getExpectedExposedFormId($view), 'No exposed form found in views content region.');

    // Test there is only one views exposed form on the page.
214
    $elements = $this->xpath('//form[@id=:id]', [':id' => $this->getExpectedExposedFormId($view)]);
215
    $this->assertEqual(count($elements), 1, 'One exposed form block found.');
216 217 218

    // Test that the correct option is selected after form submission.
    $this->assertCacheContext('url');
219
    $this->assertOptionSelected('edit-type', 'All');
220 221 222 223 224
    foreach (['All', 'article', 'page'] as $argument) {
      $this->drupalGet('test_exposed_block', ['query' => ['type' => $argument]]);
      $this->assertCacheContext('url');
      $this->assertOptionSelected('edit-type', $argument);
    }
225 226
  }

227 228 229 230
  /**
   * Test the input required exposed form type.
   */
  public function testInputRequired() {
231
    $view = View::load('test_exposed_form_buttons');
232 233 234 235 236 237
    $display = &$view->getDisplay('default');
    $display['display_options']['exposed_form']['type'] = 'input_required';
    $view->save();

    $this->drupalGet('test_exposed_form_buttons');
    $this->assertResponse(200);
238
    $this->helperButtonHasLabel('edit-submit-test-exposed-form-buttons', t('Apply'));
239 240 241 242 243

    // Ensure that no results are displayed.
    $rows = $this->xpath("//div[contains(@class, 'views-row')]");
    $this->assertEqual(count($rows), 0, 'No rows are displayed by default when no input is provided.');

244
    $this->drupalGet('test_exposed_form_buttons', ['query' => ['type' => 'article']]);
245 246 247 248 249 250

    // Ensure that results are displayed.
    $rows = $this->xpath("//div[contains(@class, 'views-row')]");
    $this->assertEqual(count($rows), 5, 'All rows are displayed by default when input is provided.');
  }

251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271
  /**
   * Test the "on demand text" for the input required exposed form type.
   */
  public function testTextInputRequired() {
    $view = Views::getView('test_exposed_form_buttons');
    $display = &$view->storage->getDisplay('default');
    $display['display_options']['exposed_form']['type'] = 'input_required';
    // Set up the "on demand text".
    // @see https://www.drupal.org/node/535868
    $on_demand_text = 'Select any filter and click Apply to see results.';
    $display['display_options']['exposed_form']['options']['text_input_required'] = $on_demand_text;
    $display['display_options']['exposed_form']['options']['text_input_required_format'] = filter_default_format();
    $view->save();

    // Ensure that the "on demand text" is displayed when no exposed filters are
    // applied.
    $this->drupalGet('test_exposed_form_buttons');
    $this->assertText('Select any filter and click Apply to see results.');

    // Ensure that the "on demand text" is not displayed when an exposed filter
    // is applied.
272
    $this->drupalGet('test_exposed_form_buttons', ['query' => ['type' => 'article']]);
273 274 275
    $this->assertNoText($on_demand_text);
  }

276 277 278 279 280 281 282 283 284 285 286 287 288
  /**
   * Tests exposed forms with exposed sort and items per page.
   */
  public function testExposedSortAndItemsPerPage() {
    for ($i = 0; $i < 50; $i++) {
      $entity = EntityTest::create([
      ]);
      $entity->save();
    }
    $contexts = [
      'languages:language_interface',
      'entity_test_view_grants',
      'theme',
289
      'url.query_args',
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322
      'languages:language_content'
    ];

    $this->drupalGet('test_exposed_form_sort_items_per_page');
    $this->assertCacheContexts($contexts);
    $this->assertIds(range(1, 10, 1));

    $this->drupalGet('test_exposed_form_sort_items_per_page', ['query' => ['sort_order' => 'DESC']]);
    $this->assertCacheContexts($contexts);
    $this->assertIds(range(50, 41, 1));

    $this->drupalGet('test_exposed_form_sort_items_per_page', ['query' => ['sort_order' => 'DESC', 'items_per_page' => 25]]);
    $this->assertCacheContexts($contexts);
    $this->assertIds(range(50, 26, 1));

    $this->drupalGet('test_exposed_form_sort_items_per_page', ['query' => ['sort_order' => 'DESC', 'items_per_page' => 25, 'offset' => 10]]);
    $this->assertCacheContexts($contexts);
    $this->assertIds(range(40, 16, 1));
  }

  /**
   * Checks whether the specified ids are the ones displayed in the view output.
   *
   * @param int[] $ids
   *   The ids to check.
   *
   * @return bool
   *   TRUE if ids match, FALSE otherwise.
   */
  protected function assertIds(array $ids) {
    $elements = $this->cssSelect('div.view-test-exposed-form-sort-items-per-page div.views-row span.field-content');
    $actual_ids = [];
    foreach ($elements as $element) {
323
      $actual_ids[] = (int) $element->getText();
324 325 326 327 328
    }

    return $this->assertIdentical($ids, $actual_ids);
  }

329 330 331 332 333 334 335 336 337 338
  /**
   * Returns a views exposed form ID.
   *
   * @param \Drupal\views\ViewExecutable $view
   *   The view to create an ID for.
   *
   * @return string
   *   The form ID.
   */
  protected function getExpectedExposedFormId(ViewExecutable $view) {
339
    return Html::cleanCssIdentifier('views-exposed-form-' . $view->storage->id() . '-' . $view->current_display);
340 341
  }

342 343 344 345 346 347 348 349
  /**
   * Tests a view which is rendered after a form with a validation error.
   */
  public function testFormErrorWithExposedForm() {
    $this->drupalGet('views_test_data_error_form_page');
    $this->assertResponse(200);
    $form = $this->cssSelect('form.views-exposed-form');
    $this->assertTrue($form, 'The exposed form element was found.');
350
    $this->assertRaw(t('Apply'), 'Ensure the exposed form is rendered before submitting the normal form.');
351 352
    $this->assertRaw('<div class="views-row">', 'Views result shown.');

353
    $this->drupalPostForm(NULL, [], t('Submit'));
354 355 356
    $this->assertResponse(200);
    $form = $this->cssSelect('form.views-exposed-form');
    $this->assertTrue($form, 'The exposed form element was found.');
357
    $this->assertRaw(t('Apply'), 'Ensure the exposed form is rendered after submitting the normal form.');
358 359 360
    $this->assertRaw('<div class="views-row">', 'Views result shown.');
  }

361
}