class FieldEntityTest

Same name in this branch
  1. 11.x core/modules/views/tests/src/Functional/Entity/FieldEntityTest.php \Drupal\Tests\views\Functional\Entity\FieldEntityTest
Same name in other branches
  1. 9 core/modules/views/tests/src/Functional/Entity/FieldEntityTest.php \Drupal\Tests\views\Functional\Entity\FieldEntityTest
  2. 8.9.x core/modules/views/tests/src/Functional/Entity/FieldEntityTest.php \Drupal\Tests\views\Functional\Entity\FieldEntityTest
  3. 10 core/modules/views/tests/src/Functional/Entity/FieldEntityTest.php \Drupal\Tests\views\Functional\Entity\FieldEntityTest

Tests the field plugin base integration with the entity system.

@group views

Hierarchy

Expanded class hierarchy of FieldEntityTest

File

core/modules/views/tests/src/Kernel/Entity/FieldEntityTest.php, line 25

Namespace

Drupal\Tests\views\Kernel\Entity
View source
class FieldEntityTest extends ViewsKernelTestBase {
    use CommentTestTrait;
    use ContentTypeCreationTrait;
    
    /**
     * Views used by this test.
     *
     * @var array
     */
    public static $testViews = [
        'test_field_get_entity',
        'test_field_get_entity_null',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'node',
        'comment',
        'field',
        'text',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp($import_test_views = TRUE, $modules = [
        'views_test_config',
    ]) : void {
        parent::setUp(FALSE);
        $this->installConfig([
            'node',
            'comment',
        ]);
        $this->installEntitySchema('node');
        $this->installSchema('node', [
            'node_access',
        ]);
        $this->installEntitySchema('comment');
        $this->installEntitySchema('user');
        $this->installSchema('comment', [
            'comment_entity_statistics',
        ]);
        $this->createContentType([
            'type' => 'page',
        ]);
        $this->addDefaultCommentField('node', 'page');
        // Add an entity reference field for the test_field_get_entity_null view.
        FieldStorageConfig::create([
            'field_name' => 'field_test_reference',
            'type' => 'entity_reference',
            'entity_type' => 'node',
            'cardinality' => 1,
            'settings' => [
                'target_type' => 'node',
            ],
        ])->save();
        FieldConfig::create([
            'field_name' => 'field_test_reference',
            'entity_type' => 'node',
            'bundle' => 'page',
            'label' => 'field_test_reference',
            'settings' => [
                'handler' => 'default',
                'handler_settings' => [
                    'target_bundles' => [
                        'page' => 'page',
                    ],
                ],
            ],
        ])->save();
        ViewTestData::createTestViews(static::class, $modules);
    }
    
    /**
     * Tests the getEntity method.
     */
    public function testGetEntity() : void {
        // The view is a view of comments, their nodes and their authors, so there
        // are three layers of entities.
        $account = User::create([
            'name' => $this->randomMachineName(),
            'bundle' => 'user',
        ]);
        $account->save();
        $node = Node::create([
            'uid' => $account->id(),
            'type' => 'page',
            'title' => $this->randomString(),
        ]);
        $node->save();
        $comment = Comment::create([
            'uid' => $account->id(),
            'entity_id' => $node->id(),
            'entity_type' => 'node',
            'field_name' => 'comment',
        ]);
        $comment->save();
        $view = Views::getView('test_field_get_entity');
        $this->executeView($view);
        $row = $view->result[0];
        // Tests entities on the base level.
        $entity = $view->field['cid']
            ->getEntity($row);
        $this->assertEquals($comment->id(), $entity->id(), 'Make sure the right comment entity got loaded.');
        // Tests entities as relationship on first level.
        $entity = $view->field['nid']
            ->getEntity($row);
        $this->assertEquals($node->id(), $entity->id(), 'Make sure the right node entity got loaded.');
        // Tests entities as relationships on second level.
        $entity = $view->field['uid']
            ->getEntity($row);
        $this->assertEquals($account->id(), $entity->id(), 'Make sure the right user entity got loaded.');
    }
    
    /**
     * Tests the getEntity method returning NULL for an optional relationship.
     */
    public function testGetEntityNullEntityOptionalRelationship() : void {
        $nodeReference = Node::create([
            'type' => 'page',
            'title' => $this->randomString(),
            'status' => NodeInterface::PUBLISHED,
        ]);
        $nodeReference->save();
        $node = Node::create([
            'type' => 'page',
            'title' => $this->randomString(),
            'status' => NodeInterface::PUBLISHED,
            'field_test_reference' => [
                'target_id' => $nodeReference->id(),
            ],
        ]);
        $node->save();
        $view = Views::getView('test_field_get_entity_null');
        $this->executeView($view);
        // Second row will be $node.
        $row = $view->result[1];
        $entity = $view->field['nid']
            ->getEntity($row);
        $this->assertEquals($nodeReference->id(), $entity->id());
        // Tests optional relationships with NULL entities don't log an error.
        $nodeReference->delete();
        // Use a mock logger so we can check that no errors were logged.
        $loggerFactory = $this->createMock(LoggerChannelFactoryInterface::class);
        $loggerFactory->expects($this->never())
            ->method('get');
        $container = \Drupal::getContainer();
        $container->set('logger.factory', $loggerFactory);
        \Drupal::setContainer($container);
        $view = Views::getView('test_field_get_entity_null');
        $this->executeView($view);
        // First row will be $node since the other is now deleted.
        $row = $view->result[0];
        $this->assertNull($view->field['nid']
            ->getEntity($row));
    }

}

Members

Title Sort descending 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.
CommentTestTrait::addDefaultCommentField protected function Adds the default comment field to an entity.
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.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. 1
ExpectDeprecationTrait::expectDeprecation public function Adds an expected deprecation.
ExpectDeprecationTrait::getCallableName private static function Returns a callable as a string suitable for inclusion in a message.
ExpectDeprecationTrait::setUpErrorHandler public function Sets up the test error handler.
ExpectDeprecationTrait::tearDownErrorHandler public function Tears down the test error handler.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
FieldEntityTest::$modules protected static property Modules to install. Overrides ViewsKernelTestBase::$modules
FieldEntityTest::$testViews public static property Views used by this test. Overrides ViewsKernelTestBase::$testViews
FieldEntityTest::setUp protected function Overrides ViewsKernelTestBase::setUp
FieldEntityTest::testGetEntity public function Tests the getEntity method.
FieldEntityTest::testGetEntityNullEntityOptionalRelationship public function Tests the getEntity method returning NULL for an optional relationship.
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. 4
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$keyValue protected property The key_value service that must persist between container rebuilds.
KernelTestBase::$root protected property The app root.
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. 3
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::tearDown protected function 7
KernelTestBase::tearDownCloseDatabaseConnection public function Additional tear down method to close the connection at the end.
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__construct public function
KernelTestBase::__sleep public function Prevents serializing any properties.
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.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
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. 10
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. 7
ViewsKernelTestBase::setUpFixtures protected function Sets up the configuration and schema of views and views_test_data modules. 6
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.