Classes, traits, and interfaces - 8.9.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 1511
| Name | Deprecated | Object type | Namespace | File name | Summary | Direct uses | Use statements | Strings |
|---|---|---|---|---|---|---|---|---|
| AssertMenuActiveTrailTrait | in drupal:8.?.? and is removed from drupal:9.0.0. Use \Drupal\Tests\system\Functional\Menu\AssertMenuActiveTrailTrait instead. |
trait | Drupal\system\Tests\Menu | core/ |
Provides test assertions for verifying the active menu trail. | |||
| AssertMenuActiveTrailTrait | trait | Drupal\Tests\system\Functional\Menu | core/ |
Provides test assertions for verifying the active menu trail. | ||||
| AssertPageCacheContextsAndTagsTrait | trait | Drupal\Tests\system\Functional\Cache | core/ |
Provides test assertions for testing page-level cache contexts & tags. | 41 | |||
| AssertPageCacheContextsAndTagsTrait | in drupal:8.?.? and is removed from drupal:9.0.0. Use \Drupal\Tests\system\Functional\Cache\AssertPageCacheContextsAndTagsTrait instead. |
trait | Drupal\system\Tests\Cache | core/ |
Provides test assertions for testing page-level cache contexts & tags. | 2 | ||
| AssertUtilsTrait | trait | Drupal\Tests\Composer\Plugin\Scaffold | core/ |
Convenience class for creating fixtures. | 4 | |||
| AssertViewsCacheTagsTrait | trait | Drupal\views\Tests | core/ |
3 | ||||
| AssetCollectionGrouperInterface | interface | Drupal\Core\Asset | core/ |
Interface defining a service that logically groups a collection of assets. | 2 | |||
| AssetCollectionOptimizerInterface | interface | Drupal\Core\Asset | core/ |
Interface defining a service that optimizes a collection of assets. | 2 | 2 | ||
| AssetCollectionRendererInterface | interface | Drupal\Core\Asset | core/ |
Interface defining a service that generates a render array to render assets. | 2 | 4 | ||
| 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 | |||
| AssetOptimizerInterface | interface | Drupal\Core\Asset | core/ |
Interface defining a service that optimizes an asset. | 2 | |||
| 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 | 4 | ||
| AssetResolverTest | class | Drupal\Tests\Core\Asset | core/ |
@coversDefaultClass \Drupal\Core\Asset\AssetResolver[[api-linebreak]] @group Asset | ||||
| AssignOwnerNode | class | Drupal\node\Plugin\Action | core/ |
Assigns ownership of a node to a user. | ||||
| AttachedAssets | class | Drupal\Core\Asset | core/ |
The default attached assets collection. | 12 | |||
| AttachedAssetsInterface | interface | Drupal\Core\Asset | core/ |
The attached assets collection for the current response. | 1 | 9 | ||
| 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/ |
Defines an interface for responses that can expose #attached metadata. | 5 | 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/ |
|||||
| AttachmentsTestResponse | class | Drupal\early_rendering_controller_test | core/ |
|||||
| AttachmentsTrait | trait | Drupal\Core\Render | core/ |
Provides an implementation of AttachmentsInterface. | 3 | |||
| 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 | 37 | ||
| AttributeArray | class | Drupal\Core\Template | core/ |
A class that defines a type of Attribute that can be added to as an array. | 1 | |||
| AttributeBoolean | class | Drupal\Core\Template | core/ |
A class that defines a type of boolean HTML attribute. | ||||
| AttributeHelper | class | Drupal\Core\Template | core/ |
Helper class to deal with mixed array and Attribute operations. | 2 | |||
| AttributeHelperTest | class | Drupal\Tests\Core\Template | core/ |
@coversDefaultClass \Drupal\Core\Template\AttributeHelper[[api-linebreak]] @group Template | ||||
| AttributesTest | class | Drupal\Tests\Core\Common | core/ |
Tests the Drupal\Core\Template\Attribute functionality. | ||||
| AttributeString | class | Drupal\Core\Template | core/ |
A class that represents most standard HTML attributes. | 1 | |||
| AttributeTest | class | Drupal\Tests\Core\Template | core/ |
@coversDefaultClass \Drupal\Core\Template\Attribute[[api-linebreak]] @group Template | ||||
| AttributeValueBase | abstract class | Drupal\Core\Template | core/ |
Defines the base class for an attribute type. | 3 | |||
| AudioFile | class | Drupal\media\Plugin\media\Source | core/ |
Media source wrapping around an audio file. | ||||
| AuditException | class | Drupal\migrate\Audit | core/ |
Defines an exception to throw if an error occurs during a migration audit. | ||||
| AuditorInterface | interface | Drupal\migrate\Audit | core/ |
Defines an interface for migration auditors. | 1 | |||
| AuditResult | class | Drupal\migrate\Audit | core/ |
Encapsulates the result of a migration audit. | 2 | |||
| Auth | class | Drupal\early_translation_test | core/ |
Test authentication provider. | 2 | |||
| AuthenticationCollector | class | Drupal\Core\Authentication | core/ |
A collector class for authentication providers. | 2 | 2 | ||
| AuthenticationCollectorInterface | interface | Drupal\Core\Authentication | core/ |
Interface for collectors of registered authentication providers. | 1 | |||
| AuthenticationCollectorTest | class | Drupal\Tests\Core\Authentication | core/ |
@coversDefaultClass \Drupal\Core\Authentication\AuthenticationCollector[[api-linebreak]] @group Authentication | ||||
| AuthenticationManager | class | Drupal\Core\Authentication | core/ |
Manager for authentication. | 1 | 2 | ||
| AuthenticationManagerTest | class | Drupal\Tests\Core\Authentication | core/ |
@coversDefaultClass \Drupal\Core\Authentication\AuthenticationManager[[api-linebreak]] @group Authentication | ||||
| AuthenticationProviderChallengeInterface | interface | Drupal\Core\Authentication | core/ |
Generate a challenge when access is denied for unauthenticated users. | 2 | 2 | ||
| AuthenticationProviderFilterInterface | interface | Drupal\Core\Authentication | core/ |
Restrict authentication methods to a subset of the site. | 2 | 2 | ||
| AuthenticationProviderInterface | interface | Drupal\Core\Authentication | core/ |
Interface for authentication providers. | 8 | 8 | ||
| AuthenticationProviderPass | class | Drupal\Core\DependencyInjection\Compiler | core/ |
Registers the authentication_providers container parameter. | 2 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.