class LinkItemTest

Same name in other branches
  1. 9 core/modules/link/tests/src/Kernel/LinkItemTest.php \Drupal\Tests\link\Kernel\LinkItemTest
  2. 8.9.x core/modules/link/tests/src/Kernel/LinkItemTest.php \Drupal\Tests\link\Kernel\LinkItemTest
  3. 10 core/modules/link/tests/src/Kernel/LinkItemTest.php \Drupal\Tests\link\Kernel\LinkItemTest

Tests the new entity API for the link field type.

@group link

Hierarchy

Expanded class hierarchy of LinkItemTest

File

core/modules/link/tests/src/Kernel/LinkItemTest.php, line 22

Namespace

Drupal\Tests\link\Kernel
View source
class LinkItemTest extends FieldKernelTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'link',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        // Create a generic, external, and internal link fields for validation.
        FieldStorageConfig::create([
            'field_name' => 'field_test',
            'entity_type' => 'entity_test',
            'type' => 'link',
        ])->save();
        FieldConfig::create([
            'entity_type' => 'entity_test',
            'field_name' => 'field_test',
            'bundle' => 'entity_test',
            'settings' => [
                'link_type' => LinkItemInterface::LINK_GENERIC,
            ],
        ])->save();
        FieldStorageConfig::create([
            'field_name' => 'field_test_external',
            'entity_type' => 'entity_test',
            'type' => 'link',
        ])->save();
        FieldConfig::create([
            'entity_type' => 'entity_test',
            'field_name' => 'field_test_external',
            'bundle' => 'entity_test',
            'settings' => [
                'link_type' => LinkItemInterface::LINK_EXTERNAL,
            ],
        ])->save();
        FieldStorageConfig::create([
            'field_name' => 'field_test_internal',
            'entity_type' => 'entity_test',
            'type' => 'link',
        ])->save();
        FieldConfig::create([
            'entity_type' => 'entity_test',
            'field_name' => 'field_test_internal',
            'bundle' => 'entity_test',
            'settings' => [
                'link_type' => LinkItemInterface::LINK_INTERNAL,
            ],
        ])->save();
    }
    
    /**
     * Tests using entity fields of the link field type.
     */
    public function testLinkItem() : void {
        // Create entity.
        $entity = EntityTest::create();
        $url = 'https://www.drupal.org?test_param=test_value';
        $parsed_url = UrlHelper::parse($url);
        $title = $this->randomMachineName();
        $class = $this->randomMachineName();
        $entity->field_test->uri = $parsed_url['path'];
        $entity->field_test->title = $title;
        $entity->field_test
            ->first()
            ->get('options')
            ->set('query', $parsed_url['query']);
        $entity->field_test
            ->first()
            ->get('options')
            ->set('attributes', [
            'class' => $class,
        ]);
        $this->assertEquals([
            'query' => $parsed_url['query'],
            'attributes' => [
                'class' => $class,
            ],
            'external' => TRUE,
        ], $entity->field_test
            ->first()
            ->getUrl()
            ->getOptions());
        $entity->name->value = $this->randomMachineName();
        $entity->save();
        // Verify that the field value is changed.
        $id = $entity->id();
        $entity = EntityTest::load($id);
        $this->assertInstanceOf(FieldItemListInterface::class, $entity->field_test);
        $this->assertInstanceOf(FieldItemInterface::class, $entity->field_test[0]);
        $this->assertEquals($parsed_url['path'], $entity->field_test->uri);
        $this->assertEquals($parsed_url['path'], $entity->field_test[0]->uri);
        $this->assertEquals($title, $entity->field_test->title);
        $this->assertEquals($title, $entity->field_test[0]->title);
        $this->assertEquals($title, $entity->field_test[0]
            ->getTitle());
        $this->assertEquals($class, $entity->field_test->options['attributes']['class']);
        $this->assertEquals($parsed_url['query'], $entity->field_test->options['query']);
        // Update only the entity name property to check if the link field data will
        // remain intact.
        $entity->name->value = $this->randomMachineName();
        $entity->save();
        $id = $entity->id();
        $entity = EntityTest::load($id);
        $this->assertEquals($parsed_url['path'], $entity->field_test->uri);
        $this->assertEquals($class, $entity->field_test->options['attributes']['class']);
        $this->assertEquals($parsed_url['query'], $entity->field_test->options['query']);
        // Verify changing the field value.
        $new_url = 'https://www.drupal.org';
        $new_title = $this->randomMachineName();
        $new_class = $this->randomMachineName();
        $entity->field_test->uri = $new_url;
        $entity->field_test->title = $new_title;
        $entity->field_test
            ->first()
            ->get('options')
            ->set('query', NULL);
        $entity->field_test
            ->first()
            ->get('options')
            ->set('attributes', [
            'class' => $new_class,
        ]);
        $this->assertEquals($new_url, $entity->field_test->uri);
        $this->assertEquals($new_title, $entity->field_test->title);
        $this->assertEquals($new_class, $entity->field_test->options['attributes']['class']);
        $this->assertNull($entity->field_test->options['query']);
        // Read changed entity and assert changed values.
        $entity->save();
        $entity = EntityTest::load($id);
        $this->assertEquals($new_url, $entity->field_test->uri);
        $this->assertEquals($new_title, $entity->field_test->title);
        $this->assertEquals($new_class, $entity->field_test->options['attributes']['class']);
        // Check that if we only set uri the default values for title and options
        // are also initialized.
        $entity->field_test = [
            'uri' => 'internal:/node/add',
        ];
        $this->assertEquals('internal:/node/add', $entity->field_test->uri);
        $this->assertNull($entity->field_test->title);
        $this->assertSame([], $entity->field_test->options);
        // Check that if we set uri and options then the default values are properly
        // initialized.
        $entity->field_test = [
            'uri' => 'internal:/node/add',
            'options' => [
                'query' => NULL,
            ],
        ];
        $this->assertEquals('internal:/node/add', $entity->field_test->uri);
        $this->assertNull($entity->field_test->title);
        $this->assertNull($entity->field_test->options['query']);
        // Check that if we set the direct value of link field it correctly set the
        // uri and the default values of the field.
        $entity->field_test = 'internal:/node/add';
        $this->assertEquals('internal:/node/add', $entity->field_test->uri);
        $this->assertNull($entity->field_test->title);
        $this->assertSame([], $entity->field_test->options);
        // Check that setting options to NULL does not trigger an error when
        // calling getUrl();
        $entity->field_test->options = NULL;
        $this->assertInstanceOf(Url::class, $entity->field_test[0]
            ->getUrl());
        // Check that setting LinkItem value NULL doesn't generate any error or
        // warning.
        $entity->field_test[0] = NULL;
        $this->assertNull($entity->field_test[0]
            ->getValue());
        // Test the generateSampleValue() method for generic, external, and internal
        // link types.
        $entity = EntityTest::create();
        $entity->field_test
            ->generateSampleItems();
        $entity->field_test_external
            ->generateSampleItems();
        $entity->field_test_internal
            ->generateSampleItems();
        $this->entityValidateAndSave($entity);
    }

}

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 Deprecated 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 Deprecated 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 Deprecated 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 Deprecated protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById Deprecated protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName Deprecated protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath Deprecated protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked Deprecated 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 Deprecated protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion Deprecated protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption Deprecated protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected Deprecated 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 Deprecated 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 Deprecated protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected Deprecated protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector Deprecated 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 Deprecated 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 Deprecated protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper Deprecated 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.
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.
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::$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. 2
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 28
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. 3
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.
LinkItemTest::$modules protected static property Overrides FieldKernelTestBase::$modules
LinkItemTest::setUp protected function Overrides FieldKernelTestBase::setUp
LinkItemTest::testLinkItem public function Tests using entity fields of the link field type.
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.

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