Classes, traits, and interfaces - 11.x - drupal

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

File

core/core.api.php, line 1518

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
AnnotationTargetAll class Drupal\Tests\Component\Annotation\Doctrine\Fixtures core/tests/Drupal/Tests/Component/Annotation/Doctrine/Fixtures/AnnotationTargetAll.php Plugin annotation @Target("ALL"); 1 1
AnnotationTargetAnnotation final class Drupal\Tests\Component\Annotation\Doctrine\Fixtures core/tests/Drupal/Tests/Component/Annotation/Doctrine/Fixtures/AnnotationTargetAnnotation.php Plugin annotation @Target({ "ANNOTATION" }) 1
AnnotationTargetClass final class Drupal\Tests\Component\Annotation\Doctrine\Fixtures core/tests/Drupal/Tests/Component/Annotation/Doctrine/Fixtures/AnnotationTargetClass.php Plugin annotation @Target("CLASS"); 3
AnnotationTargetPropertyMethod final class Drupal\Tests\Component\Annotation\Doctrine\Fixtures core/tests/Drupal/Tests/Component/Annotation/Doctrine/Fixtures/AnnotationTargetPropertyMethod.php Plugin annotation @Target({ "METHOD", "PROPERTY" }) 2
AnnotationWithAttributes final class Drupal\Tests\Component\Annotation\Doctrine\Fixtures core/tests/Drupal/Tests/Component/Annotation/Doctrine/Fixtures/AnnotationWithAttributes.php Plugin annotation @Target("ALL") @Attributes({ @Attribute("mixed", type = "mixed"), @Attribute("boolean", type = "boolean"), @Attribute("bool", type = "bool"), @Attribute("float", …
AnnotationWithConstants final class Drupal\Tests\Component\Annotation\Doctrine\Fixtures core/tests/Drupal/Tests/Component/Annotation/Doctrine/Fixtures/AnnotationWithConstants.php Plugin annotation @Target("ALL"); 1
AnnotationWithInvalidTargetDeclaration class Drupal\Tests\Component\Annotation\Doctrine core/tests/Drupal/Tests/Component/Annotation/Doctrine/DocParserTest.php Plugin annotation @Target("Foo");
AnnotationWithRequiredAttributes final class Drupal\Tests\Component\Annotation\Doctrine\Fixtures core/tests/Drupal/Tests/Component/Annotation/Doctrine/Fixtures/AnnotationWithRequiredAttributes.php Plugin annotation @Target("ALL") @Attributes({ @Attribute("value", required = true , type = "string"), @Attribute("annot", required = true , type =…
AnnotationWithRequiredAttributesWithoutContructor final class Drupal\Tests\Component\Annotation\Doctrine\Fixtures core/tests/Drupal/Tests/Component/Annotation/Doctrine/Fixtures/AnnotationWithRequiredAttributesWithoutContructor.php Plugin annotation @Target("ALL");
AnnotationWithTargetEmpty class Drupal\Tests\Component\Annotation\Doctrine core/tests/Drupal/Tests/Component/Annotation/Doctrine/DocParserTest.php @Target
AnnotationWithTargetSyntaxError final class Drupal\Tests\Component\Annotation\Doctrine\Fixtures core/tests/Drupal/Tests/Component/Annotation/Doctrine/Fixtures/AnnotationWithTargetSyntaxError.php Plugin annotation @Target(@)
AnnotationWithVarType final class Drupal\Tests\Component\Annotation\Doctrine\Fixtures core/tests/Drupal/Tests/Component/Annotation/Doctrine/Fixtures/AnnotationWithVarType.php Plugin annotation @Target("ALL");
AnnotWithDefaultValue class Drupal\Tests\Component\Annotation\Doctrine\Fixtures\Annotation core/tests/Drupal/Tests/Component/Annotation/Doctrine/Fixtures/Annotation/AnnotWithDefaultValue.php
AnnounceBlock class Drupal\announcements_feed\Plugin\Block core/modules/announcements_feed/src/Plugin/Block/AnnounceBlock.php Provides an 'Announcements Feed' block.
AnnounceBlockTest class Drupal\Tests\announcements_feed\FunctionalJavascript core/modules/announcements_feed/tests/src/FunctionalJavascript/AnnounceBlockTest.php Test the announcement block test visibility.
AnnounceCommand class Drupal\Core\Ajax core/lib/Drupal/Core/Ajax/AnnounceCommand.php AJAX command for a JavaScript Drupal.announce() call. 3
AnnounceController class Drupal\announcements_feed\Controller core/modules/announcements_feed/src/Controller/AnnounceController.php Controller for community announcements.
AnnounceFetcher final class Drupal\announcements_feed core/modules/announcements_feed/src/AnnounceFetcher.php Service to fetch announcements from the external feed. 1 2
AnnounceFetcherTest class Drupal\Tests\announcements_feed\Kernel core/modules/announcements_feed/tests/src/Kernel/AnnounceFetcherTest.php @coversDefaultClass \Drupal\announcements_feed\AnnounceFetcher
AnnounceFetcherUnitTest class Drupal\Tests\announcements_feed\Unit core/modules/announcements_feed/tests/src/Unit/AnnounceFetcherUnitTest.php Simple test to ensure that asserts pass.
AnnounceFetcherUserTest class Drupal\Tests\announcements_feed\Kernel core/modules/announcements_feed/tests/src/Kernel/AnnounceFetcherUserTest.php @coversDefaultClass \Drupal\announcements_feed\AnnounceFetcher
Announcement final class Drupal\announcements_feed core/modules/announcements_feed/src/Announcement.php Object containing a single announcement from the feed.
AnnouncementsCacheTest final class Drupal\Tests\announcements_feed\Functional core/modules/announcements_feed/tests/src/Functional/AnnouncementsCacheTest.php Defines a class for testing pages are still cacheable with dynamic page cache.
AnnouncementsFeedHooks class Drupal\announcements_feed\Hook core/modules/announcements_feed/src/Hook/AnnouncementsFeedHooks.php Hook implementations for announcements_feed.
AnnounceRenderer final class Drupal\announcements_feed core/modules/announcements_feed/src/AnnounceRenderer.php Service to render announcements from the external feed. 2 2
AnnounceRendererTest class Drupal\Tests\announcements_feed\Kernel core/modules/announcements_feed/tests/src/Kernel/AnnounceRendererTest.php @coversDefaultClass \Drupal\announcements_feed\AnnounceRenderer
AnnounceTestBase class Drupal\Tests\announcements_feed\Kernel core/modules/announcements_feed/tests/src/Kernel/AnnounceTestBase.php Base class for Announce Kernel tests. 3
AnnounceTestController class Drupal\announce_feed_test\Controller core/modules/announcements_feed/tests/modules/announce_feed_test/src/Controller/AnnounceTestController.php Defines a controller to return JSON for security advisory tests.
AnnounceTestHttpClientMiddleware class Drupal\announce_feed_test core/modules/announcements_feed/tests/modules/announce_feed_test/src/AnnounceTestHttpClientMiddleware.php Overrides the requested endpoint when running tests. 3 2
AnonResourceTestTrait trait Drupal\Tests\rest\Functional core/modules/rest/tests/src/Functional/AnonResourceTestTrait.php Defines a trait for testing with no authentication provider. 108
AnonymousPrivateTempStoreTest class Drupal\KernelTests\Core\TempStore core/tests/Drupal/KernelTests/Core/TempStore/AnonymousPrivateTempStoreTest.php Tests the PrivateTempStore for anonymous users.
AnonymousUserResponseSubscriber class Drupal\Core\EventSubscriber core/lib/Drupal/Core/EventSubscriber/AnonymousUserResponseSubscriber.php Response subscriber to handle finished responses for the anonymous user.
AnonymousUserSession class Drupal\Core\Session core/lib/Drupal/Core/Session/AnonymousUserSession.php An account implementation representing an anonymous user. 19
AnonymousUserSessionTest class Drupal\Tests\Core\Session core/tests/Drupal/Tests/Core/Session/AnonymousUserSessionTest.php @coversDefaultClass \Drupal\Core\Session\AnonymousUserSession @group Session
Any class Drupal\Core\TypedData\Plugin\DataType core/lib/Drupal/Core/TypedData/Plugin/DataType/Any.php The "any" data type.
ApcuBackend class Drupal\Core\Cache core/lib/Drupal/Core/Cache/ApcuBackend.php Stores cache items in the Alternative PHP Cache User Cache (APCu). 1
ApcuBackendFactory class Drupal\Core\Cache core/lib/Drupal/Core/Cache/ApcuBackendFactory.php
ApcuBackendTest class Drupal\KernelTests\Core\Cache core/tests/Drupal/KernelTests/Core/Cache/ApcuBackendTest.php Tests the APCu cache backend.
ApcuFileCacheBackend class Drupal\Component\FileCache core/lib/Drupal/Component/FileCache/ApcuFileCacheBackend.php APCu backend for the file cache. 1
ApiController class Drupal\package_manager_test_api core/modules/package_manager/tests/modules/package_manager_test_api/src/ApiController.php Provides API endpoints to interact with a stage directory in functional test.
ApiRequestTrait trait Drupal\Tests core/tests/Drupal/Tests/ApiRequestTrait.php Boilerplate for API Functional tests' HTTP requests. 3
AppendCommand class Drupal\Core\Ajax core/lib/Drupal/Core/Ajax/AppendCommand.php An AJAX command for calling the jQuery append() method. 1 4
AppendOp class Drupal\Composer\Plugin\Scaffold\Operations composer/Plugin/Scaffold/Operations/AppendOp.php Scaffold operation to add to the beginning and/or end of a scaffold file. 3
AppendOpTest class Drupal\Tests\Composer\Plugin\Scaffold\Integration core/tests/Drupal/Tests/Composer/Plugin/Scaffold/Integration/AppendOpTest.php @coversDefaultClass \Drupal\Composer\Plugin\Scaffold\Operations\AppendOp
Apple class Drupal\Tests\Core\Entity core/tests/Drupal/Tests/Core/Entity/EntityTypeRepositoryTest.php 1
Apple class Drupal\plugin_test\Plugin\plugin_test\fruit core/modules/system/tests/modules/plugin_test/src/Plugin/plugin_test/fruit/Apple.php Plugin annotation @Plugin( id = "apple", label = "Apple", color = "green" ) 1
ApplyFailedException final class Drupal\package_manager\Exception core/modules/package_manager/src/Exception/ApplyFailedException.php Exception thrown if a stage encounters an error applying an update. 2
ArbitraryRebuildTest class Drupal\Tests\system\Functional\Form core/modules/system/tests/src/Functional/Form/ArbitraryRebuildTest.php Tests altering forms to be rebuilt so there are multiple steps.
Archiver class Drupal\Core\Archiver\Attribute core/lib/Drupal/Core/Archiver/Attribute/Archiver.php Defines an archiver attribute object. 4
Archiver class Drupal\Core\Archiver\Annotation core/lib/Drupal/Core/Archiver/Annotation/Archiver.php Defines an archiver annotation object.

Other projects


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