class FieldRenderedEntityTest

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

Tests the core Drupal\views\Plugin\views\field\RenderedEntity handler.

@group views

Hierarchy

Expanded class hierarchy of FieldRenderedEntityTest

File

core/modules/views/tests/src/Kernel/Handler/FieldRenderedEntityTest.php, line 23

Namespace

Drupal\Tests\views\Kernel\Handler
View source
class FieldRenderedEntityTest extends ViewsKernelTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'entity_test',
        'field',
    ];
    
    /**
     * Views used by this test.
     *
     * @var array
     */
    public static $testViews = [
        'test_field_entity_test_rendered',
    ];
    
    /**
     * The logged in user.
     *
     * @var \Drupal\user\UserInterface
     */
    protected $user;
    
    /**
     * {@inheritdoc}
     */
    protected function setUpFixtures() {
        $this->installEntitySchema('user');
        $this->installEntitySchema('entity_test');
        $this->installConfig([
            'entity_test',
        ]);
        // Create user 1 so that the user created later in the test has a different
        // user ID.
        // @todo Remove in https://www.drupal.org/node/540008.
        User::create([
            'uid' => 1,
            'name' => 'user1',
        ])->save();
        EntityViewMode::create([
            'id' => 'entity_test.foobar',
            'targetEntityType' => 'entity_test',
            'status' => TRUE,
            'enabled' => TRUE,
            'label' => 'My view mode',
        ])->save();
        $display = EntityViewDisplay::create([
            'targetEntityType' => 'entity_test',
            'bundle' => 'entity_test',
            'mode' => 'foobar',
            'label' => 'My view mode',
            'status' => TRUE,
        ]);
        $display->save();
        $field_storage = FieldStorageConfig::create([
            'field_name' => 'test_field',
            'entity_type' => 'entity_test',
            'type' => 'string',
        ]);
        $field_storage->save();
        $field_config = FieldConfig::create([
            'field_name' => 'test_field',
            'entity_type' => 'entity_test',
            'bundle' => 'entity_test',
        ]);
        $field_config->save();
        // Create some test entities.
        for ($i = 1; $i <= 3; $i++) {
            EntityTest::create([
                'name' => "Article title {$i}",
                'test_field' => "Test {$i}",
            ])->save();
        }
        Role::create([
            'id' => 'test_role',
            'label' => 'Can view test entities',
            'permissions' => [
                'view test entity',
            ],
        ])->save();
        $this->user = User::create([
            'name' => 'test user',
            'roles' => [
                'test_role',
            ],
        ]);
        $this->user
            ->save();
        parent::setUpFixtures();
    }
    
    /**
     * Tests the default rendered entity output.
     */
    public function testRenderedEntityWithoutAndWithField() : void {
        // First test without test_field displayed.
        \Drupal::currentUser()->setAccount($this->user);
        $display = EntityViewDisplay::load('entity_test.entity_test.foobar');
        $display->removeComponent('test_field')
            ->save();
        $view = Views::getView('test_field_entity_test_rendered');
        $build = [
            '#type' => 'view',
            '#name' => 'test_field_entity_test_rendered',
            '#view' => $view,
            '#display_id' => 'default',
        ];
        $renderer = \Drupal::service('renderer');
        $renderer->renderInIsolation($build);
        for ($i = 1; $i <= 3; $i++) {
            $view_field = (string) $view->style_plugin
                ->getField($i - 1, 'rendered_entity');
            $search_result = str_contains($view_field, "Test {$i}");
            $this->assertFalse($search_result, "The text 'Test {$i}' not found in the view.");
        }
        $this->assertConfigDependencies($view->storage);
        $this->assertCacheabilityMetadata($build);
        // Now show the test_field on the entity_test.entity_test.foobar view
        // display to confirm render is updated correctly.
        $display->setComponent('test_field', [
            'type' => 'string',
            'label' => 'above',
        ])
            ->save();
        // Need to reload the view because the rendered fields are statically cached
        // in the object.
        $view = Views::getView('test_field_entity_test_rendered');
        $build = [
            '#type' => 'view',
            '#name' => 'test_field_entity_test_rendered',
            '#view' => $view,
            '#display_id' => 'default',
        ];
        $renderer->renderInIsolation($build);
        for ($i = 1; $i <= 3; $i++) {
            $view_field = (string) $view->style_plugin
                ->getField($i - 1, 'rendered_entity');
            $search_result = str_contains($view_field, "Test {$i}");
            $this->assertTrue($search_result, "The text 'Test {$i}' found in the view.");
        }
        $this->assertConfigDependencies($view->storage);
        $this->assertCacheabilityMetadata($build);
    }
    
    /**
     * Ensures that the expected cacheability metadata is applied.
     *
     * @param array $build
     *   The render array
     *
     * @internal
     */
    protected function assertCacheabilityMetadata(array $build) : void {
        $this->assertEqualsCanonicalizing([
            'config:views.view.test_field_entity_test_rendered',
            'entity_test:1',
            'entity_test:2',
            'entity_test:3',
            'entity_test_list',
            'entity_test_view',
        ], $build['#cache']['tags']);
        $this->assertEqualsCanonicalizing([
            'entity_test_view_grants',
            'languages:language_interface',
            'theme',
            'url.query_args',
            'user.permissions',
        ], $build['#cache']['contexts']);
    }
    
    /**
     * Ensures that the config dependencies are calculated the right way.
     *
     * @param \Drupal\views\Entity\View $storage
     *   The view storage.
     *
     * @internal
     */
    protected function assertConfigDependencies(View $storage) : void {
        $storage->calculateDependencies();
        $this->assertEquals([
            'config' => [
                'core.entity_view_mode.entity_test.foobar',
            ],
            'module' => [
                'entity_test',
            ],
        ], $storage->getDependencies());
    }

}

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.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
FieldRenderedEntityTest::$modules protected static property Modules to install. Overrides ViewsKernelTestBase::$modules
FieldRenderedEntityTest::$testViews public static property Views used by this test. Overrides ViewsKernelTestBase::$testViews
FieldRenderedEntityTest::$user protected property The logged in user.
FieldRenderedEntityTest::assertCacheabilityMetadata protected function Ensures that the expected cacheability metadata is applied.
FieldRenderedEntityTest::assertConfigDependencies protected function Ensures that the config dependencies are calculated the right way.
FieldRenderedEntityTest::setUpFixtures protected function Sets up the configuration and schema of views and views_test_data modules. Overrides ViewsKernelTestBase::setUpFixtures
FieldRenderedEntityTest::testRenderedEntityWithoutAndWithField public function Tests the default rendered entity output.
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.
ViewResultAssertionTrait::assertIdenticalResultset protected function Verifies that a result set returned by a View matches expected values.
ViewResultAssertionTrait::assertIdenticalResultsetHelper protected function Performs View result assertions.
ViewResultAssertionTrait::assertNotIdenticalResultset protected function Verifies that a result set returned by a View differs from certain values.
ViewsKernelTestBase::dataSet protected function Returns a very simple test dataset. 9
ViewsKernelTestBase::executeView protected function Executes a view.
ViewsKernelTestBase::orderResultSet protected function Orders a nested array containing a result set based on a given column.
ViewsKernelTestBase::schemaDefinition protected function Returns the schema definition. 6
ViewsKernelTestBase::setUp protected function Overrides KernelTestBase::setUp 76
ViewsKernelTestBase::viewsData protected function Returns the views data definition. 23

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