Classes, traits, and interfaces - 8.9.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 1511

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
CustomAnnotationClassDiscoveryTest class Drupal\KernelTests\Core\Plugin\Discovery core/tests/Drupal/KernelTests/Core/Plugin/Discovery/CustomAnnotationClassDiscoveryTest.php Tests that a custom annotation class is used.
CustomBooleanTest class Drupal\Tests\views_ui\Functional core/modules/views_ui/tests/src/Functional/CustomBooleanTest.php Tests the UI and functionality for the Custom boolean field handler options.
CustomDirectoryAnnotatedClassDiscoveryTest class Drupal\KernelTests\Core\Plugin\Discovery core/tests/Drupal/KernelTests/Core/Plugin/Discovery/CustomDirectoryAnnotatedClassDiscoveryTest.php Tests that plugins in a custom directory are correctly discovered using annotated classes.
CustomDirectoryExample1 class Drupal\plugin_test core/modules/system/tests/modules/plugin_test/src/CustomDirectoryExample1.php Provides a test plugin within a custom directory.
CustomDirectoryExample2 class Drupal\plugin_test core/modules/system/tests/modules/plugin_test/src/CustomDirectoryExample2.php Provides a test plugin within a custom directory.
CustomPageExceptionHtmlSubscriber class Drupal\Core\EventSubscriber core/lib/Drupal/Core/EventSubscriber/CustomPageExceptionHtmlSubscriber.php Exception subscriber for handling core custom HTML error pages. 1 2
CustomPageExceptionHtmlSubscriberTest class Drupal\Tests\Core\EventSubscriber core/tests/Drupal/Tests/Core/EventSubscriber/CustomPageExceptionHtmlSubscriberTest.php @coversDefaultClass \Drupal\Core\EventSubscriber\CustomPageExceptionHtmlSubscriber[[api-linebreak]] @group EventSubscriber
CustomPlugin class Drupal\Tests\Component\Annotation core/tests/Drupal/Tests/Component/Annotation/AnnotatedClassDiscoveryTest.php Custom plugin annotation.
CustomPlugin2 class Drupal\Tests\Component\Annotation core/tests/Drupal/Tests/Component/Annotation/AnnotatedClassDiscoveryTest.php Custom plugin annotation.
CustomStrings class Drupal\Core\StringTranslation\Translator core/lib/Drupal/Core/StringTranslation/Translator/CustomStrings.php String translator using overrides from variables. 2
CustomThemeNegotiator class Drupal\theme_test\Theme core/modules/system/tests/modules/theme_test/src/Theme/CustomThemeNegotiator.php Just forces the 'test_theme' theme. 2
D6FileField class Drupal\migrate_cckfield_plugin_manager_test\Plugin\migrate\cckfield core/modules/migrate_drupal/tests/modules/migrate_cckfield_plugin_manager_test/src/Plugin/migrate/cckfield/D6FileField.php Plugin annotation @MigrateCckField( id = "d6_file", core = {6}, type_map = { "file" = "file" }, source_module = "foo", destination_module = "bar" ) 2
D6FileField class Drupal\migrate_field_plugin_manager_test\Plugin\migrate\field core/modules/migrate_drupal/tests/modules/migrate_field_plugin_manager_test/src/Plugin/migrate/field/D6FileField.php Plugin annotation @MigrateField( id = "d6_file", core = {6}, type_map = { "file" = "file" }, source_module = "foo", destination_module = "bar" )
D6NoCoreVersionSpecified class Drupal\migrate_field_plugin_manager_test\Plugin\migrate\field core/modules/migrate_drupal/tests/modules/migrate_field_plugin_manager_test/src/Plugin/migrate/field/D6NoCoreVersionSpecified.php Plugin annotation @MigrateField( id = "d6_no_core_version_specified", source_module = "foo", destination_module = "bar", )
D6NoCoreVersionSpecified class Drupal\migrate_cckfield_plugin_manager_test\Plugin\migrate\cckfield core/modules/migrate_drupal/tests/modules/migrate_cckfield_plugin_manager_test/src/Plugin/migrate/cckfield/D6NoCoreVersionSpecified.php Plugin annotation @MigrateCckField( id = "d6_no_core_version_specified", source_module = "foo", destination_module = "bar", )
D6NodeDeriver class Drupal\node\Plugin\migrate core/modules/node/src/Plugin/migrate/D6NodeDeriver.php Deriver for Drupal 6 node and node revision migrations based on node types. 4
D6NodeTranslation class Drupal\node\Plugin\migrate core/modules/node/src/Plugin/migrate/D6NodeTranslation.php Migration plugin for the Drupal 6 node translations. 2
D6TermNodeDeriver class Drupal\taxonomy\Plugin\migrate core/modules/taxonomy/src/Plugin/migrate/D6TermNodeDeriver.php Deriver for Drupal 6 term node migrations based on vocabularies. 3
D6VariableTranslation

in drupal:8.7.0 and is removed from drupal:9.0.0. Use \Drupal\migrate_drupal\Plugin\migrate\source\d6\VariableTranslation.

 class Drupal\migrate_drupal\Plugin\migrate\source\d6 core/modules/migrate_drupal/src/Plugin/migrate/source/d6/D6VariableTranslation.php Gets Drupal i18n_variable source from database.
D7Comment class Drupal\comment\Plugin\migrate core/modules/comment/src/Plugin/migrate/D7Comment.php Migration plugin for Drupal 7 comments with fields. 2
D7NodeDeriver class Drupal\node\Plugin\migrate core/modules/node/src/Plugin/migrate/D7NodeDeriver.php Deriver for Drupal 7 node and node revision migrations based on node types. 5
D7NodeTranslation class Drupal\node\Plugin\migrate core/modules/node/src/Plugin/migrate/D7NodeTranslation.php Migration plugin for the Drupal 7 node translations. 2
D7TaxonomyTermDeriver class Drupal\taxonomy\Plugin\migrate core/modules/taxonomy/src/Plugin/migrate/D7TaxonomyTermDeriver.php Deriver for Drupal 7 taxonomy term migrations based on vocabularies. 2
Data abstract class Drupal\jsonapi\JsonApiResource core/modules/jsonapi/src/JsonApiResource/Data.php Represents the `data` and `included` objects of a top-level object. 2 4
Database abstract class Drupal\Core\Database core/lib/Drupal/Core/Database/Database.php Primary front-controller for the database system. 318
DatabaseAccessDeniedException class Drupal\Core\Database core/lib/Drupal/Core/Database/DatabaseAccessDeniedException.php Exception thrown if access credentials fail. 2
DatabaseBackend class Drupal\Core\Flood core/lib/Drupal/Core/Flood/DatabaseBackend.php Defines the database flood backend. This is the default Drupal backend. 2 2
DatabaseBackend class Drupal\Core\Cache core/lib/Drupal/Core/Cache/DatabaseBackend.php Defines a default cache implementation. 4
DatabaseBackendFactory class Drupal\Core\Cache core/lib/Drupal/Core/Cache/DatabaseBackendFactory.php 2 2
DatabaseBackendFactoryTest class Drupal\Tests\Core\Cache core/tests/Drupal/Tests/Core/Cache/DatabaseBackendFactoryTest.php @coversDefaultClass \Drupal\Core\Cache\DatabaseBackendFactory[[api-linebreak]] @group Cache
DatabaseBackendTagTest class Drupal\KernelTests\Core\Cache core/tests/Drupal/KernelTests/Core/Cache/DatabaseBackendTagTest.php Tests DatabaseBackend cache tag implementation.
DatabaseBackendTest class Drupal\KernelTests\Core\Cache core/tests/Drupal/KernelTests/Core/Cache/DatabaseBackendTest.php Unit test of the database backend using the generic cache unit test base.
DatabaseCacheTagsChecksum class Drupal\Core\Cache core/lib/Drupal/Core/Cache/DatabaseCacheTagsChecksum.php Cache tags invalidations checksum implementation that uses the database. 2
DatabaseException interface Drupal\Core\Database core/lib/Drupal/Core/Database/DatabaseException.php Interface for a database exception. 19 19
DatabaseExceptionWrapper class Drupal\Core\Database core/lib/Drupal/Core/Database/DatabaseExceptionWrapper.php This wrapper class serves only to provide additional debug information. 19
DatabaseExceptionWrapperTest class Drupal\KernelTests\Core\Database core/tests/Drupal/KernelTests/Core/Database/DatabaseExceptionWrapperTest.php Tests exceptions thrown by queries.
DatabaseFileUsageBackend class Drupal\file\FileUsage core/modules/file/src/FileUsage/DatabaseFileUsageBackend.php Defines the database file usage backend. This is the default Drupal backend. 1 2
DatabaseLegacyTest class Drupal\KernelTests\Core\Database core/tests/Drupal/KernelTests/Core/Database/DatabaseLegacyTest.php Deprecation tests cases for the database layer.
DatabaseLockBackend class Drupal\Core\Lock core/lib/Drupal/Core/Lock/DatabaseLockBackend.php Defines the database lock backend. This is the default backend in Drupal. 1 3 2
DatabaseLockBackend class Drupal\Core\ProxyClass\Lock core/lib/Drupal/Core/ProxyClass/Lock/DatabaseLockBackend.php Provides a proxy class for \Drupal\Core\Lock\DatabaseLockBackend.
DatabaseNotFoundException class Drupal\Core\Database core/lib/Drupal/Core/Database/DatabaseNotFoundException.php Exception thrown if specified database is not found. 8
DatabaseQueue class Drupal\Core\Queue core/lib/Drupal/Core/Queue/DatabaseQueue.php Default queue implementation. 1 1
DatabaseStorage class Drupal\Core\KeyValueStore core/lib/Drupal/Core/KeyValueStore/DatabaseStorage.php Defines a default key/value store implementation. 1
DatabaseStorage class Drupal\Core\Config core/lib/Drupal/Core/Config/DatabaseStorage.php Defines the Database storage. 3 3
DatabaseStorageExpirable class Drupal\Core\KeyValueStore core/lib/Drupal/Core/KeyValueStore/DatabaseStorageExpirable.php Defines a default key/value store implementation for expiring items. 1
DatabaseStorageExpirableTest class Drupal\KernelTests\Core\KeyValueStore core/tests/Drupal/KernelTests/Core/KeyValueStore/DatabaseStorageExpirableTest.php Tests the key-value database storage.
DatabaseStorageTest class Drupal\KernelTests\Core\KeyValueStore core/tests/Drupal/KernelTests/Core/KeyValueStore/DatabaseStorageTest.php Tests the key-value database storage.
DatabaseStorageTest class Drupal\KernelTests\Core\Config\Storage core/tests/Drupal/KernelTests/Core/Config/Storage/DatabaseStorageTest.php Tests DatabaseStorage operations.
DatabaseTest class Drupal\Tests\Core\Database core/tests/Drupal/Tests/Core/Database/DatabaseTest.php @coversDefaultClass \Drupal\Core\Database\Database[[api-linebreak]]
DatabaseTestBase abstract class Drupal\KernelTests\Core\Database core/tests/Drupal/KernelTests/Core/Database/DatabaseTestBase.php Base class for databases database tests. 32 2

Other projects

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