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
JsOptimizerUnitTest class Drupal\Tests\Core\Asset core/tests/Drupal/Tests/Core/Asset/JsOptimizerUnitTest.php Tests the JS asset optimizer.
JsTestingAjaxRequestTestHooks class Drupal\js_testing_ajax_request_test\Hook core/modules/system/tests/modules/js_testing_ajax_request_test/src/Hook/JsTestingAjaxRequestTestHooks.php Hook implementations for js_testing_ajax_request_test.
JsTestingLogTestHooks class Drupal\js_testing_log_test\Hook core/modules/system/tests/modules/js_testing_log_test/src/Hook/JsTestingLogTestHooks.php Hook implementations for js_testing_log_test.
JSTranslationTest class Drupal\Tests\ckeditor5\FunctionalJavascript core/modules/ckeditor5/tests/src/FunctionalJavascript/JSTranslationTest.php Tests for CKEditor 5 plugins using Drupal's translation system.
JSWebAssert class Drupal\FunctionalJavascriptTests core/tests/Drupal/FunctionalJavascriptTests/JSWebAssert.php Defines a class with methods for asserting presence of elements during tests. 1 1
JSWebAssertTest class Drupal\FunctionalJavascriptTests\Tests core/tests/Drupal/FunctionalJavascriptTests/Tests/JSWebAssertTest.php Tests for the JSWebAssert class.
JsWebAssertTestForm class Drupal\jswebassert_test\Form core/modules/system/tests/modules/jswebassert_test/src/Form/JsWebAssertTestForm.php Test form for JSWebAssert WebDriverTestBase. 1
JUnitConverter class Drupal\Core\Test core/lib/Drupal/Core/Test/JUnitConverter.php Converts JUnit XML to Drupal's {simpletest} schema. 2
JUnitConverterTest class Drupal\Tests\Core\Test core/tests/Drupal/Tests/Core/Test/JUnitConverterTest.php Tests Drupal\Core\Test\JUnitConverter.
Kale class Drupal\plugin_test\Plugin\plugin_test\fruit core/modules/system/tests/modules/plugin_test/src/Plugin/plugin_test/fruit/Kale.php Plugin annotation @Plugin( id = "kale", label = "Kale", color = "green" )
KernelPreHandle class Drupal\Core\StackMiddleware core/lib/Drupal/Core/StackMiddleware/KernelPreHandle.php Prepares the environment after page caching ran. 2
KernelTest final class Drupal\Tests\Component\Foo core/tests/PHPStan/fixtures/component-tests.php
KernelTestBase abstract class Drupal\KernelTests core/tests/Drupal/KernelTests/KernelTestBase.php Base class for functional integration tests. 762 767
KernelTestBaseDatabaseDriverModuleTest class Drupal\KernelTests core/tests/Drupal/KernelTests/KernelTestBaseDatabaseDriverModuleTest.php Tests Drupal\KernelTests\KernelTestBase.
KernelTestBaseShutdownTest class Drupal\KernelTests core/tests/Drupal/KernelTests/KernelTestBaseShutdownTest.php Tests Drupal\KernelTests\KernelTestBase.
KernelTestBaseTest class Drupal\KernelTests core/tests/Drupal/KernelTests/KernelTestBaseTest.php Tests Drupal\KernelTests\KernelTestBase.
KernelTestBaseTest class Drupal\Tests\pgsql\Kernel\pgsql core/modules/pgsql/tests/src/Kernel/pgsql/KernelTestBaseTest.php Tests Drupal\KernelTests\KernelTestBase.
KernelTestCompilerPass class Drupal\KernelTests core/tests/Drupal/KernelTests/KernelTestCompilerPass.php Adds hooks from kernel test to event dispatcher and module handler.
KernelTestDynamicPageCacheRequestPolicy class Drupal\Tests\Traits\Core\Cache core/tests/Drupal/Tests/Traits/Core/Cache/PageCachePolicyTrait.php Replaces the dynamic_page_cache module's default request policy.
KernelTestHooksTest class Drupal\KernelTests\Core\Hook core/tests/Drupal/KernelTests/Core/Hook/KernelTestHooksTest.php Tests that hook implementations in Kernel test classes are executed.
KernelTestHttpCacheRequestTest class Drupal\KernelTests core/tests/Drupal/KernelTests/KernelTestHttpCacheRequestTest.php Tests making HTTP requests with page cache in a kernel test.
KernelTestHttpDynamicCacheRequestTest class Drupal\KernelTests core/tests/Drupal/KernelTests/KernelTestHttpDynamicCacheRequestTest.php Tests making HTTP requests with dynamic page cache in a kernel test.
KernelTestHttpRequestTest class Drupal\KernelTests core/tests/Drupal/KernelTests/KernelTestHttpRequestTest.php Tests making HTTP requests in a kernel test.
KernelTestPageCacheRequestPolicy class Drupal\Tests\Traits\Core\Cache core/tests/Drupal/Tests/Traits/Core/Cache/PageCachePolicyTrait.php Replaces the page_cache module's default request policy.
KeyValueContentEntityStorage class Drupal\Core\Entity\KeyValueStore core/lib/Drupal/Core/Entity/KeyValueStore/KeyValueContentEntityStorage.php Provides a key value backend for content entities.
KeyValueContentEntityStorageTest class Drupal\KernelTests\Core\KeyValueStore core/tests/Drupal/KernelTests/Core/KeyValueStore/KeyValueContentEntityStorageTest.php Tests KeyValueEntityStorage for content entities.
KeyValueDatabaseExpirableFactory class Drupal\Core\KeyValueStore core/lib/Drupal/Core/KeyValueStore/KeyValueDatabaseExpirableFactory.php Defines the key/value store factory for the database backend. 1 2
KeyValueDatabaseFactory class Drupal\Core\KeyValueStore core/lib/Drupal/Core/KeyValueStore/KeyValueDatabaseFactory.php Defines the key/value store factory for the database backend. 1 2
KeyValueEntityStorage class Drupal\Core\Entity\KeyValueStore core/lib/Drupal/Core/Entity/KeyValueStore/KeyValueEntityStorage.php Provides a key value backend for entities. 1 1
KeyValueEntityStorageTest class Drupal\Tests\Core\Entity\KeyValueStore core/tests/Drupal/Tests/Core/Entity/KeyValueStore/KeyValueEntityStorageTest.php Tests Drupal\Core\Entity\KeyValueStore\KeyValueEntityStorage.
KeyValueExpirableFactory class Drupal\Core\KeyValueStore core/lib/Drupal/Core/KeyValueStore/KeyValueExpirableFactory.php Defines the key/value store factory. 2 2
KeyValueExpirableFactoryInterface interface Drupal\Core\KeyValueStore core/lib/Drupal/Core/KeyValueStore/KeyValueExpirableFactoryInterface.php Defines the expirable key/value store factory interface. 3 8
KeyValueFactory class Drupal\Core\KeyValueStore core/lib/Drupal/Core/KeyValueStore/KeyValueFactory.php Defines the key/value store factory. 1 3 2
KeyValueFactoryInterface interface Drupal\Core\KeyValueStore core/lib/Drupal/Core/KeyValueStore/KeyValueFactoryInterface.php Defines the key/value store factory interface. 3 40
KeyValueMemoryFactory class Drupal\Core\KeyValueStore core/lib/Drupal/Core/KeyValueStore/KeyValueMemoryFactory.php Defines the key/value store factory for the memory backend. 15
KeyValueNullExpirableFactory class Drupal\Core\KeyValueStore core/lib/Drupal/Core/KeyValueStore/KeyValueNullExpirableFactory.php Defines the key/value store factory for the null backend.
KeyValueStoreExpirableInterface interface Drupal\Core\KeyValueStore core/lib/Drupal/Core/KeyValueStore/KeyValueStoreExpirableInterface.php Defines the interface for expiring data in a key/value store. 2 11
KeyValueStoreInterface interface Drupal\Core\KeyValueStore core/lib/Drupal/Core/KeyValueStore/KeyValueStoreInterface.php Defines the interface for key/value store implementations. 2 19 2
KeyvalueTestHooks class Drupal\keyvalue_test\Hook core/modules/system/tests/modules/keyvalue_test/src/Hook/KeyvalueTestHooks.php Hook implementations for keyvalue_test.
KillSwitch class Drupal\Core\PageCache\ResponsePolicy core/lib/Drupal/Core/PageCache/ResponsePolicy/KillSwitch.php A policy evaluating to static::DENY when the kill switch was triggered. 2 2
Label class Drupal\Core\Render\Element core/lib/Drupal/Core/Render/Element/Label.php Provides a render element for displaying the label for a form element.
LabelOnlyResourceObject final class Drupal\jsonapi\JsonApiResource core/modules/jsonapi/src/JsonApiResource/LabelOnlyResourceObject.php Value object decorating a ResourceObject; only its label is available. 3
LangcodeRequiredIfTranslatableValuesConstraint class Drupal\Core\Config\Plugin\Validation\Constraint core/lib/Drupal/Core/Config/Plugin/Validation/Constraint/LangcodeRequiredIfTranslatableValuesConstraint.php Validation constraint for translatable configuration.
LangcodeRequiredIfTranslatableValuesConstraintValidator final class Drupal\Core\Config\Plugin\Validation\Constraint core/lib/Drupal/Core/Config/Plugin/Validation/Constraint/LangcodeRequiredIfTranslatableValuesConstraintValidator.php Validates the LangcodeRequiredIfTranslatableValues constraint.
Language class Drupal\Core\Language core/lib/Drupal/Core/Language/Language.php An object containing the information for an interface language. 60
Language class Drupal\Core\TypedData\Plugin\DataType core/lib/Drupal/Core/TypedData/Plugin/DataType/Language.php Defines the 'language' data type.
Language class Drupal\ckeditor5\Plugin\CKEditor5Plugin core/modules/ckeditor5/src/Plugin/CKEditor5Plugin/Language.php CKEditor 5 Language plugin. 2 1
Language class Drupal\language\Plugin\migrate\source core/modules/language/src/Plugin/migrate/source/Language.php Drupal 6/7 language source from database. 1
Language class Drupal\language\Plugin\Condition core/modules/language/src/Plugin/Condition/Language.php Provides a 'Language' condition.
LanguageAccessControlHandler class Drupal\language core/modules/language/src/LanguageAccessControlHandler.php Defines the access control handler for the language entity type. 1

Other projects

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