ExposedFormTest.php

<?php

/**
 * @file
 * Definition of Drupal\views\Tests\Plugin\ExposedFormTest.
 */
namespace Drupal\views\Tests\Plugin;

use Drupal\views\Tests\UI\UITestBase;

/**
 * Tests exposed forms.
 */
class ExposedFormTest extends UITestBase {

  /**
   * Views used by this test.
   *
   * @var array
   */
  public static $testViews = array(
    'test_reset_button',
    'test_exposed_admin_ui',
  );

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = array(
    'views_ui',
  );
  public static function getInfo() {
    return array(
      'name' => 'Exposed forms',
      'description' => 'Test exposed forms functionality.',
      'group' => 'Views Plugins',
    );
  }
  protected function setUp() {
    parent::setUp();
    $this
      ->drupalCreateContentType(array(
      'type' => 'article',
    ));
    $this
      ->drupalCreateContentType(array(
      'type' => 'page',
    ));

    // Create some random nodes.
    for ($i = 0; $i < 5; $i++) {
      $this
        ->drupalCreateNode();
    }
  }

  /**
   * Tests whether the reset button works on an expoed form.
   */
  public function testResetButton() {
    $this
      ->drupalGet('test_reset_button', array(
      'query' => array(
        'type' => 'article',
      ),
    ));

    // Test that the type has been set.
    $this
      ->assertFieldById('edit-type', 'article', 'Article type filter set.');

    // Test the reset works.
    $this
      ->drupalGet('test_reset_button', array(
      'query' => array(
        'op' => 'Reset',
      ),
    ));
    $this
      ->assertResponse(200);

    // Test the type has been reset.
    $this
      ->assertFieldById('edit-type', 'All', 'Article type filter has been reset.');
  }

  /**
   * Tests, whether and how the reset button can be renamed.
   */
  public function testRenameResetButton() {

    // Look at the page and check the label "reset".
    $this
      ->drupalGet('test_reset_button');

    // Rename the label of the reset button.
    $view = views_get_view('test_reset_button');
    $view
      ->setDisplay();
    $exposed_form = $view->display_handler
      ->getOption('exposed_form');
    $exposed_form['options']['reset_button_label'] = $expected_label = $this
      ->randomName();
    $exposed_form['options']['reset_button'] = TRUE;
    $view->display_handler
      ->setOption('exposed_form', $exposed_form);
    $view
      ->save();
    views_invalidate_cache();

    // Look whether ther reset button label changed.
    $this
      ->drupalGet('test_reset_button');
    $this
      ->assertResponse(200);
    $this
      ->helperButtonHasLabel('edit-reset', $expected_label);
  }

  /**
   * Tests the admin interface of exposed filter and sort items.
   */
  function testExposedAdminUi() {
    menu_router_rebuild();
    $edit = array();
    $this
      ->drupalGet('admin/structure/views/nojs/config-item/test_exposed_admin_ui/default/filter/type');

    // Be sure that the button is called exposed.
    $this
      ->helperButtonHasLabel('edit-options-expose-button-button', t('Expose filter'));

    // The first time the filter UI is displayed, the operator and the
    // value forms should be shown.
    $this
      ->assertFieldById('edit-options-operator-in', '', 'Operator In exists');
    $this
      ->assertFieldById('edit-options-operator-not-in', '', 'Operator Not In exists');
    $this
      ->assertFieldById('edit-options-value-page', '', 'Checkbox for Page exists');
    $this
      ->assertFieldById('edit-options-value-article', '', 'Checkbox for Article exists');

    // Click the Expose filter button.
    $this
      ->drupalPost('admin/structure/views/nojs/config-item/test_exposed_admin_ui/default/filter/type', $edit, t('Expose filter'));

    // Check the label of the expose button.
    $this
      ->helperButtonHasLabel('edit-options-expose-button-button', t('Hide filter'));

    // Check the label of the grouped exposed button
    $this
      ->helperButtonHasLabel('edit-options-group-button-button', t('Grouped filters'));

    // After exposing the filter, Operator and Value should be still here.
    $this
      ->assertFieldById('edit-options-operator-in', '', 'Operator In exists');
    $this
      ->assertFieldById('edit-options-operator-not-in', '', 'Operator Not In exists');
    $this
      ->assertFieldById('edit-options-value-page', '', 'Checkbox for Page exists');
    $this
      ->assertFieldById('edit-options-value-article', '', 'Checkbox for Article exists');

    // Check the validations of the filter handler.
    $edit = array();
    $edit['options[expose][identifier]'] = '';
    $this
      ->drupalPost(NULL, $edit, t('Apply'));
    $this
      ->assertText(t('The identifier is required if the filter is exposed.'));
    $edit = array();
    $edit['options[expose][identifier]'] = 'value';
    $this
      ->drupalPost(NULL, $edit, t('Apply'));
    $this
      ->assertText(t('This identifier is not allowed.'));

    // Now check the sort criteria.
    $this
      ->drupalGet('admin/structure/views/nojs/config-item/test_exposed_admin_ui/default/sort/created');
    $this
      ->helperButtonHasLabel('edit-options-expose-button-button', t('Expose sort'));
    $this
      ->assertNoFieldById('edit-options-expose-label', '', t('Make sure no label field is shown'));

    // Click the Grouped Filters button.
    $this
      ->drupalGet('admin/structure/views/nojs/config-item/test_exposed_admin_ui/default/filter/type');
    $this
      ->drupalPost(NULL, array(), t('Grouped filters'));

    // After click on 'Grouped Filters', the standard operator and value should
    // not be displayed.
    $this
      ->assertNoFieldById('edit-options-operator-in', '', 'Operator In not exists');
    $this
      ->assertNoFieldById('edit-options-operator-not-in', '', 'Operator Not In not exists');
    $this
      ->assertNoFieldById('edit-options-value-page', '', 'Checkbox for Page not exists');
    $this
      ->assertNoFieldById('edit-options-value-article', '', 'Checkbox for Article not exists');

    // Check that after click on 'Grouped Filters', a new button is shown to
    // add more items to the list.
    $this
      ->helperButtonHasLabel('edit-options-group-info-add-group', t('Add another item'));

    // Create a grouped filter
    $this
      ->drupalGet('admin/structure/views/nojs/config-item/test_exposed_admin_ui/default/filter/type');
    $edit = array();
    $edit["options[group_info][group_items][1][title]"] = 'Is Article';
    $edit["options[group_info][group_items][1][value][article]"] = 'article';
    $edit["options[group_info][group_items][2][title]"] = 'Is Page';
    $edit["options[group_info][group_items][2][value][page]"] = TRUE;
    $edit["options[group_info][group_items][3][title]"] = 'Is Page and Article';
    $edit["options[group_info][group_items][3][value][article]"] = TRUE;
    $edit["options[group_info][group_items][3][value][page]"] = TRUE;
    $this
      ->drupalPost(NULL, $edit, t('Apply'));

    // Validate that all the titles are defined for each group
    $this
      ->drupalGet('admin/structure/views/nojs/config-item/test_exposed_admin_ui/default/filter/type');
    $edit = array();
    $edit["options[group_info][group_items][1][title]"] = 'Is Article';
    $edit["options[group_info][group_items][1][value][article]"] = TRUE;

    // This should trigger an error
    $edit["options[group_info][group_items][2][title]"] = '';
    $edit["options[group_info][group_items][2][value][page]"] = TRUE;
    $edit["options[group_info][group_items][3][title]"] = 'Is Page and Article';
    $edit["options[group_info][group_items][3][value][article]"] = TRUE;
    $edit["options[group_info][group_items][3][value][page]"] = TRUE;
    $this
      ->drupalPost(NULL, $edit, t('Apply'));
    $this
      ->assertRaw(t('The title is required if value for this item is defined.'), t('Group items should have a title'));

    // Un-expose the filter.
    $this
      ->drupalGet('admin/structure/views/nojs/config-item/test_exposed_admin_ui/default/filter/type');
    $this
      ->drupalPost(NULL, array(), t('Hide filter'));

    // After Un-exposing the filter, Operator and Value should be shown again.
    $this
      ->assertFieldById('edit-options-operator-in', '', 'Operator In exists after hide filter');
    $this
      ->assertFieldById('edit-options-operator-not-in', '', 'Operator Not In exists after hide filter');
    $this
      ->assertFieldById('edit-options-value-page', '', 'Checkbox for Page exists after hide filter');
    $this
      ->assertFieldById('edit-options-value-article', '', 'Checkbox for Article exists after hide filter');

    // Click the Expose sort button.
    $edit = array();
    $this
      ->drupalPost('admin/structure/views/nojs/config-item/test_exposed_admin_ui/default/sort/created', $edit, t('Expose sort'));

    // Check the label of the expose button.
    $this
      ->helperButtonHasLabel('edit-options-expose-button-button', t('Hide sort'));
    $this
      ->assertFieldById('edit-options-expose-label', '', t('Make sure a label field is shown'));
  }

}