class RearrangeFieldsTest in Drupal 10

Tests the reordering of fields via AJAX.

@group views_ui

Hierarchy

• class \Drupal\Tests\BrowserTestBase extends \PHPUnit\Framework\TestCase uses \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, \Drupal\Tests\PhpUnitCompatibilityTrait, FunctionalTestSetupTrait, TestSetupTrait, BlockCreationTrait, ConfigTestTrait, ExtensionListTestTrait, ContentTypeCreationTrait, NodeCreationTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings, UiHelperTrait, UserCreationTrait, XdebugRequestTrait
  • class \Drupal\Tests\views\Functional\ViewTestBase uses ViewResultAssertionTrait
    • class \Drupal\Tests\views_ui\Functional\UITestBase
      • class \Drupal\Tests\views_ui\Functional\RearrangeFieldsTest

See also

\Drupal\views_ui\Form\Ajax\Rearrange

File

core/modules/views_ui/tests/src/Functional/RearrangeFieldsTest.php, line 13

Namespace

Drupal\Tests\views_ui\Functional

class RearrangeFieldsTest extends UITestBase {

  /**
   * Views used by this test.
   *
   * @var array
   */
  public static $testViews = [
    'test_view',
  ];

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'stark';

  /**
   * Gets the fields from the View.
   */
  protected function getViewFields($view_name = 'test_view', $display_id = 'default') {
    $view = Views::getView($view_name);
    $view
      ->setDisplay($display_id);
    $fields = [];
    foreach ($view->displayHandlers
      ->get('default')
      ->getHandlers('field') as $field => $handler) {
      $fields[] = $field;
    }
    return $fields;
  }

  /**
   * Check if the fields are in the correct order.
   *
   * @param string $view_name
   *   The name of the view.
   * @param array $fields
   *   Array of field names.
   *
   * @internal
   */
  protected function assertFieldOrder(string $view_name, array $fields) : void {
    $this
      ->drupalGet('admin/structure/views/nojs/rearrange/' . $view_name . '/default/field');
    foreach ($fields as $idx => $field) {
      $this
        ->assertSession()
        ->fieldValueEquals('edit-fields-' . $field . '-weight', $idx + 1);
    }
  }

  /**
   * Tests field sorting.
   */
  public function testRearrangeFields() {
    $view_name = 'test_view';

    // Checks that the order on the rearrange form matches the creation order.
    $this
      ->assertFieldOrder($view_name, $this
      ->getViewFields($view_name));

    // Checks that a field is not deleted if a value is not passed back.
    $fields = [];
    $this
      ->drupalGet('admin/structure/views/nojs/rearrange/' . $view_name . '/default/field');
    $this
      ->submitForm($fields, 'Apply');
    $this
      ->assertFieldOrder($view_name, $this
      ->getViewFields($view_name));

    // Checks that revers the new field order is respected.
    $reversedFields = array_reverse($this
      ->getViewFields($view_name));
    $fields = [];
    foreach ($reversedFields as $delta => $field) {
      $fields['fields[' . $field . '][weight]'] = $delta;
    }
    $fields_count = count($fields);
    $this
      ->drupalGet('admin/structure/views/nojs/rearrange/' . $view_name . '/default/field');
    $this
      ->submitForm($fields, 'Apply');
    $this
      ->assertFieldOrder($view_name, $reversedFields);

    // Checks that there is a remove link for each field.
    $this
      ->assertCount($fields_count, $this
      ->cssSelect('a.views-remove-link'));
  }

}