Classes, traits, and interfaces - main - drupal

Primary tabs

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
DrupalInstalledTemplate class Drupal\Composer\Plugin\Scaffold composer/Plugin/Scaffold/DrupalInstalledTemplate.php Produces code for the DrupalInstalled file.
DrupalInstalledTest class Drupal\Tests\Composer\Plugin\Scaffold\Functional core/tests/Drupal/Tests/Composer/Plugin/Scaffold/Functional/DrupalInstalledTest.php Tests DrupalInstalled.php hash changes when scaffolding is run.
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 13
DrupalKernelRequestStackTest class Drupal\KernelTests\Core\DrupalKernel core/tests/Drupal/KernelTests/Core/DrupalKernel/DrupalKernelRequestStackTest.php Tests the usage of the request stack as part of request processing.
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 Tests Drupal\Core\DrupalKernel.
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

in drupal:11.4.0 and is removed from drupal:12.0.0. Use drupal/core-dev instead.

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. 1
DrupalSelenium2DriverTest class Drupal\FunctionalJavascriptTests\Tests core/tests/Drupal/FunctionalJavascriptTests/Tests/DrupalSelenium2DriverTest.php Tests the DrupalSelenium2Driver methods.
DrupalSqlBase

in drupal:11.3.0 and is removed from drupal:12.0.0. There is no replacement.

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. 65 63
DrupalSqlBaseTest class Drupal\Tests\migrate_drupal\Unit\source core/modules/migrate_drupal/tests/src/Unit/source/DrupalSqlBaseTest.php Tests Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase.
DrupalStandardsListenerDeprecatedClass class Drupal\deprecation_test\Deprecation core/modules/system/tests/modules/deprecation_test/src/Deprecation/DrupalStandardsListenerDeprecatedClass.php Fixture class for use by DrupalStandardsListenerDeprecationTest. 1
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
DrupalTestCaseTrait trait Drupal\Tests core/tests/Drupal/Tests/DrupalTestCaseTrait.php Provides methods common across all Drupal abstract base test classes. 2
DrupalTranslator class Drupal\Core\Validation core/lib/Drupal/Core/Validation/DrupalTranslator.php Translates strings using Drupal's translation system. 2
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
DummyImageFormatter class Drupal\image_module_test\Plugin\Field\FieldFormatter core/modules/image/tests/modules/image_module_test/src/Plugin/Field/FieldFormatter/DummyImageFormatter.php Plugin implementation of the Dummy image formatter.
DummyMimeTypeMapLoadedSubscriber class Drupal\file_test\EventSubscriber core/modules/file/tests/file_test/src/EventSubscriber/DummyMimeTypeMapLoadedSubscriber.php Modifies the MIME type map by adding dummy mappings.
DummyMultipleStreamWrapper class Drupal\file_test\StreamWrapper core/modules/file/tests/file_test/src/StreamWrapper/DummyMultipleStreamWrapper.php Helper class for testing the stream wrapper registry. 2
DummyPrivateStreamWrapper class Drupal\file_test\StreamWrapper core/modules/file/tests/file_test/src/StreamWrapper/DummyPrivateStreamWrapper.php Helper class for testing the stream wrapper registry. 2
DummyPublicStreamWrapper class Drupal\file_test\StreamWrapper core/modules/file/tests/file_test/src/StreamWrapper/DummyPublicStreamWrapper.php Helper class for testing the stream wrapper registry. 2
DummyQueryTrait trait Drupal\migrate\Plugin\migrate\source core/modules/migrate/src/Plugin/migrate/source/DummyQueryTrait.php Provides a dummy select query object for source plugins. 2
DummyReadOnlyStreamWrapper class Drupal\file_test\StreamWrapper core/modules/file/tests/file_test/src/StreamWrapper/DummyReadOnlyStreamWrapper.php Helper class for testing the stream wrapper registry. 2 2
DummyRemoteReadOnlyStreamWrapper class Drupal\file_test\StreamWrapper core/modules/file/tests/file_test/src/StreamWrapper/DummyRemoteReadOnlyStreamWrapper.php Dummy read-only remote stream wrapper (dummy-remote-readonly://). 1
DummyRemoteStreamWrapper class Drupal\file_test\StreamWrapper core/modules/file/tests/file_test/src/StreamWrapper/DummyRemoteStreamWrapper.php Helper class for testing the stream wrapper registry. 1 2
DummyStreamWrapper class Drupal\file_test\StreamWrapper core/modules/file/tests/file_test/src/StreamWrapper/DummyStreamWrapper.php Helper class for testing the stream wrapper registry. 3 1 2
DummyStreamWrapperFileTest class Drupal\Tests\file\Functional core/modules/file/tests/src/Functional/DummyStreamWrapperFileTest.php Tests the file uploading functions.
DuplicateConfigAction final class Drupal\config_action_duplicate_test\Plugin\ConfigAction core/modules/config/tests/config_action_duplicate_test/src/Plugin/ConfigAction/DuplicateConfigAction.php Test config action for testing duplicating a config action.
DuplicateConfigActionIdException class Drupal\Core\Config\Action core/lib/Drupal/Core/Config/Action/DuplicateConfigActionIdException.php Exception thrown if there are conflicting shorthand action IDs. 1
DuplicateContextualLinksTest class Drupal\Tests\contextual\FunctionalJavascript core/modules/contextual/tests/src/FunctionalJavascript/DuplicateContextualLinksTest.php Tests that duplicate contextual links are initialized independently.
DuplicateInfoFileValidator final class Drupal\package_manager\Validator core/modules/package_manager/src/Validator/DuplicateInfoFileValidator.php Validates the stage does not have duplicate info.yml not present in active. 1
DuplicateInfoFileValidatorTest class Drupal\Tests\package_manager\Kernel core/modules/package_manager/tests/src/Kernel/DuplicateInfoFileValidatorTest.php Tests Duplicate Info File Validator.
DuplicatePluralizedMethodName class Drupal\config_test\ConfigActionErrorEntity core/modules/config/tests/config_test/src/ConfigActionErrorEntity/DuplicatePluralizedMethodName.php Test entity class. 1
DuplicatePluralizedOtherMethodName class Drupal\config_test\ConfigActionErrorEntity core/modules/config/tests/config_test/src/ConfigActionErrorEntity/DuplicatePluralizedOtherMethodName.php Test entity class. 1
DuplicateTest class Drupal\Tests\views_ui\Functional core/modules/views_ui/tests/src/Functional/DuplicateTest.php Tests the UI for view duplicate tool.
DurationInterface interface Drupal\Core\TypedData\Type core/lib/Drupal/Core/TypedData/Type/DurationInterface.php Interface for durations. 2 4
DurationIso8601 class Drupal\Core\TypedData\Plugin\DataType core/lib/Drupal/Core/TypedData/Plugin/DataType/DurationIso8601.php The duration ISO8601 data type. 1
DynamicallyFieldableEntityStorageInterface interface Drupal\Core\Entity core/lib/Drupal/Core/Entity/DynamicallyFieldableEntityStorageInterface.php A storage that supports entity types with dynamic field definitions. 1 3
DynamicallyFieldableEntityStorageSchemaInterface interface Drupal\Core\Entity\Schema core/lib/Drupal/Core/Entity/Schema/DynamicallyFieldableEntityStorageSchemaInterface.php A storage schema that supports entity types with dynamic field definitions. 2 3

Other projects


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