class FieldTypePluginManagerTest

Same name in this branch
  1. 10 core/tests/Drupal/Tests/Core/Field/FieldTypePluginManagerTest.php \Drupal\Tests\Core\Field\FieldTypePluginManagerTest
Same name in other branches
  1. 9 core/modules/field/tests/src/Kernel/FieldTypePluginManagerTest.php \Drupal\Tests\field\Kernel\FieldTypePluginManagerTest
  2. 8.9.x core/modules/field/tests/src/Kernel/FieldTypePluginManagerTest.php \Drupal\Tests\field\Kernel\FieldTypePluginManagerTest
  3. 11.x core/modules/field/tests/src/Kernel/FieldTypePluginManagerTest.php \Drupal\Tests\field\Kernel\FieldTypePluginManagerTest
  4. 11.x core/tests/Drupal/Tests/Core/Field/FieldTypePluginManagerTest.php \Drupal\Tests\Core\Field\FieldTypePluginManagerTest

Tests the field type manager.

@group field

Hierarchy

Expanded class hierarchy of FieldTypePluginManagerTest

File

core/modules/field/tests/src/Kernel/FieldTypePluginManagerTest.php, line 16

Namespace

Drupal\Tests\field\Kernel
View source
class FieldTypePluginManagerTest extends FieldKernelTestBase {
    
    /**
     * Tests the default settings convenience methods.
     */
    public function testDefaultSettings() : void {
        $field_type_manager = \Drupal::service('plugin.manager.field.field_type');
        foreach ([
            'test_field',
            'shape',
            'hidden_test_field',
        ] as $type) {
            $definition = $field_type_manager->getDefinition($type);
            $this->assertSame($field_type_manager->getDefaultStorageSettings($type), $definition['class']::defaultStorageSettings(), "{$type} storage settings were returned");
            $this->assertSame($field_type_manager->getDefaultFieldSettings($type), $definition['class']::defaultFieldSettings(), "{$type} field settings were returned");
        }
    }
    
    /**
     * Tests creation of field item instances.
     */
    public function testCreateInstance() : void {
        
        /** @var \Drupal\Core\Field\FieldTypePluginManagerInterface $field_type_manager */
        $field_type_manager = \Drupal::service('plugin.manager.field.field_type');
        foreach ([
            'test_field',
            'shape',
            'hidden_test_field',
        ] as $type) {
            $definition = $field_type_manager->getDefinition($type);
            $class = $definition['class'];
            $field_name = 'field_' . $type;
            $field_definition = BaseFieldDefinition::create($type);
            $configuration = [
                'field_definition' => $field_definition,
                'name' => $field_name,
                'parent' => NULL,
            ];
            $instance = $field_type_manager->createInstance($type, $configuration);
            $this->assertInstanceOf($class, $instance);
            $this->assertEquals($field_name, $instance->getName(), "Instance name is {$field_name}");
        }
    }
    
    /**
     * Tests creation of field item instances.
     */
    public function testCreateInstanceWithConfig() : void {
        
        /** @var \Drupal\Core\Field\FieldTypePluginManagerInterface $field_type_manager */
        $field_type_manager = \Drupal::service('plugin.manager.field.field_type');
        $type = 'test_field';
        $definition = $field_type_manager->getDefinition($type);
        $class = $definition['class'];
        $field_name = 'field_' . $type;
        $field_definition = BaseFieldDefinition::create($type)->setLabel('Jenny')
            ->setDefaultValue(8675309);
        $configuration = [
            'field_definition' => $field_definition,
            'name' => $field_name,
            'parent' => NULL,
        ];
        $entity = EntityTest::create();
        $instance = $field_type_manager->createInstance($type, $configuration);
        $this->assertInstanceOf($class, $instance);
        $this->assertEquals($field_name, $instance->getName(), "Instance name is {$field_name}");
        $this->assertEquals('Jenny', $instance->getFieldDefinition()
            ->getLabel(), 'Instance label is Jenny');
        $this->assertEquals([
            [
                'value' => 8675309,
            ],
        ], $instance->getFieldDefinition()
            ->getDefaultValue($entity), 'Instance default_value is 8675309');
    }
    
    /**
     * Tests all field items provide an existing main property.
     */
    public function testMainProperty() : void {
        // Let's enable all Drupal modules in Drupal core, so we test any field
        // type plugin.
        $this->enableAllCoreModules();
        
        /** @var \Drupal\Core\Field\FieldTypePluginManagerInterface $field_type_manager */
        $field_type_manager = \Drupal::service('plugin.manager.field.field_type');
        foreach ($field_type_manager->getDefinitions() as $plugin_id => $definition) {
            $class = $definition['class'];
            $property = $class::mainPropertyName();
            if ($property === NULL) {
                continue;
            }
            $storage_definition = BaseFieldDefinition::create($plugin_id);
            $property_definitions = $class::propertyDefinitions($storage_definition);
            $properties = implode(', ', array_keys($property_definitions));
            if (!empty($property_definitions)) {
                $message = sprintf("%s property %s found in %s", $plugin_id, $property, $properties);
                $this->assertArrayHasKey($property, $class::propertyDefinitions($storage_definition), $message);
            }
        }
    }
    
    /**
     * Tests UI definitions per entity type.
     */
    public function testUiDefinitionsPerEntityType() : void {
        
        /** @var \Drupal\Core\Field\FieldTypePluginManagerInterface $field_type_manager */
        $field_type_manager = \Drupal::service('plugin.manager.field.field_type');
        $definitions = $field_type_manager->getEntityTypeUiDefinitions('node');
        $this->assertEquals('Boolean (overridden by alter)', (string) $definitions['boolean']['label']);
        $definitions = $field_type_manager->getEntityTypeUiDefinitions('entity_test');
        $this->assertEquals('Boolean', (string) $definitions['boolean']['label']);
    }
    
    /**
     * Enable all core modules.
     */
    protected function enableAllCoreModules() {
        $listing = new ExtensionDiscovery($this->root);
        $module_list = $listing->scan('module', FALSE);
        
        /** @var \Drupal\Core\Extension\ModuleHandlerInterface $module_handler */
        $module_handler = $this->container
            ->get('module_handler');
        $module_list = array_filter(array_keys($module_list), function ($module) use ($module_handler, $module_list) {
            return !$module_handler->moduleExists($module) && str_starts_with($module_list[$module]->getPath(), 'core');
        });
        $this->enableModules($module_list);
    }

}

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.
FieldKernelTestBase::$entityId protected property
FieldKernelTestBase::$fieldTestData protected property Bag of created field storages and fields.
FieldKernelTestBase::$modules protected static property Modules to install. Overrides KernelTestBase::$modules 24
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::setUp protected function Set the default field storage backend for fields created during tests. Overrides KernelTestBase::setUp 31
FieldKernelTestBase::_generateTestFieldValues protected function Generate random values for a field_test field.
FieldTypePluginManagerTest::enableAllCoreModules protected function Enable all core modules.
FieldTypePluginManagerTest::testCreateInstance public function Tests creation of field item instances.
FieldTypePluginManagerTest::testCreateInstanceWithConfig public function Tests creation of field item instances.
FieldTypePluginManagerTest::testDefaultSettings public function Tests the default settings convenience methods.
FieldTypePluginManagerTest::testMainProperty public function Tests all field items provide an existing main property.
FieldTypePluginManagerTest::testUiDefinitionsPerEntityType public function Tests UI definitions per entity type.
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.