FieldUITest.php

Same filename in this branch
  1. 8.9.x core/modules/field_ui/tests/src/Unit/FieldUiTest.php
  2. 8.9.x core/modules/views_ui/tests/src/Functional/FieldUITest.php
Same filename in other branches
  1. 9 core/modules/field/tests/src/Functional/Views/FieldUITest.php
  2. 9 core/modules/field_ui/tests/src/Unit/FieldUiTest.php
  3. 9 core/modules/views_ui/tests/src/Functional/FieldUITest.php
  4. 10 core/modules/field/tests/src/Functional/Views/FieldUITest.php
  5. 10 core/modules/field_ui/tests/src/Unit/FieldUiTest.php
  6. 10 core/modules/views_ui/tests/src/Functional/FieldUITest.php
  7. 11.x core/modules/field/tests/src/Functional/Views/FieldUITest.php
  8. 11.x core/modules/field_ui/tests/src/Unit/FieldUiTest.php
  9. 11.x core/modules/views_ui/tests/src/Functional/FieldUITest.php

Namespace

Drupal\Tests\field\Functional\Views

File

core/modules/field/tests/src/Functional/Views/FieldUITest.php

View source
<?php

namespace Drupal\Tests\field\Functional\Views;

use Drupal\field\Entity\FieldConfig;
use Drupal\field\Entity\FieldStorageConfig;
use Drupal\views\Views;

/**
 * Tests the UI of the field field handler.
 *
 * @group field
 * @see \Drupal\field\Plugin\views\field\Field
 */
class FieldUITest extends FieldTestBase {
    
    /**
     * Views used by this test.
     *
     * @var array
     */
    public static $testViews = [
        'test_view_fieldapi',
    ];
    
    /**
     * Modules to enable.
     *
     * @var array
     */
    public static $modules = [
        'views_ui',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * A user with the 'administer views' permission.
     *
     * @var \Drupal\user\UserInterface
     */
    protected $account;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp($import_test_views = TRUE) {
        parent::setUp($import_test_views);
        $this->account = $this->drupalCreateUser([
            'administer views',
        ]);
        $this->drupalLogin($this->account);
        $this->setUpFieldStorages(1, 'text');
        $this->setUpFields();
    }
    
    /**
     * Tests basic field handler settings in the UI.
     */
    public function testHandlerUI() {
        $url = "admin/structure/views/nojs/handler/test_view_fieldapi/default/field/field_name_0";
        $this->drupalGet($url);
        // Tests the available formatter options.
        $result = $this->xpath('//select[@id=:id]/option', [
            ':id' => 'edit-options-type',
        ]);
        $options = array_map(function ($item) {
            return $item->getAttribute('value');
        }, $result);
        // @todo Replace this sort by assertArray once it's in.
        sort($options, SORT_STRING);
        $this->assertEqual($options, [
            'text_default',
            'text_trimmed',
        ], 'The text formatters for a simple text field appear as expected.');
        $this->drupalPostForm(NULL, [
            'options[type]' => 'text_trimmed',
        ], t('Apply'));
        $this->drupalGet($url);
        $this->assertOptionSelected('edit-options-type', 'text_trimmed');
        $random_number = rand(100, 400);
        $this->drupalPostForm(NULL, [
            'options[settings][trim_length]' => $random_number,
        ], t('Apply'));
        $this->drupalGet($url);
        $this->assertFieldByName('options[settings][trim_length]', $random_number, 'The formatter setting got saved.');
        // Save the view and test whether the settings are saved.
        $this->drupalPostForm('admin/structure/views/view/test_view_fieldapi', [], t('Save'));
        $view = Views::getView('test_view_fieldapi');
        $view->initHandlers();
        $this->assertEqual($view->field['field_name_0']->options['type'], 'text_trimmed');
        $this->assertEqual($view->field['field_name_0']->options['settings']['trim_length'], $random_number);
        // Now change the formatter back to 'default' which doesn't have any
        // settings. We want to ensure that the settings are empty then.
        $edit['options[type]'] = 'text_default';
        $this->drupalPostForm('admin/structure/views/nojs/handler/test_view_fieldapi/default/field/field_name_0', $edit, t('Apply'));
        $this->drupalPostForm('admin/structure/views/view/test_view_fieldapi', [], t('Save'));
        $view = Views::getView('test_view_fieldapi');
        $view->initHandlers();
        $this->assertEqual($view->field['field_name_0']->options['type'], 'text_default');
        $this->assertEqual($view->field['field_name_0']->options['settings'], []);
        // Ensure that the view depends on the field storage.
        $dependencies = \Drupal::service('config.manager')->findConfigEntityDependents('config', [
            $this->fieldStorages[0]
                ->getConfigDependencyName(),
        ]);
        $this->assertTrue(isset($dependencies['views.view.test_view_fieldapi']), 'The view is dependent on the field storage.');
    }
    
    /**
     * Tests the basic field handler form when aggregation is enabled.
     */
    public function testHandlerUIAggregation() {
        // Enable aggregation.
        $edit = [
            'group_by' => '1',
        ];
        $this->drupalPostForm('admin/structure/views/nojs/display/test_view_fieldapi/default/group_by', $edit, t('Apply'));
        $url = "admin/structure/views/nojs/handler/test_view_fieldapi/default/field/field_name_0";
        $this->drupalGet($url);
        $this->assertSession()
            ->statusCodeEquals(200);
        // Test the click sort column options.
        // Tests the available formatter options.
        $result = $this->xpath('//select[@id=:id]/option', [
            ':id' => 'edit-options-click-sort-column',
        ]);
        $options = array_map(function ($item) {
            return (string) $item->getAttribute('value');
        }, $result);
        sort($options, SORT_STRING);
        $this->assertEqual($options, [
            'format',
            'value',
        ], 'The expected sort field options were found.');
    }
    
    /**
     * Tests adding a boolean field filter handler.
     */
    public function testBooleanFilterHandler() {
        // Create a boolean field.
        $field_name = 'field_boolean';
        $field_storage = FieldStorageConfig::create([
            'field_name' => $field_name,
            'entity_type' => 'node',
            'type' => 'boolean',
        ]);
        $field_storage->save();
        $field = FieldConfig::create([
            'field_storage' => $field_storage,
            'bundle' => 'page',
        ]);
        $field->save();
        $url = "admin/structure/views/nojs/add-handler/test_view_fieldapi/default/filter";
        $this->drupalPostForm($url, [
            'name[node__' . $field_name . '.' . $field_name . '_value]' => TRUE,
        ], t('Add and configure @handler', [
            '@handler' => t('filter criteria'),
        ]));
        $this->assertSession()
            ->statusCodeEquals(200);
        // Verify that using a boolean field as a filter also results in using the
        // boolean plugin.
        $option = $this->xpath('//label[@for="edit-options-value-1"]');
        $this->assertEqual(t('True'), $option[0]->getText());
        $option = $this->xpath('//label[@for="edit-options-value-0"]');
        $this->assertEqual(t('False'), $option[0]->getText());
        // Expose the filter and see if the 'Any' option is added and if we can save
        // it.
        $this->drupalPostForm(NULL, [], 'Expose filter');
        $option = $this->xpath('//label[@for="edit-options-value-all"]');
        $this->assertEqual(t('- Any -'), $option[0]->getText());
        $this->drupalPostForm(NULL, [
            'options[value]' => 'All',
            'options[expose][required]' => FALSE,
        ], 'Apply');
        $this->drupalPostForm(NULL, [], 'Save');
        $this->drupalGet('/admin/structure/views/nojs/handler/test_view_fieldapi/default/filter/field_boolean_value');
        $this->assertFieldChecked('edit-options-value-all');
    }

}

Classes

Title Deprecated Summary
FieldUITest Tests the UI of the field field handler.

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