Classes, traits, and interfaces - 9.5.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 1523

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
RequiredStateMissingException class Drupal\workflows\Exception core/modules/workflows/src/Exception/RequiredStateMissingException.php Indicates that a workflow does not contain a required state. 2
RequiredStatesTest class Drupal\Tests\workflows\Kernel core/modules/workflows/tests/src/Kernel/RequiredStatesTest.php Tests Workflow type's required states and configuration initialization.
RequiredStateTestType class Drupal\workflow_type_test\Plugin\WorkflowType core/modules/workflows/tests/modules/workflow_type_test/src/Plugin/WorkflowType/RequiredStateTestType.php Test workflow type.
RequirementsAwareDestinationInterface interface Drupal\Tests\migrate\Unit core/modules/migrate/tests/src/Unit/MigrationTest.php Defines the RequirementsAwareDestinationInterface.
RequirementsAwareSourceInterface interface Drupal\Tests\migrate\Unit core/modules/migrate/tests/src/Unit/MigrationTest.php Defines the RequirementsAwareSourceInterface.
RequirementsException class Drupal\migrate\Exception core/modules/migrate/src/Exception/RequirementsException.php Defines an exception thrown when a migration does not meet the requirements. 31
RequirementsExceptionTest class Drupal\Tests\migrate\Unit\Exception core/modules/migrate/tests/src/Unit/Exception/RequirementsExceptionTest.php @coversDefaultClass \Drupal\migrate\Exception\RequirementsException[[api-linebreak]] @group migrate
RequirementsInterface interface Drupal\migrate\Plugin core/modules/migrate/src/Plugin/RequirementsInterface.php An interface to check for a migrate plugin requirements. 5 7
RequirementsPageTrait trait Drupal\Tests core/tests/Drupal/Tests/RequirementsPageTrait.php Provides helper methods for the requirements page. 13
RequirementsTest class Drupal\Tests\system\Kernel\Module core/modules/system/tests/src/Kernel/Module/RequirementsTest.php @covers \hook_requirements[[api-linebreak]] @covers \hook_requirements_alter[[api-linebreak]] @group Module
RequirementsTest class Drupal\Tests\mysql\Functional core/modules/mysql/tests/src/Functional/RequirementsTest.php Tests isolation level warning when the config is set in settings.php.
ReservedWordTest class Drupal\KernelTests\Core\Database core/tests/Drupal/KernelTests/Core/Database/ReservedWordTest.php Tests queries that include reserved words.
ResettableStackedRouteMatchInterface interface Drupal\Core\Routing core/lib/Drupal/Core/Routing/ResettableStackedRouteMatchInterface.php Defines an interface for a resettable stack of route matches. 1
ResettableStaticTest class Drupal\KernelTests\Core\Bootstrap core/tests/Drupal/KernelTests/Core/Bootstrap/ResettableStaticTest.php Tests that drupal_static() and drupal_static_reset() work.
Resize class Drupal\system\Plugin\ImageToolkit\Operation\gd core/modules/system/src/Plugin/ImageToolkit/Operation/gd/Resize.php Defines GD2 resize operation. 1
ResizeImageEffect class Drupal\image\Plugin\ImageEffect core/modules/image/src/Plugin/ImageEffect/ResizeImageEffect.php Resizes an image resource. 2
ResolvedLibraryDefinitionsFilesMatchTest class Drupal\KernelTests\Core\Asset core/tests/Drupal/KernelTests/Core/Asset/ResolvedLibraryDefinitionsFilesMatchTest.php Tests that the asset files for all core libraries exist.
Resource class Drupal\media\OEmbed core/modules/media/src/OEmbed/Resource.php Value object representing an oEmbed resource. 6
ResourceBase abstract class Drupal\rest\Plugin core/modules/rest/src/Plugin/ResourceBase.php Common base class for resource plugins. 6 6
ResourceController class Drupal\media_test_oembed\Controller core/modules/media/tests/modules/media_test_oembed/src/Controller/ResourceController.php Test controller returning oEmbed resources from Media's test fixtures. 4
ResourceException class Drupal\media\OEmbed core/modules/media/src/OEmbed/ResourceException.php Exception thrown if an oEmbed resource cannot be fetched or parsed. 6
ResourceFetcher class Drupal\media\OEmbed core/modules/media/src/OEmbed/ResourceFetcher.php Fetches and caches oEmbed resources. 3 2
ResourceFetcherInterface interface Drupal\media\OEmbed core/modules/media/src/OEmbed/ResourceFetcherInterface.php Defines an interface for an oEmbed resource fetcher service. 1 6
ResourceFetcherTest class Drupal\Tests\media\Unit core/modules/media/tests/src/Unit/ResourceFetcherTest.php @group media
ResourceFetcherTest class Drupal\Tests\media\Kernel core/modules/media/tests/src/Kernel/ResourceFetcherTest.php @coversDefaultClass \Drupal\media\OEmbed\ResourceFetcher[[api-linebreak]]
ResourceFetcherTest class Drupal\Tests\media\Functional core/modules/media/tests/src/Functional/ResourceFetcherTest.php Tests the oEmbed resource fetcher service.
ResourceIdentifier class Drupal\jsonapi\JsonApiResource core/modules/jsonapi/src/JsonApiResource/ResourceIdentifier.php Represents a JSON:API resource identifier object. 5
ResourceIdentifierInterface interface Drupal\jsonapi\JsonApiResource core/modules/jsonapi/src/JsonApiResource/ResourceIdentifierInterface.php An interface for identifying a related resource. 3 3
ResourceIdentifierNormalizer class Drupal\jsonapi\Normalizer core/modules/jsonapi/src/Normalizer/ResourceIdentifierNormalizer.php Normalizes a Relationship according to the JSON:API specification. 1 2
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 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\jsonapi\EventSubscriber core/modules/jsonapi/src/EventSubscriber/ResourceResponseSubscriber.php Response subscriber that serializes and removes ResourceResponses' data. 2
ResourceResponseSubscriber class Drupal\rest\EventSubscriber core/modules/rest/src/EventSubscriber/ResourceResponseSubscriber.php Response subscriber that serializes and removes ResourceResponses' data. 1 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.

Other projects

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