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
ResourceIdentifierNormalizerTest class Drupal\Tests\jsonapi\Unit\Normalizer core/modules/jsonapi/tests/src/Unit/Normalizer/ResourceIdentifierNormalizerTest.php @coversDefaultClass \Drupal\jsonapi\Normalizer\ResourceIdentifierNormalizer[[api-linebreak]] @group jsonapi
ResourceIdentifierTrait trait Drupal\jsonapi\JsonApiResource core/modules/jsonapi/src/JsonApiResource/ResourceIdentifierTrait.php Used to associate an object like an exception to a particular resource. 1
ResourceInterface interface Drupal\rest\Plugin core/modules/rest/src/Plugin/ResourceInterface.php Specifies the publicly available methods of a resource plugin. 1 2 1
ResourceObject class Drupal\jsonapi\JsonApiResource core/modules/jsonapi/src/JsonApiResource/ResourceObject.php Represents a JSON:API resource object. 1 14
ResourceObjectData class Drupal\jsonapi\JsonApiResource core/modules/jsonapi/src/JsonApiResource/ResourceObjectData.php Represents the primary data for individual and collection documents. 2 6
ResourceObjectNormalizationCacher class Drupal\jsonapi\EventSubscriber core/modules/jsonapi/src/EventSubscriber/ResourceObjectNormalizationCacher.php Caches entity normalizations after the response has been sent. 2 2
ResourceObjectNormalizer class Drupal\jsonapi\Normalizer core/modules/jsonapi/src/Normalizer/ResourceObjectNormalizer.php Converts the JSON:API module ResourceObject into a JSON:API array structure. 2
ResourceObjectNormalizerCacherTest class Drupal\Tests\jsonapi\Kernel\EventSubscriber core/modules/jsonapi/tests/src/Kernel/EventSubscriber/ResourceObjectNormalizerCacherTest.php @coversDefaultClass \Drupal\jsonapi\EventSubscriber\ResourceObjectNormalizationCacher[[api-linebreak]] @group jsonapi
ResourcePluginManager class Drupal\rest\Plugin\Type core/modules/rest/src/Plugin/Type/ResourcePluginManager.php Manages discovery and instantiation of resource plugins. 2 2
ResourceResponse class Drupal\rest core/modules/rest/src/ResourceResponse.php Contains data for serialization before sending the response. 6
ResourceResponse class Drupal\jsonapi core/modules/jsonapi/src/ResourceResponse.php Contains data for serialization before sending the response. 1 6
ResourceResponseInterface interface Drupal\rest core/modules/rest/src/ResourceResponseInterface.php Defines a common interface for resource responses. 2 3
ResourceResponseSubscriber class Drupal\rest\EventSubscriber core/modules/rest/src/EventSubscriber/ResourceResponseSubscriber.php Response subscriber that serializes and removes ResourceResponses' data. 1 2
ResourceResponseSubscriber class Drupal\jsonapi\EventSubscriber core/modules/jsonapi/src/EventSubscriber/ResourceResponseSubscriber.php Response subscriber that serializes and removes ResourceResponses' data. 2
ResourceResponseSubscriberTest class Drupal\Tests\rest\Unit\EventSubscriber core/modules/rest/tests/src/Unit/EventSubscriber/ResourceResponseSubscriberTest.php @coversDefaultClass \Drupal\rest\EventSubscriber\ResourceResponseSubscriber[[api-linebreak]] @group rest
ResourceResponseTestTrait trait Drupal\Tests\jsonapi\Functional core/modules/jsonapi/tests/src/Functional/ResourceResponseTestTrait.php Utility methods for handling resource responses.
ResourceResponseTrait trait Drupal\rest core/modules/rest/src/ResourceResponseTrait.php
ResourceResponseValidator class Drupal\jsonapi\EventSubscriber core/modules/jsonapi/src/EventSubscriber/ResourceResponseValidator.php Response subscriber that validates a JSON:API response. 1 2
ResourceResponseValidatorTest class Drupal\Tests\jsonapi\Unit\EventSubscriber core/modules/jsonapi/tests/src/Unit/EventSubscriber/ResourceResponseValidatorTest.php @coversDefaultClass \Drupal\jsonapi\EventSubscriber\ResourceResponseValidator[[api-linebreak]] @group jsonapi
ResourceRoutes class Drupal\rest\Routing core/modules/rest/src/Routing/ResourceRoutes.php Subscriber for REST-style routes. 2
ResourceTest class Drupal\Tests\rest\Functional core/modules/rest/tests/src/Functional/ResourceTest.php Tests the structure of a REST resource.
ResourceTest class Drupal\Tests\media\Unit core/modules/media/tests/src/Unit/ResourceTest.php @coversDefaultClass \Drupal\media\OEmbed\Resource[[api-linebreak]] @group media
ResourceTestBase abstract class Drupal\Tests\jsonapi\Functional core/modules/jsonapi/tests/src/Functional/ResourceTestBase.php Subclass this for every JSON:API resource type. 17 1
ResourceTestBase abstract class Drupal\Tests\rest\Functional core/modules/rest/tests/src/Functional/ResourceTestBase.php Subclass this for every REST resource, every format and every auth provider. 6 5
ResourceType class Drupal\jsonapi\ResourceType core/modules/jsonapi/src/ResourceType/ResourceType.php Value object containing all metadata for a JSON:API resource type. 1 29
ResourceTypeAttribute class Drupal\jsonapi\ResourceType core/modules/jsonapi/src/ResourceType/ResourceTypeAttribute.php Specialization of a ResourceTypeField to represent a resource type attribute.
ResourceTypeBuildEvent class Drupal\jsonapi\ResourceType core/modules/jsonapi/src/ResourceType/ResourceTypeBuildEvent.php An event used to configure the construction of a JSON:API resource type. 1
ResourceTypeBuildEvents final class Drupal\jsonapi\ResourceType core/modules/jsonapi/src/ResourceType/ResourceTypeBuildEvents.php Contains all events emitted during the resource type build process. 1
ResourceTypeBuildEventSubscriber class Drupal\jsonapi_test_resource_type_building\EventSubscriber core/modules/jsonapi/tests/modules/jsonapi_test_resource_type_building/src/EventSubscriber/ResourceTypeBuildEventSubscriber.php Event subscriber which tests disabling resource types. 2
ResourceTypeConverter class Drupal\jsonapi\ParamConverter core/modules/jsonapi/src/ParamConverter/ResourceTypeConverter.php Parameter converter for upcasting JSON:API resource type names to objects. 1 2
ResourceTypeField abstract class Drupal\jsonapi\ResourceType core/modules/jsonapi/src/ResourceType/ResourceTypeField.php Abstract value object containing all metadata for a JSON:API resource field. 2 1
ResourceTypeRelationship class Drupal\jsonapi\ResourceType core/modules/jsonapi/src/ResourceType/ResourceTypeRelationship.php Specialization of a ResourceTypeField to represent a resource relationship. 4
ResourceTypeRepository class Drupal\jsonapi\ResourceType core/modules/jsonapi/src/ResourceType/ResourceTypeRepository.php Provides a repository of all JSON:API resource types. 2 5 2
ResourceTypeRepositoryInterface interface Drupal\jsonapi\ResourceType core/modules/jsonapi/src/ResourceType/ResourceTypeRepositoryInterface.php Provides a repository of all JSON:API resource types. 1 7
ResourceTypeRepositoryTest class Drupal\Tests\jsonapi\Kernel\ResourceType core/modules/jsonapi/tests/src/Kernel/ResourceType/ResourceTypeRepositoryTest.php @coversDefaultClass \Drupal\jsonapi\ResourceType\ResourceTypeRepository[[api-linebreak]] @group jsonapi @group #slow
ResourceVersionRouteEnhancer final class Drupal\jsonapi\Revisions core/modules/jsonapi/src/Revisions/ResourceVersionRouteEnhancer.php Loads an appropriate revision for the requested resource version. 1 2
ResponseDisplayPluginInterface interface Drupal\views\Plugin\views\display core/modules/views/src/Plugin/views/display/ResponseDisplayPluginInterface.php Defines a display which returns a Response object. 2 1
ResponseGeneratorSubscriber class Drupal\Core\EventSubscriber core/lib/Drupal/Core/EventSubscriber/ResponseGeneratorSubscriber.php Response subscriber to add X-Generator header tag. 2
ResponseGeneratorTest class Drupal\Tests\system\Functional\System core/modules/system/tests/src/Functional/System/ResponseGeneratorTest.php Tests to see if generator header is added.
ResponseKeepSessionOpenInterface interface Drupal\Core\Session core/lib/Drupal/Core/Session/ResponseKeepSessionOpenInterface.php Indicates that sessions for this response should be kept open after sending. 1 2
ResponsePolicyInterface interface Drupal\Core\PageCache core/lib/Drupal/Core/PageCache/ResponsePolicyInterface.php Defines the interface for response policy implementations. 7 13
ResponseStatus class Drupal\system\Plugin\Condition core/modules/system/src/Plugin/Condition/ResponseStatus.php Provides a 'Response status' condition.
ResponseStatusTest class Drupal\KernelTests\Core\Plugin\Condition core/tests/Drupal/KernelTests/Core/Plugin/Condition/ResponseStatusTest.php Tests the Response Status Condition, provided by the system module.
ResponseTest class Drupal\Tests\system\Functional\Form core/modules/system/tests/src/Functional/Form/ResponseTest.php Tests the form API Response element.
ResponsiveImage class Drupal\responsive_image\Element core/modules/responsive_image/src/Element/ResponsiveImage.php Provides a responsive image element.
ResponsiveImageAdminUITest class Drupal\Tests\responsive_image\Functional core/modules/responsive_image/tests/src/Functional/ResponsiveImageAdminUITest.php Thoroughly test the administrative interface of the Responsive Image module.
ResponsiveImageConfigUpdater final class Drupal\responsive_image core/modules/responsive_image/src/ResponsiveImageConfigUpdater.php Provides a BC layer for modules providing old configurations. 3
ResponsiveImageFieldDisplayTest class Drupal\Tests\responsive_image\Functional core/modules/responsive_image/tests/src/Functional/ResponsiveImageFieldDisplayTest.php Tests responsive image display formatter.
ResponsiveImageFieldUiTest class Drupal\Tests\responsive_image\FunctionalJavascript core/modules/responsive_image/tests/src/FunctionalJavascript/ResponsiveImageFieldUiTest.php Tests the responsive image field UI.
ResponsiveImageFormatter class Drupal\responsive_image\Plugin\Field\FieldFormatter core/modules/responsive_image/src/Plugin/Field/FieldFormatter/ResponsiveImageFormatter.php Plugin for responsive image formatter. 1 2

Other projects

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