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 |
|---|---|---|---|---|---|---|---|---|
| AssetControllerTest | class | Drupal\KernelTests\Core\Asset | core/ |
Tests that the asset controllers reject invalid aggregate requests. | ||||
| AssetDumper | class | Drupal\Core\Asset | core/ |
Dumps a CSS or JavaScript asset. | 3 | |||
| AssetDumperInterface | interface | Drupal\Core\Asset | core/ |
Interface defining a service that dumps an (optimized) asset. | 1 | |||
| AssetDumperUriInterface | interface | Drupal\Core\Asset | core/ |
Interface defining a service that dumps an asset to a specified location. | 1 | 1 | ||
| AssetGroupSetHashTrait | trait | Drupal\Core\Asset | core/ |
Provides a method to generate a normalized hash of a given asset group set. | 3 | |||
| AssetOptimizationTest | class | Drupal\FunctionalTests\Asset | core/ |
Tests asset aggregation. | 1 | |||
| AssetOptimizationUmamiTest | class | Drupal\FunctionalTests\Asset | core/ |
Tests asset aggregation with the Umami install profile. | ||||
| AssetOptimizerInterface | interface | Drupal\Core\Asset | core/ |
Interface defining a service that optimizes an asset. | 2 | 1 | ||
| AssetQueryString | class | Drupal\Core\Asset | core/ |
Stores a cache busting query string service for asset URLs. | 1 | 2 | ||
| AssetQueryStringInterface | interface | Drupal\Core\Asset | core/ |
Provides a cache busting query string service for asset URLs. | 1 | 6 | ||
| AssetQueryStringTest | class | Drupal\KernelTests\Core\Asset | core/ |
Tests the asset query string functionality. | ||||
| AssetResolver | class | Drupal\Core\Asset | core/ |
The default asset resolver. | 1 | 2 | ||
| AssetResolverInterface | interface | Drupal\Core\Asset | core/ |
Resolves asset libraries into concrete CSS and JavaScript assets. | 1 | 6 | ||
| AssetResolverTest | class | Drupal\Tests\Core\Asset | core/ |
Tests Drupal\Core\Asset\AssetResolver. | ||||
| AssetRoutes | class | Drupal\system\Routing | core/ |
Defines a routes' callback to register a URL for serving assets. | ||||
| AssetsStream | class | Drupal\Core\StreamWrapper | core/ |
Defines a Drupal stream wrapper class for optimized assets (assets://). | 1 | 2 | ||
| AssetXssTest | class | Drupal\FunctionalTests\Asset | core/ |
Tests sanitization of error messages emitted by AssetControllerBase. | ||||
| AtLeastOneOfConstraint | class | Drupal\Core\Validation\Plugin\Validation\Constraint | core/ |
Checks that at least one of the given constraint is satisfied. | 1 | |||
| AtLeastOneOfConstraintValidatorTest | class | Drupal\KernelTests\Core\Validation | core/ |
Tests AtLeastOneOf validation constraint with both valid and invalid values. | ||||
| AttachedAssets | class | Drupal\Core\Asset | core/ |
The default attached assets collection. | 14 | |||
| AttachedAssetsInterface | interface | Drupal\Core\Asset | core/ |
The attached assets collection for the current response. | 1 | 11 | ||
| AttachedAssetsTest | class | Drupal\KernelTests\Core\Asset | core/ |
Tests #attached assets: attached asset libraries and JavaScript settings. | ||||
| AttachedRenderingBlock | class | Drupal\render_attached_test\Plugin\Block | core/ |
A block we can use to test caching of #attached headers. | ||||
| Attachment | class | Drupal\views\Plugin\views\display | core/ |
The plugin that handles an attachment display. | ||||
| AttachmentsInterface | interface | Drupal\Core\Render | core/ |
The attached metadata collection for a renderable element. | 6 | 11 | ||
| AttachmentsResponseProcessorInterface | interface | Drupal\Core\Render | core/ |
Defines an interface for processing attachments of responses that have them. | 2 | 5 | ||
| AttachmentsTestDomainObject | class | Drupal\early_rendering_controller_test | core/ |
Test domain class with implemented AttachmentsInterface. | ||||
| AttachmentsTestResponse | class | Drupal\early_rendering_controller_test | core/ |
Test response with implemented AttachmentsInterface. | ||||
| AttachmentsTrait | trait | Drupal\Core\Render | core/ |
Provides an implementation of AttachmentsInterface. | 4 | |||
| AttachmentTestFormatter | class | Drupal\views_test_formatter\Plugin\Field\FieldFormatter | core/ |
Plugin implementation of the 'number_unformatted_with_attachment' formatter. | ||||
| Attribute | class | Drupal\Core\Template | core/ |
Collects, sanitizes, and renders HTML attributes. | 1 | 51 | 12 | |
| Attribute | final class | Drupal\Component\Annotation\Doctrine\Annotation | core/ |
Annotation that can be used to signal to the parser to check the attribute type during the parsing process. | 1 | |||
| AttributeAllowTestClass | class | Drupal\Tests\Core\Template | core/ |
Test class for TwigAllowed attribute. | ||||
| AttributeArray | class | Drupal\Core\Template | core/ |
A class that defines a type of Attribute that can be added to as an array. | 1 | |||
| AttributeBase | abstract class | Drupal\Component\Plugin\Attribute | core/ |
Provides a base class for classed attributes. | 4 | 2 | ||
| AttributeBaseStub | class | Drupal\Tests\Component\Plugin\Attribute | core/ |
|||||
| AttributeBaseTest | class | Drupal\Tests\Component\Plugin\Attribute | core/ |
Tests Drupal\Component\Plugin\Attribute\AttributeBase. | ||||
| AttributeBoolean | class | Drupal\Core\Template | core/ |
A class that defines a type of boolean HTML attribute. | 1 | |||
| AttributeBridgeDecorator | class | Drupal\Component\Plugin\Discovery | core/ |
Ensures that all definitions are run through the attribute process. | 3 | |||
| AttributeBridgeDecoratorTest | class | Drupal\Tests\Component\Plugin\Discovery | core/ |
Tests Drupal\Component\Annotation\Plugin\Discovery\AnnotationBridgeDecorator. | ||||
| AttributeClass | final class | Drupal\Tests\Component\Annotation\Doctrine\Fixtures\Attribute | core/ |
#[\Attribute] | ||||
| AttributeClassDiscovery | class | Drupal\Core\Plugin\Discovery | core/ |
Defines a discovery mechanism to find plugins using attributes. | 1 | 2 | ||
| AttributeClassDiscovery | class | Drupal\Component\Plugin\Discovery | core/ |
Defines a discovery mechanism to find plugins with attributes. | 1 | 4 | ||
| AttributeClassDiscoveryCachedTest | class | Drupal\Tests\Component\Plugin\Attribute | core/ |
Tests Attribute Class Discovery Cached. | ||||
| AttributeClassDiscoveryTest | class | Drupal\Tests\Component\Plugin\Attribute | core/ |
Tests Drupal\Component\Plugin\Discovery\AttributeClassDiscovery. | ||||
| AttributeDiscoveryTest1 | class | com\example\PluginNamespace | core/ |
Provides a custom test plugin. | ||||
| AttributeDiscoveryTest2 | class | com\example\PluginNamespace | core/ |
Provides a custom test plugin that extends from a missing dependency. | ||||
| AttributeDiscoveryTestMissingInterface | class | com\example\PluginNamespace | core/ |
Provides a custom test plugin that implements a missing interface. | ||||
| AttributeDiscoveryTestMissingTrait | class | com\example\PluginNamespace | core/ |
Provides a custom test plugin that uses a missing trait. | ||||
| AttributeDiscoveryWithAnnotations | class | Drupal\Core\Plugin\Discovery | core/ |
Enables both attribute and annotation discovery for plugin definitions. | 1 | 5 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.