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
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.
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
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. 1 1 2
DuplicateConfigAction final class Drupal\config_action_duplicate_test\Plugin\ConfigAction core/modules/config/tests/config_action_duplicate_test/src/Plugin/ConfigAction/DuplicateConfigAction.php #[ConfigAction(id: 'config_action_duplicate_test:config_test.dynamic:setProtectedProperty', admin_label: new TranslatableMarkup('A duplicate config action'), entity_types: [ 'config_test', ])]
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 the UI for correct contextual links.
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.
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
DynamicEntityTypeParamConverterTrait trait Drupal\Core\ParamConverter core/lib/Drupal/Core/ParamConverter/DynamicEntityTypeParamConverterTrait.php Provides a trait to replace dynamic entity types in routes.
DynamicLocalTasks class Drupal\media\Plugin\Derivative core/modules/media/src/Plugin/Derivative/DynamicLocalTasks.php Generates media-related local tasks. 1
DynamicLocalTasks class Drupal\content_moderation\Plugin\Derivative core/modules/content_moderation/src/Plugin/Derivative/DynamicLocalTasks.php Generates moderation-related local tasks. 1
DynamicMenuLinkMock class Drupal\Tests\Core\Menu core/tests/Drupal/Tests/Core/Menu/DynamicMenuLinkMock.php Defines a mock implementation of a dynamic menu link used in tests only.
DynamicPageCacheIntegrationTest class Drupal\Tests\dynamic_page_cache\Functional core/modules/dynamic_page_cache/tests/src/Functional/DynamicPageCacheIntegrationTest.php Enables the Dynamic Page Cache and tests it in various scenarios.
DynamicPageCacheSubscriber class Drupal\dynamic_page_cache\EventSubscriber core/modules/dynamic_page_cache/src/EventSubscriber/DynamicPageCacheSubscriber.php Returns cached responses as early and avoiding as much work as possible. 6 2
DynamicPageCacheTestController class Drupal\dynamic_page_cache_test core/modules/dynamic_page_cache/tests/dynamic_page_cache_test/src/DynamicPageCacheTestController.php Controller routines for dynamic_page_cache_test routes.
DynamicPluginConfigWithCsrfTokenUrlTrait trait Drupal\ckeditor5\Plugin\CKEditor5Plugin core/modules/ckeditor5/src/Plugin/CKEditor5Plugin/DynamicPluginConfigWithCsrfTokenUrlTrait.php Provides a trait for CKEditor 5 with dynamically generated CSRF token URLs.
EarlyDateTest class Drupal\Tests\taxonomy\Functional core/modules/taxonomy/tests/src/Functional/EarlyDateTest.php Posts an article with a taxonomy term and a date prior to 1970.
EarlyFormatSetter final class Drupal\jsonapi\Routing core/modules/jsonapi/src/Routing/EarlyFormatSetter.php Sets the 'api_json' format for requests to JSON:API resources. 2
EarlyRenderingControllerTest class Drupal\Tests\system\Functional\Common core/modules/system/tests/src/Functional/Common/EarlyRenderingControllerTest.php Verifies that bubbleable metadata of early rendering is not lost.
EarlyRenderingControllerWrapperSubscriber class Drupal\Core\EventSubscriber core/lib/Drupal/Core/EventSubscriber/EarlyRenderingControllerWrapperSubscriber.php Subscriber that wraps controllers, to handle early rendering. 2
EarlyRenderingTestController class Drupal\early_rendering_controller_test core/modules/system/tests/modules/early_rendering_controller_test/src/EarlyRenderingTestController.php Controller routines for early_rendering_test routes.
EditDetails class Drupal\views_ui\Form\Ajax core/modules/views_ui/src/Form/Ajax/EditDetails.php Provides a form for editing the details of a View.
EditModeTest class Drupal\Tests\contextual\FunctionalJavascript core/modules/contextual/tests/src/FunctionalJavascript/EditModeTest.php Tests edit mode.
Editor class Drupal\editor\Attribute core/modules/editor/src/Attribute/Editor.php Defines an Editor attribute object. 4
Editor class Drupal\editor\Entity core/modules/editor/src/Entity/Editor.php Defines the configured text editor entity. 65
Editor class Drupal\editor\Annotation core/modules/editor/src/Annotation/Editor.php Defines an Editor annotation object.
EditorAccessControlHandler class Drupal\editor core/modules/editor/src/EditorAccessControlHandler.php Defines the access control handler for the text editor entity type.
EditorAddLazyLoadImageFilterUpdateTest class Drupal\Tests\editor\Functional\Update core/modules/editor/tests/src/Functional/Update/EditorAddLazyLoadImageFilterUpdateTest.php Tests adding editor_image_lazy_load filter to editor_file_reference.
EditorAdminTest class Drupal\Tests\editor\FunctionalJavascript core/modules/editor/tests/src/FunctionalJavascript/EditorAdminTest.php @group editor
EditorAdminTest class Drupal\Tests\editor\Functional core/modules/editor/tests/src/Functional/EditorAdminTest.php Tests administration of text editors.
EditorBase abstract class Drupal\editor\Plugin core/modules/editor/src/Plugin/EditorBase.php Defines a base class from which other modules providing editors may extend. 3 3
EditorConfigEntityUnitTest class Drupal\Tests\editor\Unit core/modules/editor/tests/src/Unit/EditorConfigEntityUnitTest.php @coversDefaultClass \Drupal\editor\Entity\Editor[[api-linebreak]] @group editor
EditorConfigTranslationSubscriber class Drupal\editor\EventSubscriber core/modules/editor/src/EventSubscriber/EditorConfigTranslationSubscriber.php Adds configuration names to configuration mapper on POPULATE_MAPPER event. 2
EditorController class Drupal\editor core/modules/editor/src/EditorController.php Returns responses for Editor module routes.
EditorDeprecationTest class Drupal\Tests\editor\Kernel core/modules/editor/tests/src/Kernel/EditorDeprecationTest.php Tests the deprecations in Drupal\editor.
EditorDialogAccessTest class Drupal\Tests\editor\Functional core/modules/editor/tests/src/Functional/EditorDialogAccessTest.php Test access to the editor dialog forms.
EditorDialogSave class Drupal\editor\Ajax core/modules/editor/src/Ajax/EditorDialogSave.php Provides an AJAX command for saving the contents of an editor dialog. 4
EditorFileReference class Drupal\editor\Plugin\Filter core/modules/editor/src/Plugin/Filter/EditorFileReference.php Provides a filter to track images uploaded via a Text Editor.
EditorFileReferenceFilterTest class Drupal\Tests\editor\Kernel core/modules/editor/tests/src/Kernel/EditorFileReferenceFilterTest.php Tests Editor module's file reference filter.
EditorFileUsageTest class Drupal\Tests\editor\Kernel core/modules/editor/tests/src/Kernel/EditorFileUsageTest.php Tests tracking of file usage by the Text Editor module.
EditorFilterIntegrationTest class Drupal\Tests\editor\Kernel core/modules/editor/tests/src/Kernel/EditorFilterIntegrationTest.php Tests integration with filter module.

Other projects

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