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
JsonApiPatchRegressionTest class Drupal\Tests\jsonapi\Functional core/modules/jsonapi/tests/src/Functional/JsonApiPatchRegressionTest.php JSON:API regression tests.
JsonApiPerformanceTest class Drupal\Tests\jsonapi\FunctionalJavascript core/modules/jsonapi/tests/src/FunctionalJavascript/JsonApiPerformanceTest.php Tests performance for JSON:API routes.
JsonApiRegressionTest class Drupal\Tests\jsonapi\Functional core/modules/jsonapi/tests/src/Functional/JsonApiRegressionTest.php JSON:API regression tests.
JsonApiRelationshipTest class Drupal\Tests\jsonapi\Functional core/modules/jsonapi/tests/src/Functional/JsonApiRelationshipTest.php JSON:API resource 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
JsonapiRequirements class Drupal\jsonapi\Hook core/modules/jsonapi/src/Hook/JsonapiRequirements.php Requirements for the JSON:API module.
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 1
JsonApiSpec class Drupal\jsonapi core/modules/jsonapi/src/JsonApiSpec.php Defines constants used for compliance with the JSON:API specification. 60
JsonApiSpecTest class Drupal\Tests\jsonapi\Unit core/modules/jsonapi/tests/src/Unit/JsonApiSpecTest.php Tests Drupal\jsonapi\JsonApiSpec.
JsonapiTestFieldAccessHooks class Drupal\jsonapi_test_field_access\Hook core/modules/jsonapi/tests/modules/jsonapi_test_field_access/src/Hook/JsonapiTestFieldAccessHooks.php Hook implementations for jsonapi_test_field_access.
JsonapiTestNonCacheableMethodsHooks class Drupal\jsonapi_test_non_cacheable_methods\Hook core/modules/jsonapi/tests/modules/jsonapi_test_non_cacheable_methods/src/Hook/JsonapiTestNonCacheableMethodsHooks.php Hook implementations for jsonapi_test_non_cacheable_methods.
JsonapiTestUserHooks class Drupal\jsonapi_test_user\Hook core/modules/jsonapi/tests/modules/jsonapi_test_user/src/Hook/JsonapiTestUserHooks.php Hook implementations for jsonapi_test_user.
JsonApiTopLevelResourceNormalizerTest class Drupal\Tests\jsonapi\Kernel\Normalizer core/modules/jsonapi/tests/src/Kernel/Normalizer/JsonApiTopLevelResourceNormalizerTest.php Tests Drupal\jsonapi\Normalizer\JsonApiDocumentTopLevelNormalizer.
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\serialization\Encoder core/modules/serialization/src/Encoder/JsonEncoder.php Adds 'ajax' to the supported content types of the JSON encoder. 1 4 4
JsonEncoder class Drupal\jsonapi\Encoder core/modules/jsonapi/src/Encoder/JsonEncoder.php Encodes JSON:API data. 1 2
JsonEncoderTest class Drupal\Tests\jsonapi\Unit\Encoder core/modules/jsonapi/tests/src/Unit/Encoder/JsonEncoderTest.php Tests the JSON:API encoder.
JsonEncoderTest class Drupal\Tests\serialization\Unit\Encoder core/modules/serialization/tests/src/Unit/Encoder/JsonEncoderTest.php Tests Drupal\serialization\Encoder\JsonEncoder.
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
JsonSchema class Drupal\Core\Serialization\Attribute core/lib/Drupal/Core/Serialization/Attribute/JsonSchema.php Attribute for methods to express the JSON Schema of its return value. 15
JsonSchemaProviderSerializerInterface interface Drupal\serialization\Serializer core/modules/serialization/src/Serializer/JsonSchemaProviderSerializerInterface.php Interface for JSON schema provider. 2 4
JsonSchemaProviderSerializerTrait trait Drupal\serialization\Serializer core/modules/serialization/src/Serializer/JsonSchemaProviderSerializerTrait.php Trait for normalizing the JSON schema. 1
JsonSchemaReflectionTrait trait Drupal\serialization\Normalizer core/modules/serialization/src/Normalizer/JsonSchemaReflectionTrait.php Interface for using reflection with the JSON object. 1
JsonSchemaTestTrait trait Drupal\Tests\serialization\Traits core/modules/serialization/tests/src/Traits/JsonSchemaTestTrait.php Trait for testing JSON Schema validity and fit to sample data. 7
JsonTest class Drupal\Tests\Component\Serialization core/tests/Drupal/Tests/Component/Serialization/JsonTest.php Tests Drupal\Component\Serialization\Json.
JsonTestFieldFilterAccessHooks class Drupal\jsonapi_test_field_filter_access\Hook core/modules/jsonapi/tests/modules/jsonapi_test_field_filter_access/src/Hook/JsonTestFieldFilterAccessHooks.php Hook implementations for jsonapi_test_field_filter_access.
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.
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. 729 733
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.
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.

Other projects

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