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

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
JSMessageTestController class Drupal\js_message_test\Controller core/modules/system/tests/modules/js_message_test/src/Controller/JSMessageTestController.php Test Controller to show message links. 2
Json class Drupal\Component\Serialization core/lib/Drupal/Component/Serialization/Json.php Default serialization for JSON. 104 3
JsonApiDocumentTopLevel class Drupal\jsonapi\JsonApiResource core/modules/jsonapi/src/JsonApiResource/JsonApiDocumentTopLevel.php Represents a JSON:API document's "top level". 9
JsonApiDocumentTopLevelNormalizer class Drupal\jsonapi\Normalizer core/modules/jsonapi/src/Normalizer/JsonApiDocumentTopLevelNormalizer.php Normalizes the top-level document according to the JSON:API specification. 1 2
JsonApiDocumentTopLevelNormalizerTest class Drupal\Tests\jsonapi\Unit\Normalizer core/modules/jsonapi/tests/src/Unit/Normalizer/JsonApiDocumentTopLevelNormalizerTest.php @coversDefaultClass \Drupal\jsonapi\Normalizer\JsonApiDocumentTopLevelNormalizer[[api-linebreak]] @group jsonapi
JsonApiDocumentTopLevelNormalizerTest class Drupal\Tests\jsonapi\Kernel\Normalizer core/modules/jsonapi/tests/src/Kernel/Normalizer/JsonApiDocumentTopLevelNormalizerTest.php @coversDefaultClass \Drupal\jsonapi\Normalizer\JsonApiDocumentTopLevelNormalizer[[api-linebreak]] @group jsonapi @group #slow
JsonApiFilterRegressionTest class Drupal\Tests\jsonapi\Functional core/modules/jsonapi/tests/src/Functional/JsonApiFilterRegressionTest.php JSON:API regression tests.
JsonApiFunctionalDateFieldTest class Drupal\Tests\jsonapi\Functional core/modules/jsonapi/tests/src/Functional/JsonApiFunctionalDateFieldTest.php JSON:API integration test for the "Date" field.
JsonApiFunctionalMultilingualTest class Drupal\Tests\jsonapi\Functional core/modules/jsonapi/tests/src/Functional/JsonApiFunctionalMultilingualTest.php Tests JSON:API multilingual support.
JsonApiFunctionalTest class Drupal\Tests\jsonapi\Functional core/modules/jsonapi/tests/src/Functional/JsonApiFunctionalTest.php General functional test class.
JsonApiFunctionalTestBase abstract class Drupal\Tests\jsonapi\Functional core/modules/jsonapi/tests/src/Functional/JsonApiFunctionalTestBase.php Provides helper methods for the JSON:API module's functional tests. 6
JsonapiKernelTestBase abstract class Drupal\Tests\jsonapi\Kernel core/modules/jsonapi/tests/src/Kernel/JsonapiKernelTestBase.php Contains shared test utility methods. 11 11
JsonapiMaintenanceModeSubscriber class Drupal\jsonapi\EventSubscriber core/modules/jsonapi/src/EventSubscriber/JsonapiMaintenanceModeSubscriber.php Maintenance mode subscriber for JSON:API requests. 2
JsonApiPatchRegressionTest class Drupal\Tests\jsonapi\Functional core/modules/jsonapi/tests/src/Functional/JsonApiPatchRegressionTest.php JSON:API regression tests.
JsonApiRegressionTest class Drupal\Tests\jsonapi\Functional core/modules/jsonapi/tests/src/Functional/JsonApiRegressionTest.php JSON:API regression tests.
JsonApiRequestTestTrait trait Drupal\Tests\jsonapi\Functional core/modules/jsonapi/tests/src/Functional/JsonApiRequestTestTrait.php Boilerplate for JSON:API Functional tests' HTTP requests. 1
JsonApiRequestValidator class Drupal\jsonapi\EventSubscriber core/modules/jsonapi/src/EventSubscriber/JsonApiRequestValidator.php Subscriber that validates the query parameter names on a JSON:API request. 2
JsonapiServiceProvider class Drupal\jsonapi core/modules/jsonapi/src/JsonapiServiceProvider.php Adds 'api_json' as known format and prevents its use in the REST module.
JsonApiSettingsForm class Drupal\jsonapi\Form core/modules/jsonapi/src/Form/JsonApiSettingsForm.php Configure JSON:API settings for this site. 1
JsonApiSpec class Drupal\jsonapi core/modules/jsonapi/src/JsonApiSpec.php Defines constants used for compliance with the JSON:API specification. 7
JsonApiSpecTest class Drupal\Tests\jsonapi\Unit core/modules/jsonapi/tests/src/Unit/JsonApiSpecTest.php @coversDefaultClass \Drupal\jsonapi\JsonApiSpec[[api-linebreak]] @group jsonapi
JsOnceTestController class Drupal\js_once_test\Controller core/modules/system/tests/modules/js_once_test/src/Controller/JsOnceTestController.php Controller for testing the @drupal/once library integration.
JsonEncoder class Drupal\jsonapi\Encoder core/modules/jsonapi/src/Encoder/JsonEncoder.php Encodes JSON:API data. 2
JsonEncoder class Drupal\serialization\Encoder core/modules/serialization/src/Encoder/JsonEncoder.php Adds 'ajax' to the supported content types of the JSON encoder. 1 4 4
JsonEncoderTest class Drupal\Tests\serialization\Unit\Encoder core/modules/serialization/tests/src/Unit/Encoder/JsonEncoderTest.php @coversDefaultClass \Drupal\serialization\Encoder\JsonEncoder[[api-linebreak]] @group serialization
JsonRenderer class Drupal\common_test\Render\MainContent core/modules/system/tests/modules/common_test/src/Render/MainContent/JsonRenderer.php Default main content renderer for JSON requests. 2
JsonTest class Drupal\Tests\Component\Serialization core/tests/Drupal/Tests/Component/Serialization/JsonTest.php @coversDefaultClass \Drupal\Component\Serialization\Json[[api-linebreak]] @group Serialization
JsOptimizer class Drupal\Core\Asset core/lib/Drupal/Core/Asset/JsOptimizer.php Optimizes a JavaScript asset. 1 2
JsOptimizerUnitTest class Drupal\Tests\Core\Asset core/tests/Drupal/Tests/Core/Asset/JsOptimizerUnitTest.php Tests the JS asset optimizer.
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\js_webassert_test\Form core/modules/system/tests/modules/js_webassert_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" )
KernelDestructionSubscriber

in drupal:10.3.0 and is removed from drupal:11.0.0. There is no replacement.

class Drupal\Core\EventSubscriber core/lib/Drupal/Core/EventSubscriber/KernelDestructionSubscriber.php Destructs services that are initiated and tagged with "needs_destruction".
KernelMissingDependentModuleMethodTest

in drupal:10.3.0 and is removed from drupal:11.0.0. There is no replacement.

class Drupal\KernelTests core/tests/fixtures/KernelMissingDependentModuleMethodTest.php A fixture test class with requires annotation.
KernelMissingDependentModuleTest

in drupal:10.3.0 and is removed from drupal:11.0.0. There is no replacement.

class Drupal\KernelTests core/tests/fixtures/KernelMissingDependentModuleTest.php A fixture test class with requires annotation.
KernelPreHandle class Drupal\Core\StackMiddleware core/lib/Drupal/Core/StackMiddleware/KernelPreHandle.php Prepares the environment after page caching ran. 2
KernelTestBase abstract class Drupal\KernelTests core/tests/Drupal/KernelTests/KernelTestBase.php Base class for functional integration tests. 640 642
KernelTestBaseDatabaseDriverModuleTest class Drupal\KernelTests core/tests/Drupal/KernelTests/KernelTestBaseDatabaseDriverModuleTest.php @coversDefaultClass \Drupal\KernelTests\KernelTestBase[[api-linebreak]]
KernelTestBaseShutdownTest class Drupal\KernelTests core/tests/Drupal/KernelTests/KernelTestBaseShutdownTest.php @coversDefaultClass \Drupal\KernelTests\KernelTestBase[[api-linebreak]]
KernelTestBaseTest class Drupal\KernelTests core/tests/Drupal/KernelTests/KernelTestBaseTest.php @coversDefaultClass \Drupal\KernelTests\KernelTestBase[[api-linebreak]]
KernelTestBaseTest class Drupal\Tests\pgsql\Kernel\pgsql core/modules/pgsql/tests/src/Kernel/pgsql/KernelTestBaseTest.php @coversDefaultClass \Drupal\KernelTests\KernelTestBase[[api-linebreak]]
KernelTestSuite

in drupal:10.3.0 and is removed from drupal:11.0.0. There is no replacement and test discovery will be handled differently in PHPUnit 10.

class Drupal\Tests\TestSuites core/tests/TestSuites/KernelTestSuite.php Discovers tests for the kernel test suite.
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

Other projects


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