class DisplayApiTest

Same name in other branches
  1. 9 core/modules/field/tests/src/Kernel/DisplayApiTest.php \Drupal\Tests\field\Kernel\DisplayApiTest
  2. 8.9.x core/modules/field/tests/src/Kernel/DisplayApiTest.php \Drupal\Tests\field\Kernel\DisplayApiTest
  3. 11.x core/modules/field/tests/src/Kernel/DisplayApiTest.php \Drupal\Tests\field\Kernel\DisplayApiTest

Tests the field display API.

@group field

Hierarchy

Expanded class hierarchy of DisplayApiTest

File

core/modules/field/tests/src/Kernel/DisplayApiTest.php, line 18

Namespace

Drupal\Tests\field\Kernel
View source
class DisplayApiTest extends FieldKernelTestBase {
    
    /**
     * The field name to use in this test.
     *
     * @var string
     */
    protected $fieldName;
    
    /**
     * The field label to use in this test.
     *
     * @var string
     */
    protected $label;
    
    /**
     * The field cardinality to use in this test.
     *
     * @var int
     */
    protected $cardinality;
    
    /**
     * The field display options to use in this test.
     *
     * @var array
     */
    protected $displayOptions;
    
    /**
     * The test entity.
     *
     * @var \Drupal\Core\Entity\EntityInterface
     */
    protected $entity;
    
    /**
     * An array of random values, in the format expected for field values.
     *
     * @var array
     */
    protected $values;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'system',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        // Create a field and its storage.
        $this->fieldName = 'test_field';
        $this->label = $this->randomMachineName();
        $this->cardinality = 4;
        $field_storage = [
            'field_name' => $this->fieldName,
            'entity_type' => 'entity_test',
            'type' => 'test_field',
            'cardinality' => $this->cardinality,
        ];
        $field = [
            'field_name' => $this->fieldName,
            'entity_type' => 'entity_test',
            'bundle' => 'entity_test',
            'label' => $this->label,
        ];
        $this->displayOptions = [
            'default' => [
                'type' => 'field_test_default',
                'settings' => [
                    'test_formatter_setting' => $this->randomMachineName(),
                ],
            ],
            'teaser' => [
                'type' => 'field_test_default',
                'settings' => [
                    'test_formatter_setting' => $this->randomMachineName(),
                ],
            ],
        ];
        
        /** @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface $display_repository */
        $display_repository = \Drupal::service('entity_display.repository');
        FieldStorageConfig::create($field_storage)->save();
        FieldConfig::create($field)->save();
        // Create a display for the default view mode.
        $display_repository->getViewDisplay($field['entity_type'], $field['bundle'])
            ->setComponent($this->fieldName, $this->displayOptions['default'])
            ->save();
        // Create a display for the teaser view mode.
        EntityViewMode::create([
            'id' => 'entity_test.teaser',
            'label' => 'Teaser',
            'targetEntityType' => 'entity_test',
        ])->save();
        $display_repository->getViewDisplay($field['entity_type'], $field['bundle'], 'teaser')
            ->setComponent($this->fieldName, $this->displayOptions['teaser'])
            ->save();
        // Create an entity with values.
        $this->values = $this->_generateTestFieldValues($this->cardinality);
        $this->entity = EntityTest::create();
        $this->entity->{$this->fieldName}
            ->setValue($this->values);
        $this->entity
            ->save();
    }
    
    /**
     * Tests the FieldItemListInterface::view() method.
     */
    public function testFieldItemListView() : void {
        $items = $this->entity
            ->get($this->fieldName);
        \Drupal::service('theme_installer')->install([
            'stark',
        ]);
        $this->config('system.theme')
            ->set('default', 'stark')
            ->save();
        // No display settings: check that default display settings are used.
        $build = $items->view();
        $this->render($build);
        $settings = \Drupal::service('plugin.manager.field.formatter')->getDefaultSettings('field_test_default');
        $setting = $settings['test_formatter_setting'];
        $this->assertText($this->label, 'Label was displayed.');
        foreach ($this->values as $delta => $value) {
            $this->assertText($setting . '|' . $value['value'], new FormattableMarkup('Value @delta was displayed with expected setting.', [
                '@delta' => $delta,
            ]));
        }
        // Display settings: Check hidden field.
        $display = [
            'label' => 'hidden',
            'type' => 'field_test_multiple',
            'settings' => [
                'test_formatter_setting_multiple' => $this->randomMachineName(),
                'alter' => TRUE,
            ],
        ];
        $build = $items->view($display);
        $this->render($build);
        $setting = $display['settings']['test_formatter_setting_multiple'];
        $this->assertNoText($this->label, 'Label was not displayed.');
        $this->assertText('field_test_entity_display_build_alter', 'Alter fired, display passed.');
        $this->assertText('entity language is en', 'Language is placed onto the context.');
        $array = [];
        foreach ($this->values as $delta => $value) {
            $array[] = $delta . ':' . $value['value'];
        }
        $this->assertText($setting . '|' . implode('|', $array), 'Values were displayed with expected setting.');
        // Display settings: Check visually_hidden field.
        $display = [
            'label' => 'visually_hidden',
            'type' => 'field_test_multiple',
            'settings' => [
                'test_formatter_setting_multiple' => $this->randomMachineName(),
                'alter' => TRUE,
            ],
        ];
        $build = $items->view($display);
        $this->render($build);
        $setting = $display['settings']['test_formatter_setting_multiple'];
        $this->assertRaw('visually-hidden', 'Label was visually hidden.');
        $this->assertText('field_test_entity_display_build_alter', 'Alter fired, display passed.');
        $this->assertText('entity language is en', 'Language is placed onto the context.');
        $array = [];
        foreach ($this->values as $delta => $value) {
            $array[] = $delta . ':' . $value['value'];
        }
        $this->assertText($setting . '|' . implode('|', $array), 'Values were displayed with expected setting.');
        // Check the prepare_view steps are invoked.
        $display = [
            'label' => 'hidden',
            'type' => 'field_test_with_prepare_view',
            'settings' => [
                'test_formatter_setting_additional' => $this->randomMachineName(),
            ],
        ];
        $build = $items->view($display);
        $this->render($build);
        $setting = $display['settings']['test_formatter_setting_additional'];
        $this->assertNoText($this->label, 'Label was not displayed.');
        $this->assertNoText('field_test_entity_display_build_alter', 'Alter not fired.');
        foreach ($this->values as $delta => $value) {
            $this->assertText($setting . '|' . $value['value'] . '|' . ($value['value'] + 1), new FormattableMarkup('Value @delta was displayed with expected setting.', [
                '@delta' => $delta,
            ]));
        }
        // View mode: check that display settings specified in the display object
        // are used.
        $build = $items->view('teaser');
        $this->render($build);
        $setting = $this->displayOptions['teaser']['settings']['test_formatter_setting'];
        $this->assertText($this->label, 'Label was displayed.');
        foreach ($this->values as $delta => $value) {
            $this->assertText($setting . '|' . $value['value'], new FormattableMarkup('Value @delta was displayed with expected setting.', [
                '@delta' => $delta,
            ]));
        }
        // Unknown view mode: check that display settings for 'default' view mode
        // are used.
        $build = $items->view('unknown_view_mode');
        $this->render($build);
        $setting = $this->displayOptions['default']['settings']['test_formatter_setting'];
        $this->assertText($this->label, 'Label was displayed.');
        foreach ($this->values as $delta => $value) {
            $this->assertText($setting . '|' . $value['value'], new FormattableMarkup('Value @delta was displayed with expected setting.', [
                '@delta' => $delta,
            ]));
        }
    }
    
    /**
     * Tests the FieldItemInterface::view() method.
     */
    public function testFieldItemView() : void {
        // No display settings: check that default display settings are used.
        $settings = \Drupal::service('plugin.manager.field.formatter')->getDefaultSettings('field_test_default');
        $setting = $settings['test_formatter_setting'];
        foreach ($this->values as $delta => $value) {
            $item = $this->entity->{$this->fieldName}[$delta];
            $build = $item->view();
            $this->render($build);
            $this->assertText($setting . '|' . $value['value'], new FormattableMarkup('Value @delta was displayed with expected setting.', [
                '@delta' => $delta,
            ]));
        }
        // Check that explicit display settings are used.
        $display = [
            'type' => 'field_test_multiple',
            'settings' => [
                'test_formatter_setting_multiple' => $this->randomMachineName(),
            ],
        ];
        $setting = $display['settings']['test_formatter_setting_multiple'];
        foreach ($this->values as $delta => $value) {
            $item = $this->entity->{$this->fieldName}[$delta];
            $build = $item->view($display);
            $this->render($build);
            $this->assertText($setting . '|0:' . $value['value'], new FormattableMarkup('Value @delta was displayed with expected setting.', [
                '@delta' => $delta,
            ]));
        }
        // Check that prepare_view steps are invoked.
        $display = [
            'type' => 'field_test_with_prepare_view',
            'settings' => [
                'test_formatter_setting_additional' => $this->randomMachineName(),
            ],
        ];
        $setting = $display['settings']['test_formatter_setting_additional'];
        foreach ($this->values as $delta => $value) {
            $item = $this->entity->{$this->fieldName}[$delta];
            $build = $item->view($display);
            $this->render($build);
            $this->assertText($setting . '|' . $value['value'] . '|' . ($value['value'] + 1), new FormattableMarkup('Value @delta was displayed with expected setting.', [
                '@delta' => $delta,
            ]));
        }
        // View mode: check that display settings specified in the field are used.
        $setting = $this->displayOptions['teaser']['settings']['test_formatter_setting'];
        foreach ($this->values as $delta => $value) {
            $item = $this->entity->{$this->fieldName}[$delta];
            $build = $item->view('teaser');
            $this->render($build);
            $this->assertText($setting . '|' . $value['value'], new FormattableMarkup('Value @delta was displayed with expected setting.', [
                '@delta' => $delta,
            ]));
        }
        // Unknown view mode: check that display settings for 'default' view mode
        // are used.
        $setting = $this->displayOptions['default']['settings']['test_formatter_setting'];
        foreach ($this->values as $delta => $value) {
            $item = $this->entity->{$this->fieldName}[$delta];
            $build = $item->view('unknown_view_mode');
            $this->render($build);
            $this->assertText($setting . '|' . $value['value'], new FormattableMarkup('Value @delta was displayed with expected setting.', [
                '@delta' => $delta,
            ]));
        }
    }
    
    /**
     * Tests that the prepareView() formatter method still fires for empty values.
     */
    public function testFieldEmpty() : void {
        // Uses \Drupal\field_test\Plugin\Field\FieldFormatter\TestFieldEmptyFormatter.
        $display = [
            'label' => 'hidden',
            'type' => 'field_empty_test',
            'settings' => [
                'test_empty_string' => '**EMPTY FIELD**' . $this->randomMachineName(),
            ],
        ];
        // $this->entity is set by the setUp() method and by default contains 4
        // numeric values.  We only want to test the display of this one field.
        $build = $this->entity
            ->get($this->fieldName)
            ->view($display);
        $this->render($build);
        // The test field by default contains values, so should not display the
        // default "empty" text.
        $this->assertNoText($display['settings']['test_empty_string']);
        // Now remove the values from the test field and retest.
        $this->entity->{$this->fieldName} = [];
        $this->entity
            ->save();
        $build = $this->entity
            ->get($this->fieldName)
            ->view($display);
        $this->render($build);
        // This time, as the field values have been removed, we *should* show the
        // default "empty" text.
        $this->assertText($display['settings']['test_empty_string']);
    }

}

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. 1
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::assertFieldById protected function Asserts that a field exists with the given ID and value.
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::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
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::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if raw text IS NOT found escaped on loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
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::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
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::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
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.
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.
DisplayApiTest::$cardinality protected property The field cardinality to use in this test.
DisplayApiTest::$displayOptions protected property The field display options to use in this test.
DisplayApiTest::$entity protected property The test entity.
DisplayApiTest::$fieldName protected property The field name to use in this test.
DisplayApiTest::$label protected property The field label to use in this test.
DisplayApiTest::$modules protected static property Modules to install. Overrides FieldKernelTestBase::$modules
DisplayApiTest::$values protected property An array of random values, in the format expected for field values.
DisplayApiTest::setUp protected function Set the default field storage backend for fields created during tests. Overrides FieldKernelTestBase::setUp
DisplayApiTest::testFieldEmpty public function Tests that the prepareView() formatter method still fires for empty values.
DisplayApiTest::testFieldItemListView public function Tests the FieldItemListInterface::view() method.
DisplayApiTest::testFieldItemView public function Tests the FieldItemInterface::view() method.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
FieldKernelTestBase::$entityId protected property
FieldKernelTestBase::$fieldTestData protected property Bag of created field storages and fields.
FieldKernelTestBase::assertFieldValues protected function Assert that a field has the expected values in an entity.
FieldKernelTestBase::createFieldWithStorage protected function Create a field and an associated field storage.
FieldKernelTestBase::entitySaveReload protected function Saves and reloads an entity.
FieldKernelTestBase::entityValidateAndSave protected function Validate and save entity. Fail if violations are found.
FieldKernelTestBase::_generateTestFieldValues protected function Generate random values for a field_test field.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 6
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 3
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$keyValue protected property The key_value service that must persist between container rebuilds.
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes
that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes because they allow autoloading
of code from extensions. Running the test in a separate process isolates
this behavior from other tests. Subclasses should not override this
property.
KernelTestBase::$siteDirectory protected property
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. 7
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. 1
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. 2
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to install.
KernelTestBase::getModulesToEnable private 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 27
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::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::stop Deprecated protected function Stops test execution.
KernelTestBase::tearDown protected function 6
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get public function
KernelTestBase::__sleep public function Prevents serializing any properties.
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
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.
RandomGeneratorTrait::randomStringValidate Deprecated public function Callback for random string validation.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements Deprecated private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements Deprecated protected function Check module requirements for the Drupal use case.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.

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