Classes, traits, and interfaces - main - drupal

Introduction to classes

A lot of the PHP code in Drupal is object oriented (OO), making use of PHP classes, interfaces, and traits. See the Objected-oriented programming conventions for more information.

See also

Objected-oriented programming conventions

File

core/core.api.php, line 1529

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
Test2Interface interface Drupal\Tests\Component\Utility core/tests/Drupal/Tests/Component/Utility/ArgumentsResolverTest.php Provides a different test interface.
TestableSqlContentEntityStorage class Drupal\KernelTests\Core\Entity\Sql core/tests/Drupal/KernelTests/Core/Entity/Sql/TestableSqlContentEntityStorage.php A test subclass of SqlContentEntityStorage.
TestAccessBlock class Drupal\block_test\Plugin\Block core/modules/block/tests/modules/block_test/src/Plugin/Block/TestAccessBlock.php Provides a block to test access.
TestAccessCheck class Drupal\router_test\Access core/modules/system/tests/modules/router_test_directory/src/Access/TestAccessCheck.php Access check for test routes.
TestAccessCheckInterface interface Drupal\Tests\Core\Access core/tests/Drupal/Tests/Core/Access/AccessManagerTest.php Defines an interface with a defined access() method for mocking.
TestAccessClass class Drupal\Tests\Core\Render core/tests/Drupal/Tests/Core/Render/RendererTest.php Test class for mocking the access callback.
TestAction class Drupal\action_bulk_test\Plugin\Action core/modules/views/tests/modules/action_bulk_test/src/Plugin/Action/TestAction.php Test action.
TestActionConfirmForm class Drupal\action_bulk_test\Form core/modules/views/tests/modules/action_bulk_test/src/Form/TestActionConfirmForm.php Confirmation form for 'test_action' action. 1
TestAddForm class Drupal\media_library_form_overwrite_test\Form core/modules/media_library/tests/modules/media_library_form_overwrite_test/src/Form/TestAddForm.php Test add form. 2
TestAjaxBlock class Drupal\layout_builder_test\Plugin\Block core/modules/layout_builder/tests/modules/layout_builder_test/src/Plugin/Block/TestAjaxBlock.php Provides a 'TestAjax' block.
TestAnnotation class Drupal\Tests\Component\Annotation\Plugin\Discovery core/tests/Drupal/Tests/Component/Annotation/Plugin/Discovery/AnnotationBridgeDecoratorTest.php
TestAttribute class Drupal\Tests\Component\Plugin\Discovery core/tests/Drupal/Tests/Component/Plugin/Discovery/AttributeBridgeDecoratorTest.php
TestAttribute class Drupal\Tests\Core\Template core/tests/Drupal/Tests/Core/Template/TwigSandboxTest.php Test class for HTML attributes collector, sanitizer, and renderer.
TestAttributes class Drupal\router_test\Controller core/modules/system/tests/modules/router_test_directory/src/Controller/TestAttributes.php Test controller for method-level Route attributes. 1
TestAttributesBlock class Drupal\layout_builder_test\Plugin\Block core/modules/layout_builder/tests/modules/layout_builder_test/src/Plugin/Block/TestAttributesBlock.php Provides a 'TestAttributes' block.
TestAuth class Drupal\rest_test\Authentication\Provider core/modules/rest/tests/modules/rest_test/src/Authentication/Provider/TestAuth.php Authentication provider for testing purposes. 2
TestAuthenticationProvider class Drupal\Tests\Core\Authentication core/tests/Drupal/Tests/Core/Authentication/AuthenticationCollectorTest.php A simple provider for unit testing AuthenticationCollector.
TestAuthenticationProviderInterface interface Drupal\Tests\Core\Authentication core/tests/Drupal/Tests/Core/Authentication/AuthenticationManagerTest.php Helper interface to mock two interfaces at once.
TestAuthGlobal class Drupal\rest_test\Authentication\Provider core/modules/rest/tests/modules/rest_test/src/Authentication/Provider/TestAuthGlobal.php Global authentication provider for testing purposes. 2
TestBaseFieldDefinitionInterface interface Drupal\Tests\Core\Field core/tests/Drupal/Tests/Core/Field/TestBaseFieldDefinitionInterface.php Defines a test interface to mock entity base field definitions. 3
TestBaseInterface interface Drupal\Tests\Component\ProxyBuilder core/tests/Drupal/Tests/Component/ProxyBuilder/ProxyBuilderTest.php Test base interface. 1
TestBaseThemeHooks class Drupal\test_base_theme\Hook core/modules/system/tests/themes/test_base_theme/src/Hook/TestBaseThemeHooks.php Hook implementations for test_base_theme.
TestBlockInstantiation class Drupal\block_test\Plugin\Block core/modules/block/tests/modules/block_test/src/Plugin/Block/TestBlockInstantiation.php Provides a basic block for testing block instantiation and configuration. 1
TestBlockPluginWithRefinableDependentAccessInterface interface Drupal\Tests\layout_builder\Unit core/modules/layout_builder/tests/src/Unit/BlockComponentRenderArrayTest.php Test interface for dependent access block plugins.
TestCacheableDependency class Drupal\Tests\Core\Render core/tests/Drupal/Tests/Core/Render/TestCacheableDependency.php Cacheable dependency object for use in tests. 2
TestCacheBlock class Drupal\block_test\Plugin\Block core/modules/block/tests/modules/block_test/src/Plugin/Block/TestCacheBlock.php Provides a block to test caching.
TestCacheOptionalBlock class Drupal\block_test\Plugin\Block core/modules/block/tests/modules/block_test/src/Plugin/Block/TestCacheOptionalBlock.php Provides a block implementing CacheOptionalInterface to test its caching.
TestCallables class Drupal\Tests\Core\Render core/tests/Drupal/Tests/Core/Render/RendererTest.php Mock callable for testing the pre_render callback.
TestChildInterface interface Drupal\Tests\Component\ProxyBuilder core/tests/Drupal/Tests/Component/ProxyBuilder/ProxyBuilderTest.php Test child interface. 1
TestClass class Drupal\Tests\Core\Plugin core/tests/Drupal/Tests/Core/Plugin/PluginWithFormsTraitTest.php Stub class for testing PluginWithFormsTrait.
TestClass class Drupal\Tests\Component\Utility core/tests/Drupal/Tests/Component/Utility/ArgumentsResolverTest.php Provides a test class.
TestClass class Drupal\Tests\layout_builder\Unit core/modules/layout_builder/tests/src/Unit/LayoutEntityHelperTraitTest.php Test class using the trait.
TestClass class Drupal\service_provider_test core/modules/system/tests/modules/service_provider_test/src/TestClass.php Handles kernel events for request and response. 2
TestClassAttribute class Drupal\router_test\Controller core/modules/system/tests/modules/router_test_directory/src/Controller/TestClassAttribute.php Test controller for class-level Route attribute with method-level merging. 1
TestClassClassMetadata final class Drupal\PHPStan\Rules core/tests/PHPStan/Rules/TestClassClassMetadata.php Rules class-level PHPUnit test metadata in test classes. 1
TestClassClassMetadataTest class Drupal\PHPStan\Tests core/tests/PHPStan/tests/TestClassClassMetadataTest.php Tests TestClassClassMetadata rule.
TestClassMethodMetadata final class Drupal\PHPStan\Rules core/tests/PHPStan/Rules/TestClassMethodMetadata.php Validates method-level PHPUnit test metadata in test classes. 1
TestClassMethodMetadataTest class Drupal\PHPStan\Tests core/tests/PHPStan/tests/TestClassMethodMetadataTest.php Tests TestClassMethodMetadata rule.
TestClosureHttpMiddlewareClass class Drupal\Tests\Core\DependencyInjection\Fixture core/tests/Drupal/Tests/Core/DependencyInjection/Fixture/TestClosureHttpMiddlewareClass.php Stub of http_middleware class taking a service closure for the inner kernel. 1
TestCompatClosureHttpMiddlewareClass class Drupal\Tests\Core\DependencyInjection\Fixture core/tests/Drupal/Tests/Core/DependencyInjection/Fixture/TestCompatClosureHttpMiddlewareClass.php Stub of http_middleware class taking a service closure with bc. 1
TestCompatibilityTrait trait Drupal\TestTools\PhpUnitCompatibility\PhpUnit11 core/tests/Drupal/TestTools/PhpUnitCompatibility/PhpUnit11/TestCompatibilityTrait.php Drupal's forward compatibility layer with multiple versions of PHPUnit.
TestCompatibilityTrait trait Drupal\TestTools\PhpUnitCompatibility\PhpUnit12 core/tests/Drupal/TestTools/PhpUnitCompatibility/PhpUnit12/TestCompatibilityTrait.php Drupal's forward compatibility layer with multiple versions of PHPUnit. 1
TestConcat class Drupal\Tests\migrate\Unit\process core/modules/migrate/tests/src/Unit/process/ConcatTest.php Mock class for the concat process plugin.
TestConditionAccessResolverTrait class Drupal\Tests\Core\Condition core/tests/Drupal/Tests/Core/Condition/ConditionAccessResolverTraitTest.php Stub class for testing trait.
TestConfigEntityWithPluginCollections class Drupal\Tests\Core\Config\Entity core/tests/Drupal/Tests/Core/Config/Entity/ConfigEntityBaseUnitTest.php Stub class for testing.
TestConfigFactoryOverrideBase class Drupal\Tests\Core\Config core/tests/Drupal/Tests/Core/Config/ConfigFactoryOverrideBaseTest.php Stub class for testing ConfigFactoryOverrideBase.
TestConfigNamesMapper class Drupal\Tests\config_translation\Unit core/modules/config_translation/tests/src/Unit/ConfigNamesMapperTest.php Defines a test mapper class.
TestConfigType class Drupal\module_installer_config_test\Entity core/modules/system/tests/modules/module_installer_config_test/src/Entity/TestConfigType.php Defines a configuration-based entity type used for testing.
TestConfigurableContextAwarePluginInterface interface Drupal\Tests\Core\Plugin core/tests/Drupal/Tests/Core/Plugin/ContextHandlerTest.php Test interface used for creating mock classes in tests.
TestConfigurablePlugin class Drupal\Tests\Core\Plugin\Fixtures core/tests/Drupal/Tests/Core/Plugin/Fixtures/TestConfigurablePlugin.php A configurable plugin implementation used for testing. 3

Other projects

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