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
| Name | Type | Namespace | Location | Description |
Direct uses |
Use statements | Strings |
|---|---|---|---|---|---|---|---|
| FileUpload | class |
Drupal\ |
core/ |
Handles file upload requests. | 2 | ||
| JsonEncoder | class |
Drupal\ |
core/ |
Encodes JSON:API data. | 2 | ||
| DefaultExceptionSubscriber | class |
Drupal\ |
core/ |
Serializes exceptions in compliance with the JSON:API specification. | 2 | ||
| JsonApiRequestValidator | class |
Drupal\ |
core/ |
Request subscriber that validates a JSON:API request. | 2 | ||
| JsonapiMaintenanceModeSubscriber | class |
Drupal\ |
core/ |
Maintenance mode subscriber for JSON:API requests. | 2 | ||
| ResourceObjectNormalizationCacher | class |
Drupal\ |
core/ |
Caches entity normalizations after the response has been sent. | 1 | 2 | |
| ResourceResponseSubscriber | class |
Drupal\ |
core/ |
Response subscriber that serializes and removes ResourceResponses' data. | 2 | ||
| ResourceResponseValidator | class |
Drupal\ |
core/ |
Response subscriber that validates a JSON:API response. | 1 | 2 | |
| EntityAccessDeniedHttpException | class |
Drupal\ |
core/ |
Enhances the access denied exception with information about the entity. | 7 | ||
| UnprocessableHttpEntityException | class |
Drupal\ |
core/ |
A class to represent a 422 - Unprocessable Entity Exception. | 2 | ||
| ErrorCollection | class |
Drupal\ |
core/ |
To be used when the primary data is `errors`. | 2 | ||
| JsonApiDocumentTopLevel | class |
Drupal\ |
core/ |
Represents a JSON:API document's "top level". | 4 | ||
| LabelOnlyResourceObject | final class |
Drupal\ |
core/ |
Value object decorating a ResourceObject; only its label is available. | 2 | ||
| Link | final class |
Drupal\ |
core/ |
Represents an RFC8288 based link. | 4 | ||
| LinkCollection | final class |
Drupal\ |
core/ |
Contains a set of JSON:API Link objects. | 5 | ||
| NullIncludedData | class |
Drupal\ |
core/ |
Use when there are no included resources but a Data object is required. | 4 | ||
| OmittedData | class |
Drupal\ |
core/ |
Represents resource data that should be omitted from the JSON:API document. | |||
| Relationship | class |
Drupal\ |
core/ |
Represents references from one resource object to other resource object(s). | |||
| RelationshipData | class |
Drupal\ |
core/ |
Represents the data of a relationship object or relationship document. | |||
| ResourceIdentifier | class |
Drupal\ |
core/ |
Represents a JSON:API resource identifier object. | 2 | ||
| ConfigEntityDenormalizer | final class |
Drupal\ |
core/ |
Converts the Drupal config entity object to a JSON:API array structure. | 2 | ||
| ContentEntityDenormalizer | final class |
Drupal\ |
core/ |
Converts a JSON:API array structure into a Drupal entity object. | 2 | ||
| EntityAccessDeniedHttpExceptionNormalizer | class |
Drupal\ |
core/ |
Normalizes an EntityAccessDeniedException. | 2 | ||
| NormalizerBase | abstract class |
Drupal\ |
core/ |
Base normalizer used in all JSON:API normalizers. | |||
| UnprocessableHttpEntityExceptionNormalizer | class |
Drupal\ |
core/ |
Normalizes and UnprocessableHttpEntityException. | 2 | ||
| EntityUuidConverter | class |
Drupal\ |
core/ |
Parameter converter for upcasting entity UUIDs to full objects. | 2 | ||
| ResourceTypeConverter | class |
Drupal\ |
core/ |
Parameter converter for upcasting JSON:API resource type names to objects. | 1 | 2 | |
| EntityCondition | class |
Drupal\ |
core/ |
A condition object for the EntityQuery. | 2 | ||
| EntityConditionGroup | class |
Drupal\ |
core/ |
A condition group for the EntityQuery. | 2 | ||
| OffsetPage | class |
Drupal\ |
core/ |
Value object for containing the requested offset and page parameters. | 2 | ||
| Sort | class |
Drupal\ |
core/ |
Gathers information about the sort parameter. | 1 | ||
| ResourceTypeAttribute | class |
Drupal\ |
core/ |
Specialization of a ResourceTypeField to represent a resource type attribute. | |||
| ResourceTypeBuildEvent | class |
Drupal\ |
core/ |
An event used to configure the construction of a JSON:API resource type. | 1 | ||
| ResourceTypeBuildEvents | final class |
Drupal\ |
core/ |
Contains all events emitted during the resource type build process. | 1 | ||
| ResourceTypeRelationship | class |
Drupal\ |
core/ |
Specialization of a ResourceTypeField to represent a resource relationship. | 3 | ||
| InvalidVersionIdentifierException | class |
Drupal\ |
core/ |
Used when a version ID is invalid. | |||
| ResourceVersionRouteEnhancer | final class |
Drupal\ |
core/ |
Loads an appropriate revision for the requested resource version. | 2 | ||
| VersionById | class |
Drupal\ |
core/ |
Defines a revision ID implementation for entity revision ID values. | 1 | 2 | |
| VersionByRel | class |
Drupal\ |
core/ |
Revision ID implementation for the default or latest revisions. | 2 | 2 | |
| VersionNegotiator | class |
Drupal\ |
core/ |
Provides a version negotiator manager. | 1 | 2 | |
| VersionNotFoundException | class |
Drupal\ |
core/ |
Used when a version ID is valid, but the requested version does not exist. | |||
| EarlyFormatSetter | final class |
Drupal\ |
core/ |
Sets the 'api_json' format for requests to JSON:API resources. | 2 | ||
| ReadOnlyModeMethodFilter | class |
Drupal\ |
core/ |
Filters routes based on the HTTP method and JSON:API's read-only mode. | 2 | ||
| RouteEnhancer | class |
Drupal\ |
core/ |
Ensures the loaded entity matches the requested resource type. | 2 | ||
| Routes | class |
Drupal\ |
core/ |
Defines dynamic routes. | 9 | ||
| LanguageNegotiation | class |
Drupal\ |
core/ |
Defines a language negotiation annotation object. | |||
| LanguageConfigFactoryOverride | class |
Drupal\ |
core/ |
Provides language overrides for the configuration factory. | 2 | ||
| LanguageConfigOverride | class |
Drupal\ |
core/ |
Defines language configuration overrides. | 5 | ||
| LanguageConfigOverrideCrudEvent | class |
Drupal\ |
core/ |
Provides a language override event for event listeners. | 1 | ||
| LanguageConfigOverrideEvents | final class |
Drupal\ |
core/ |
Defines events for language configuration overrides. | 2 |
