class BundleClassTest

Same name in other branches
  1. 9 core/tests/Drupal/KernelTests/Core/Entity/BundleClassTest.php \Drupal\KernelTests\Core\Entity\BundleClassTest
  2. 11.x core/tests/Drupal/KernelTests/Core/Entity/BundleClassTest.php \Drupal\KernelTests\Core\Entity\BundleClassTest

Tests entity bundle classes.

@group Entity

Hierarchy

Expanded class hierarchy of BundleClassTest

File

core/tests/Drupal/KernelTests/Core/Entity/BundleClassTest.php, line 24

Namespace

Drupal\KernelTests\Core\Entity
View source
class BundleClassTest extends EntityKernelTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'entity_test_bundle_class',
    ];
    
    /**
     * The entity storage.
     *
     * @var \Drupal\Core\Entity\EntityStorageInterface
     */
    protected $storage;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->storage = $this->entityTypeManager
            ->getStorage('entity_test');
    }
    
    /**
     * Tests making use of a custom bundle class.
     */
    public function testEntitySubclass() : void {
        entity_test_create_bundle('bundle_class');
        // Ensure we start life with empty counters.
        $this->assertEquals(0, EntityTestBundleClass::$preCreateCount);
        $this->assertEquals(0, EntityTestBundleClass::$preDeleteCount);
        $this->assertEquals(0, EntityTestBundleClass::$postDeleteCount);
        $this->assertEquals(0, EntityTestBundleClass::$postLoadCount);
        $this->assertCount(0, EntityTestBundleClass::$postLoadEntitiesCount);
        // Verify statically created entity with bundle class returns correct class.
        $entity = EntityTestBundleClass::create();
        $this->assertInstanceOf(EntityTestBundleClass::class, $entity);
        // Verify that bundle returns bundle_class when create is called without
        // passing a bundle.
        $this->assertSame($entity->bundle(), 'bundle_class');
        // Check that both preCreate() and postCreate() were called once.
        $this->assertEquals(1, EntityTestBundleClass::$preCreateCount);
        $this->assertEquals(1, $entity->postCreateCount);
        // Verify that none of the other methods have been invoked.
        $this->assertEquals(0, EntityTestBundleClass::$preDeleteCount);
        $this->assertEquals(0, EntityTestBundleClass::$postDeleteCount);
        $this->assertEquals(0, EntityTestBundleClass::$postLoadCount);
        $this->assertCount(0, EntityTestBundleClass::$postLoadEntitiesCount);
        // Verify statically created entity with bundle class returns correct
        // bundle.
        $entity = EntityTestBundleClass::create([
            'type' => 'custom',
        ]);
        $this->assertInstanceOf(EntityTestBundleClass::class, $entity);
        $this->assertEquals('bundle_class', $entity->bundle());
        // We should have seen preCreate() a 2nd time.
        $this->assertEquals(2, EntityTestBundleClass::$preCreateCount);
        // postCreate() is specific to each entity instance, so still 1.
        $this->assertEquals(1, $entity->postCreateCount);
        // Verify that none of the other methods have been invoked.
        $this->assertEquals(0, EntityTestBundleClass::$preDeleteCount);
        $this->assertEquals(0, EntityTestBundleClass::$postDeleteCount);
        $this->assertEquals(0, EntityTestBundleClass::$postLoadCount);
        $this->assertCount(0, EntityTestBundleClass::$postLoadEntitiesCount);
        // Verify that the entity storage creates the entity using the proper class.
        $entity = $this->storage
            ->create([
            'type' => 'bundle_class',
        ]);
        $this->assertInstanceOf(EntityTestBundleClass::class, $entity);
        // We should have seen preCreate() a 3rd time.
        $this->assertEquals(3, EntityTestBundleClass::$preCreateCount);
        $this->assertEquals(1, $entity->postCreateCount);
        // Nothing else has been invoked.
        $this->assertEquals(0, EntityTestBundleClass::$preDeleteCount);
        $this->assertEquals(0, EntityTestBundleClass::$postDeleteCount);
        $this->assertEquals(0, EntityTestBundleClass::$postLoadCount);
        $this->assertCount(0, EntityTestBundleClass::$postLoadEntitiesCount);
        // Verify that loading an entity returns the proper class.
        $entity->save();
        $id = $entity->id();
        $this->storage
            ->resetCache();
        $entity = $this->storage
            ->load($id);
        $this->assertInstanceOf(EntityTestBundleClass::class, $entity);
        // Loading an existing entity shouldn't call preCreate() nor postCreate().
        $this->assertEquals(3, EntityTestBundleClass::$preCreateCount);
        $this->assertEquals(0, $entity->postCreateCount);
        // Nothing has been deleted.
        $this->assertEquals(0, EntityTestBundleClass::$preDeleteCount);
        $this->assertEquals(0, EntityTestBundleClass::$postDeleteCount);
        // We should now have seen postLoad() called once.
        $this->assertEquals(1, EntityTestBundleClass::$postLoadCount);
        // It should have been invoked with a single entity.
        $this->assertCount(1, EntityTestBundleClass::$postLoadEntitiesCount);
        $this->assertEquals(1, EntityTestBundleClass::$postLoadEntitiesCount[0]);
        // Create additional entities to test invocations during loadMultiple().
        $entity_2 = $this->storage
            ->create([
            'type' => 'bundle_class',
        ]);
        $entity_2->save();
        $this->assertEquals(4, EntityTestBundleClass::$preCreateCount);
        $entity_3 = $this->storage
            ->create([
            'type' => 'bundle_class',
        ]);
        $entity_3->save();
        $this->assertEquals(5, EntityTestBundleClass::$preCreateCount);
        // Make another bundle that does not have a bundle subclass.
        entity_test_create_bundle('entity_test');
        $entity_test_1 = $this->storage
            ->create([
            'type' => 'entity_test',
        ]);
        $entity_test_1->save();
        // EntityTestBundleClass::preCreate() should not have been called.
        $this->assertEquals(5, EntityTestBundleClass::$preCreateCount);
        $entity_test_2 = $this->storage
            ->create([
            'type' => 'entity_test',
        ]);
        $entity_test_2->save();
        // EntityTestBundleClass::preCreate() should still not have been called.
        $this->assertEquals(5, EntityTestBundleClass::$preCreateCount);
        // Try calling loadMultiple().
        $entity_ids = [
            $entity->id(),
            $entity_2->id(),
            $entity_3->id(),
            $entity_test_1->id(),
            $entity_test_2->id(),
        ];
        $entities = $this->storage
            ->loadMultiple($entity_ids);
        // postLoad() should only have been called once more so far.
        $this->assertEquals(2, EntityTestBundleClass::$postLoadCount);
        $this->assertCount(2, EntityTestBundleClass::$postLoadEntitiesCount);
        // Only 3 of the 5 entities we just loaded use the bundle class. However,
        // one of them has already been loaded and we're getting the cached entity
        // without re-invoking postLoad(). So the custom postLoad() method should
        // only have been invoked with 2 entities.
        $this->assertEquals(2, EntityTestBundleClass::$postLoadEntitiesCount[1]);
        // Reset the storage cache and try loading again.
        $this->storage
            ->resetCache();
        $entities = $this->storage
            ->loadMultiple($entity_ids);
        $this->assertEquals(3, EntityTestBundleClass::$postLoadCount);
        $this->assertCount(3, EntityTestBundleClass::$postLoadEntitiesCount);
        // This time, all 3 bundle_class entities should be included.
        $this->assertEquals(3, EntityTestBundleClass::$postLoadEntitiesCount[2]);
        // Start deleting things and count delete-related method invocations.
        $entity_test_1->delete();
        // No entity using the bundle class has yet been deleted.
        $this->assertEquals(0, EntityTestBundleClass::$preDeleteCount);
        $this->assertEquals(0, EntityTestBundleClass::$postDeleteCount);
        $entity_test_2->delete();
        $this->assertEquals(0, EntityTestBundleClass::$preDeleteCount);
        $this->assertEquals(0, EntityTestBundleClass::$postDeleteCount);
        // Start deleting entities using the bundle class.
        $entity->delete();
        $this->assertEquals(1, EntityTestBundleClass::$preDeleteCount);
        $this->assertEquals(1, EntityTestBundleClass::$postDeleteCount);
        $entity_2->delete();
        $this->assertEquals(2, EntityTestBundleClass::$preDeleteCount);
        $this->assertEquals(2, EntityTestBundleClass::$postDeleteCount);
        // Verify that getEntityClass without bundle returns the default entity
        // class.
        $entity_class = $this->storage
            ->getEntityClass(NULL);
        $this->assertEquals(EntityTest::class, $entity_class);
        // Verify that getEntityClass with a bundle returns the proper class.
        $entity_class = $this->storage
            ->getEntityClass('bundle_class');
        $this->assertEquals(EntityTestBundleClass::class, $entity_class);
        // Verify that getEntityClass with a non-existing bundle returns the entity
        // class.
        $entity_class = $this->storage
            ->getEntityClass('custom');
        $this->assertEquals(EntityTest::class, $entity_class);
    }
    
    /**
     * Tests making use of a custom bundle class for an entity without bundles.
     */
    public function testEntityNoBundleSubclass() : void {
        $this->container
            ->get('state')
            ->set('entity_test_bundle_class_enable_user_class', TRUE);
        $this->container
            ->get('kernel')
            ->rebuildContainer();
        $this->entityTypeManager
            ->clearCachedDefinitions();
        $this->drupalSetUpCurrentUser();
        $entity = User::load(1);
        $this->assertInstanceOf(EntityTestUserClass::class, $entity);
    }
    
    /**
     * Checks exception is thrown if two bundles share the same bundle class.
     *
     * @covers Drupal\Core\Entity\ContentEntityStorageBase::create
     */
    public function testAmbiguousBundleClassExceptionCreate() : void {
        $this->container
            ->get('state')
            ->set('entity_test_bundle_class_enable_ambiguous_entity_types', TRUE);
        $this->entityTypeManager
            ->clearCachedDefinitions();
        entity_test_create_bundle('bundle_class');
        entity_test_create_bundle('bundle_class_2');
        // Since we now have two bundles trying to reuse the same class, we expect
        // this to throw an exception.
        $this->expectException(AmbiguousBundleClassException::class);
        EntityTestBundleClass::create();
    }
    
    /**
     * Checks exception is thrown if two entity types share the same bundle class.
     *
     * @covers Drupal\Core\Entity\EntityTypeRepository::getEntityTypeFromClass
     */
    public function testAmbiguousBundleClassExceptionEntityTypeRepository() : void {
        $this->container
            ->get('state')
            ->set('entity_test_bundle_class_enable_ambiguous_entity_types', TRUE);
        entity_test_create_bundle('entity_test_no_label');
        entity_test_create_bundle('entity_test_no_label', NULL, 'entity_test_no_label');
        // Now that we have an entity bundle class that's shared by two entirely
        // different entity types, we expect an exception to be thrown.
        $this->expectException(AmbiguousBundleClassException::class);
        $entity_type = $this->container
            ->get('entity_type.repository')
            ->getEntityTypeFromClass(EntityTestAmbiguousBundleClass::class);
    }
    
    /**
     * Checks that no exception is thrown when two bundles share an entity class.
     *
     * @covers Drupal\Core\Entity\EntityTypeRepository::getEntityTypeFromClass
     */
    public function testNoAmbiguousBundleClassExceptionSharingEntityClass() : void {
        $shared_type_a = $this->container
            ->get('entity_type.repository')
            ->getEntityTypeFromClass(SharedEntityTestBundleClassA::class);
        $shared_type_b = $this->container
            ->get('entity_type.repository')
            ->getEntityTypeFromClass(SharedEntityTestBundleClassB::class);
        $this->assertSame('shared_type', $shared_type_a);
        $this->assertSame('shared_type', $shared_type_b);
    }
    
    /**
     * Checks exception thrown if a bundle class doesn't extend the entity class.
     */
    public function testBundleClassShouldExtendEntityClass() : void {
        $this->container
            ->get('state')
            ->set('entity_test_bundle_class_non_inheriting', TRUE);
        $this->entityTypeManager
            ->clearCachedDefinitions();
        $this->expectException(BundleClassInheritanceException::class);
        entity_test_create_bundle('bundle_class');
        $this->storage
            ->create([
            'type' => 'bundle_class',
        ]);
    }
    
    /**
     * Checks exception thrown if a bundle class doesn't exist.
     */
    public function testBundleClassShouldExist() : void {
        $this->container
            ->get('state')
            ->set('entity_test_bundle_class_does_not_exist', TRUE);
        $this->entityTypeManager
            ->clearCachedDefinitions();
        $this->expectException(MissingBundleClassException::class);
        entity_test_create_bundle('bundle_class');
        $this->storage
            ->create([
            'type' => 'bundle_class',
        ]);
    }
    
    /**
     * Tests that a module can override an entity-type class.
     *
     * Ensures a module can implement hook_entity_info_alter() and alter the
     * entity's class without needing to write to the last installed
     * definitions repository.
     */
    public function testEntityClassNotTakenFromActiveDefinitions() : void {
        $this->container
            ->get('state')
            ->set('entity_test_bundle_class_override_base_class', TRUE);
        $this->entityTypeManager
            ->clearCachedDefinitions();
        $this->assertEquals(EntityTestVariant::class, $this->entityTypeManager
            ->getStorage('entity_test')
            ->getEntityClass());
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias 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.
BundleClassTest::$modules protected static property Modules to install. Overrides EntityKernelTestBase::$modules
BundleClassTest::$storage protected property The entity storage.
BundleClassTest::setUp protected function Overrides EntityKernelTestBase::setUp
BundleClassTest::testAmbiguousBundleClassExceptionCreate public function Checks exception is thrown if two bundles share the same bundle class.
BundleClassTest::testAmbiguousBundleClassExceptionEntityTypeRepository public function Checks exception is thrown if two entity types share the same bundle class.
BundleClassTest::testBundleClassShouldExist public function Checks exception thrown if a bundle class doesn't exist.
BundleClassTest::testBundleClassShouldExtendEntityClass public function Checks exception thrown if a bundle class doesn't extend the entity class.
BundleClassTest::testEntityClassNotTakenFromActiveDefinitions public function Tests that a module can override an entity-type class.
BundleClassTest::testEntityNoBundleSubclass public function Tests making use of a custom bundle class for an entity without bundles.
BundleClassTest::testEntitySubclass public function Tests making use of a custom bundle class.
BundleClassTest::testNoAmbiguousBundleClassExceptionSharingEntityClass public function Checks that no exception is thrown when two bundles share an entity class.
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.
EntityKernelTestBase::$entityTypeManager protected property The entity type manager service. 1
EntityKernelTestBase::$generatedIds protected property A list of generated identifiers.
EntityKernelTestBase::$state protected property The state service.
EntityKernelTestBase::createUser protected function Creates a user.
EntityKernelTestBase::generateRandomEntityId protected function Generates a random ID avoiding collisions.
EntityKernelTestBase::getHooksInfo protected function Returns the entity_test hook invocation info.
EntityKernelTestBase::installModule protected function Installs a module and refreshes services.
EntityKernelTestBase::refreshServices protected function Refresh services. 1
EntityKernelTestBase::reloadEntity protected function Reloads the given entity from the storage and returns it.
EntityKernelTestBase::uninstallModule protected function Uninstalls a module and refreshes services.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
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.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid. Aliased as: drupalCheckPermissions
UserCreationTrait::createAdminRole protected function Creates an administrative role. Aliased as: drupalCreateAdminRole
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role. Aliased as: drupalGrantPermissions
UserCreationTrait::setCurrentUser protected function Switch the current logged in user. Aliased as: drupalSetCurrentUser
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user. Aliased as: drupalSetUpCurrentUser

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