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
TestItemWithSingleDescription class Drupal\field_test\Plugin\Field\FieldType core/modules/field/tests/modules/field_test/src/Plugin/Field/FieldType/TestItemWithSingleDescription.php Defines the 'test_field_with_single_description' entity field item.
TestKernel class Drupal\Core\Test core/lib/Drupal/Core/Test/TestKernel.php Kernel that is only used by mock front controllers. 6
TestLayoutEntityHelperTrait class Drupal\Tests\layout_builder\Kernel core/modules/layout_builder/tests/src/Kernel/LayoutEntityHelperTraitTest.php Test class using the trait.
TestLazyPluginCollection class Drupal\plugin_test\Plugin core/modules/system/tests/modules/plugin_test/src/Plugin/TestLazyPluginCollection.php Defines a plugin collection which uses fruit plugins.
TestLibraryDiscoveryParser class Drupal\Tests\Core\Asset core/tests/Drupal/Tests/Core/Asset/LibraryDiscoveryParserTest.php Wraps the tested class to mock the external dependencies.
TestLoader class Drupal\twig_loader_test\Loader core/modules/system/tests/modules/twig_loader_test/src/Loader/TestLoader.php A test Twig loader. 2
TestLocalAction class Drupal\menu_test\Plugin\Menu\LocalAction core/modules/system/tests/modules/menu_test/src/Plugin/Menu/LocalAction/TestLocalAction.php Defines a test local action plugin class. 1
TestLocalAction4 class Drupal\menu_test\Plugin\Menu\LocalAction core/modules/system/tests/modules/menu_test/src/Plugin/Menu/LocalAction/TestLocalAction4.php Defines a local action plugin with a dynamic title. 1
TestLocalAction5 class Drupal\menu_test\Plugin\Menu\LocalAction core/modules/system/tests/modules/menu_test/src/Plugin/Menu/LocalAction/TestLocalAction5.php Defines a local action plugin with a dynamic title from user input. 1
TestLocalActionManager class Drupal\Tests\Core\Menu core/tests/Drupal/Tests/Core/Menu/LocalActionManagerTest.php Stub class for testing LocalActionManager.
TestLocalActionWithConfig class Drupal\menu_test\Plugin\Menu\LocalAction core/modules/system/tests/modules/menu_test/src/Plugin/Menu/LocalAction/TestLocalActionWithConfig.php Defines a test local action plugin class. 1
TestLocalTaskController class Drupal\content_moderation_test_local_task\Controller core/modules/content_moderation/tests/modules/content_moderation_test_local_task/src/Controller/TestLocalTaskController.php A test controller.
TestLocalTaskDefault class Drupal\Tests\Core\Menu core/tests/Drupal/Tests/Core/Menu/LocalTaskDefaultTest.php Stub class for testing LocalTaskDefault.
TestLog class Drupal\error_service_test\Logger core/modules/system/tests/modules/error_service_test/src/Logger/TestLog.php Throws an exception while logging an exception. 2
TestMailCollector class Drupal\Core\Mail\Plugin\Mail core/lib/Drupal/Core/Mail/Plugin/Mail/TestMailCollector.php Defines a mail backend that captures sent messages in the state system. 1 2
TestMailManager class Drupal\Tests\Core\Mail core/tests/Drupal/Tests/Core/Mail/MailManagerTest.php Provides a testing version of MailManager with an empty constructor.
TestMediaFilterController class Drupal\media_test_embed\Controller core/modules/media/tests/modules/media_test_embed/src/Controller/TestMediaFilterController.php Controller to allow testing of error handling of Media Embed in text editors.
TestMemoryBackend class Drupal\Tests\Core\Asset core/tests/Drupal/Tests/Core/Asset/AssetResolverTest.php Stub class with memory cache implementation for testing.
TestMiddleware class Drupal\http_kernel_test\HttpKernel core/modules/system/tests/modules/http_kernel_test/src/HttpKernel/TestMiddleware.php Provides a test middleware. 3
TestMigrateExecutable class Drupal\Tests\migrate\Unit core/modules/migrate/tests/src/Unit/TestMigrateExecutable.php Tests MigrateExecutable.
TestMigrateExecutable class Drupal\Tests\migrate\Kernel core/modules/migrate/tests/src/Kernel/TestMigrateExecutable.php Tests MigrateExecutable.
TestMigrateExecutable class Drupal\Tests\migrate\Kernel\Plugin core/modules/migrate/tests/src/Kernel/Plugin/LogTest.php MigrateExecutable test class.
TestMigration class Drupal\Tests\migrate\Unit core/modules/migrate/tests/src/Unit/MigrationTest.php Defines the TestMigration class.
TestMigrationConfigurationTrait class Drupal\Tests\migrate_drupal\Unit core/modules/migrate_drupal/tests/src/Unit/MigrationConfigurationTraitTest.php Test class that uses the trait we are testing.
TestMigrationMock class Drupal\Tests\migrate\Unit core/modules/migrate/tests/src/Unit/MigrationPluginManagerTest.php A mock migration plugin.
TestModalController class Drupal\pager_test\Controller core/modules/system/tests/modules/pager_test/src/Controller/TestModalController.php Renders a link to open a route in route with a pager in a modal.
TestModuleRequiredByThemeHooks class Drupal\test_module_required_by_theme\Hook core/modules/system/tests/themes/test_theme_depending_on_modules/test_module_required_by_theme/src/Hook/TestModuleRequiredByThemeHooks.php Hook implementations for test_module_required_by_theme.
TestMultipleFormController class Drupal\block_test\Controller core/modules/block/tests/modules/block_test/src/Controller/TestMultipleFormController.php Controller for block_test module.
TestMultipleFormsBlock class Drupal\block_test\Plugin\Block core/modules/block/tests/modules/block_test/src/Plugin/Block/TestMultipleFormsBlock.php Provides a block with multiple forms.
TestMultiWidthLayoutsTest class Drupal\Tests\layout_builder\FunctionalJavascript core/modules/layout_builder/tests/src/FunctionalJavascript/TestMultiWidthLayoutsTest.php Test the multi-width layout plugins.
TestNodeFormOverride class Drupal\media_library_test\Form core/modules/media_library/tests/modules/media_library_test/src/Form/TestNodeFormOverride.php Override NodeForm to test media library form submission semantics. 1
TestNodeVisitor final class Drupal\sdc_other_node_visitor\Twig\NodeVisitor core/modules/system/tests/modules/sdc_other_node_visitor/src/Twig/NodeVisitor/TestNodeVisitor.php A node visitor that adds nodes to the Twig template. 1
TestNormalizerBase class Drupal\Tests\serialization\Unit\Normalizer core/modules/serialization/tests/src/Unit/Normalizer/NormalizerBaseTest.php Testable class for NormalizerBase.
TestNotAnEntityForm class Drupal\Tests\Core\Entity core/tests/Drupal/Tests/Core/Entity/EntityTypeManagerTest.php Provides a test entity form that doesn't extend EntityForm.
TestObject class Drupal\Tests\serialization\Unit\Encoder core/modules/serialization/tests/src/Unit/Encoder/XmlEncoderTest.php Test class used for the encoding test.
TestObjectItem class Drupal\field_test\Plugin\Field\FieldType core/modules/field/tests/modules/field_test/src/Plugin/Field/FieldType/TestObjectItem.php Defines the 'test_object_field' entity field item.
TestObjectItemTest class Drupal\Tests\field\Kernel core/modules/field/tests/src/Kernel/TestObjectItemTest.php Tests the serialization of an object.
TestPageDisplayVariantSubscriber class Drupal\display_variant_test\EventSubscriber core/modules/system/tests/modules/display_variant_test/src/EventSubscriber/TestPageDisplayVariantSubscriber.php Selects the test page display variant. 2
TestPageTestController class Drupal\test_page_test\Controller core/modules/system/tests/modules/test_page_test/src/Controller/TestPageTestController.php Controller routines for test_page_test routes.
TestPageTitleMainContentAndMessagesBlock class Drupal\block_test\Plugin\Block core/modules/block/tests/modules/block_test/src/Plugin/Block/TestPageTitleMainContentAndMessagesBlock.php Provides a block which includes page title, main content & messages together.
TestPathBasedBreadcrumbBuilder class Drupal\Tests\system\Unit\Breadcrumbs core/modules/system/tests/src/Unit/Breadcrumbs/PathBasedBreadcrumbBuilderTest.php Helper class for testing purposes only.
TestPerComponentEntityDisplay class Drupal\Tests\migrate\Unit\destination core/modules/migrate/tests/src/Unit/destination/PerComponentEntityDisplayTest.php Test class used for testing per component entity display.
TestPerComponentEntityFormDisplay class Drupal\Tests\migrate\Unit\destination core/modules/migrate/tests/src/Unit/destination/PerComponentEntityFormDisplayTest.php Test class for testing per component entity form display.
TestPermissionCallbacks class Drupal\Tests\user\Unit core/modules/user/tests/src/Unit/PermissionHandlerTest.php Provider for testing permissions callbacks.
TestPhpMailFailure class Drupal\system_mail_failure_test\Plugin\Mail core/modules/system/tests/modules/system_mail_failure_test/src/Plugin/Mail/TestPhpMailFailure.php Defines a mail sending implementation that always fails. 1
TestPlaceholderingRenderCache class Drupal\Tests\Core\Render core/tests/Drupal/Tests/Core/Render/RendererPlaceholdersTest.php Class for testing the placeholdering render cache.
TestPluginBase class Drupal\Tests\views\Kernel\Plugin core/modules/views/tests/src/Kernel/Plugin/PluginBaseTest.php Helper class for using the PluginBase abstract class.
TestPluginDependency class Drupal\Tests\Core\Plugin core/tests/Drupal/Tests/Core/Plugin/PluginDependencyTraitTest.php Stub class for testing PluginDependencyTrait.
TestPluginForm class Drupal\Tests\Core\Plugin core/tests/Drupal/Tests/Core/Plugin/DefaultPluginManagerTest.php Plugin form test class.
TestPluginManager class Drupal\Tests\Core\Plugin core/tests/Drupal/Tests/Core/Plugin/TestPluginManager.php A plugin manager for condition plugins. 1

Other projects

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