Classes, traits, and interfaces - 10.3.x - 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 1518

Name	Deprecated	Object type	Namespace	File name	Summary	Direct uses	Use statements	Strings
DraggableListBuilder		abstract class	Drupal\Core\Config\Entity	core/lib/Drupal/Core/Config/Entity/DraggableListBuilder.php	Defines a class to build a draggable listing of configuration entities.	5	5
DraggableListBuilderTrait		trait	Drupal\Core\Entity	core/lib/Drupal/Core/Entity/DraggableListBuilderTrait.php	Provides a trait for draggable listings of entities.		1
DriverModuleMissingDependenciesTest		class	Drupal\Tests\Core\Database	core/tests/Drupal/Tests/Core/Database/DriverModuleMissingDependenciesTest.php	Tests for database driver module with missing dependency.
DriverNotSpecifiedException		class	Drupal\Core\Database	core/lib/Drupal/Core/Database/DriverNotSpecifiedException.php	Exception thrown if no driver is specified for a database connection.
DriverSpecificConnectionUnitTestBase		abstract class	Drupal\KernelTests\Core\Database	core/tests/Drupal/KernelTests/Core/Database/DriverSpecificConnectionUnitTestBase.php	Tests management of database connections.	2	2
DriverSpecificDatabaseTestBase		abstract class	Drupal\KernelTests\Core\Database	core/tests/Drupal/KernelTests/Core/Database/DriverSpecificDatabaseTestBase.php	Base class for driver specific database tests.	12	8
DriverSpecificKernelTestBase		abstract class	Drupal\KernelTests\Core\Database	core/tests/Drupal/KernelTests/Core/Database/DriverSpecificKernelTestBase.php	Base class for driver specific kernel tests.	13	10
DriverSpecificSchemaTestBase		abstract class	Drupal\KernelTests\Core\Database	core/tests/Drupal/KernelTests/Core/Database/DriverSpecificSchemaTestBase.php	Tests table creation and modification via the schema API.	3	3
DriverSpecificSyntaxTestBase		abstract class	Drupal\KernelTests\Core\Database	core/tests/Drupal/KernelTests/Core/Database/DriverSpecificSyntaxTestBase.php	Tests driver specific SQL syntax interpretation.	3	3
DriverSpecificTransactionTestBase		class	Drupal\KernelTests\Core\Database	core/tests/Drupal/KernelTests/Core/Database/DriverSpecificTransactionTestBase.php	Tests the transaction abstraction system.	3	3
Dropbutton		class	Drupal\Core\Render\Element	core/lib/Drupal/Core/Render/Element/Dropbutton.php	Provides a render element for a set of links rendered as a drop-down button.	1
Dropbutton		class	Drupal\views\Plugin\views\field	core/modules/views/src/Plugin/views/field/Dropbutton.php	Provides a handler that renders links as dropbutton.
Drupal		class		core/lib/Drupal.php	Static Service Container wrapper.
Drupal6SqlBaseTest		class	Drupal\Tests\migrate_drupal\Unit\source\d6	core/modules/migrate_drupal/tests/src/Unit/source/d6/Drupal6SqlBaseTest.php	Tests the D6 SQL base class.
DrupalAspectsOfCKEditor5Plugin		class	Drupal\ckeditor5\Attribute	core/modules/ckeditor5/src/Attribute/DrupalAspectsOfCKEditor5Plugin.php	#[\Attribute(\Attribute::TARGET_CLASS)]
DrupalAspectsOfCKEditor5Plugin		class	Drupal\ckeditor5\Annotation	core/modules/ckeditor5/src/Annotation/DrupalAspectsOfCKEditor5Plugin.php	Defines the "Drupal aspects of a CKEditor5Plugin" annotation object.		1
DrupalComponentTest		class	Drupal\Tests\Component	core/tests/Drupal/Tests/Component/DrupalComponentTest.php	General tests for \Drupal\Component that can't go anywhere else.
DrupalComponentTestListenerTrait		trait	Drupal\Tests\Listeners	core/tests/Drupal/Tests/Listeners/DrupalComponentTestListenerTrait.php	Ensures that no component tests are extending a core test base class.
DrupalCoreComposer		class	Drupal\Composer\Generator\Util	composer/Generator/Util/DrupalCoreComposer.php	Utilities for accessing composer.json data from drupal/drupal and drupal/core.		6
DrupalCoreRecommendedBuilder		class	Drupal\Composer\Generator\Builder	composer/Generator/Builder/DrupalCoreRecommendedBuilder.php	Builder to produce metapackage for drupal/core-recommended.		3
DrupalDateTime		class	Drupal\Core\Datetime	core/lib/Drupal/Core/Datetime/DrupalDateTime.php	Extends DateTimePlus().	3	38
DrupalDateTimeTest		class	Drupal\Tests\Core\Datetime	core/tests/Drupal/Tests/Core/Datetime/DrupalDateTimeTest.php	@coversDefaultClass \Drupal\Core\Datetime\DrupalDateTime[[api-linebreak]] @group Datetime
DrupalDateTimeTest		class	Drupal\Tests\system\Functional\Datetime	core/modules/system/tests/src/Functional/Datetime/DrupalDateTimeTest.php	Tests DrupalDateTime functionality.
DrupalDevDependenciesBuilder		class	Drupal\Composer\Generator\Builder	composer/Generator/Builder/DrupalDevDependenciesBuilder.php	Builder to produce metapackage for drupal/core-dev.		3
DrupalFlushAllCachesInInstallerTest		class	Drupal\FunctionalTests\Installer	core/tests/Drupal/FunctionalTests/Installer/DrupalFlushAllCachesInInstallerTest.php	Tests drupal_flush_all_caches() during an install.
DrupalFlushAllCachesTest		class	Drupal\KernelTests\Core\Common	core/tests/Drupal/KernelTests/Core/Common/DrupalFlushAllCachesTest.php	@covers ::drupal_flush_all_caches[[api-linebreak]] @group Common
DrupalKernel		class	Drupal\Core	core/lib/Drupal/Core/DrupalKernel.php	The DrupalKernel class is the core of Drupal itself.	4	36
DrupalKernelInterface		interface	Drupal\Core	core/lib/Drupal/Core/DrupalKernelInterface.php	The interface for DrupalKernel, the core of Drupal.	1	11
DrupalKernelSiteTest		class	Drupal\KernelTests\Core\DrupalKernel	core/tests/Drupal/KernelTests/Core/DrupalKernel/DrupalKernelSiteTest.php	Tests site-specific service overrides.
DrupalKernelTest		class	Drupal\KernelTests\Core\DrupalKernel	core/tests/Drupal/KernelTests/Core/DrupalKernel/DrupalKernelTest.php	Tests DIC compilation to disk.
DrupalKernelTest		class	Drupal\Tests\Core\DrupalKernel	core/tests/Drupal/Tests/Core/DrupalKernel/DrupalKernelTest.php	@coversDefaultClass \Drupal\Core\DrupalKernel[[api-linebreak]] @group DrupalKernel
DrupalListener		class	Drupal\Tests\Listeners	core/tests/Drupal/Tests/Listeners/DrupalListener.php	Listens to PHPUnit test runs.
DrupalLogErrorTest		class	Drupal\Tests\Core\Error	core/tests/Drupal/Tests/Core/Error/DrupalLogErrorTest.php	Tests logging of errors in core/error.inc.
DrupalMessengerServiceTest		class	Drupal\Tests\system\Functional\Bootstrap	core/modules/system/tests/src/Functional/Bootstrap/DrupalMessengerServiceTest.php	Tests the Messenger service.
DrupalPackageBuilder		abstract class	Drupal\Composer\Generator\Builder	composer/Generator/Builder/DrupalPackageBuilder.php	Base class that includes helpful utility routine for Drupal builder classes.	3
DrupalPinnedDevDependenciesBuilder		class	Drupal\Composer\Generator\Builder	composer/Generator/Builder/DrupalPinnedDevDependenciesBuilder.php	Builder to produce metapackage for drupal/core-dev-pinned.		3
DrupalSelenium2Driver		class	Drupal\FunctionalJavascriptTests	core/tests/Drupal/FunctionalJavascriptTests/DrupalSelenium2Driver.php	Provides a driver for Selenium testing.
DrupalSelenium2DriverTest		class	Drupal\FunctionalJavascriptTests\Tests	core/tests/Drupal/FunctionalJavascriptTests/Tests/DrupalSelenium2DriverTest.php	Tests the DrupalSelenium2Driver methods.
DrupalSqlBase		abstract class	Drupal\migrate_drupal\Plugin\migrate\source	core/modules/migrate_drupal/src/Plugin/migrate/source/DrupalSqlBase.php	A base class for source plugins using a Drupal database as a source.	67	65
DrupalSqlBaseTest		class	Drupal\Tests\migrate_drupal\Unit\source	core/modules/migrate_drupal/tests/src/Unit/source/DrupalSqlBaseTest.php	@coversDefaultClass \Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase[[api-linebreak]] @group migrate_drupal
DrupalStandardsListenerDeprecatedClass		class	Drupal\deprecation_test\Deprecation	core/modules/system/tests/modules/deprecation_test/src/Deprecation/DrupalStandardsListenerDeprecatedClass.php	Fixture class for use by DrupalStandardsListenerDeprecationTest.
DrupalStandardsListenerDeprecationTest		class	Drupal\Tests\Core\Listeners	core/tests/Drupal/Tests/Core/Listeners/DrupalStandardsListenerDeprecationTest.php	Test deprecation error handling by DrupalStandardsListener.
DrupalTest		class	Drupal\Tests\Core	core/tests/Drupal/Tests/Core/DrupalTest.php	Tests the Drupal class.
DrupalTestBrowser		class	Drupal\Tests	core/tests/Drupal/Tests/DrupalTestBrowser.php	Enables a BrowserKitDriver mink driver to use a Guzzle client.		2
DrupalTranslator		class	Drupal\Core\Validation	core/lib/Drupal/Core/Validation/DrupalTranslator.php	Translates strings using Drupal's translation system.		3
DummyAjaxFormatter		class	Drupal\image_module_test\Plugin\Field\FieldFormatter	core/modules/image/tests/modules/image_module_test/src/Plugin/Field/FieldFormatter/DummyAjaxFormatter.php	Empty renderer for a dummy field with an AJAX handler.
DummyAjaxItem		class	Drupal\image_module_test\Plugin\Field\FieldType	core/modules/image/tests/modules/image_module_test/src/Plugin/Field/FieldType/DummyAjaxItem.php	Defines a dummy field containing an AJAX handler.
DummyAjaxWidget		class	Drupal\image_module_test\Plugin\Field\FieldWidget	core/modules/image/tests/modules/image_module_test/src/Plugin/Field/FieldWidget/DummyAjaxWidget.php	Default widget for Dummy AJAX test.
DummyDestination		class	Drupal\migrate_events_test\Plugin\migrate\destination	core/modules/migrate/tests/modules/migrate_events_test/src/Plugin/migrate/destination/DummyDestination.php	Migration dummy destination.
DummyExternalReadOnlyWrapper		class	Drupal\file_test\StreamWrapper	core/modules/file/tests/file_test/src/StreamWrapper/DummyExternalReadOnlyWrapper.php	Helper class for testing the stream wrapper registry.			2

Other projects

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