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

Namesort descending Type Namespace Location Description 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
AnnounceCommand class Drupal\Core\Ajax core/lib/Drupal/Core/Ajax/AnnounceCommand.php AJAX command for a JavaScript Drupal.announce() call. 2
AnnounceFetcherTest class Drupal\Tests\announcements_feed\Kernel core/modules/announcements_feed/tests/src/Kernel/AnnounceFetcherTest.php @coversDefaultClass \Drupal\announcements_feed\AnnounceFetcher
AnnounceFetcherUserTest class Drupal\Tests\announcements_feed\Kernel core/modules/announcements_feed/tests/src/Kernel/AnnounceFetcherUserTest.php @coversDefaultClass \Drupal\announcements_feed\AnnounceFetcher
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.
AnnounceRendererTest class Drupal\Tests\announcements_feed\Kernel core/modules/announcements_feed/tests/src/Kernel/AnnounceRendererTest.php @coversDefaultClass \Drupal\announcements_feed\AnnounceRenderer
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. 1 2
AnonResourceTestTrait trait Drupal\Tests\rest\Functional core/modules/rest/tests/src/Functional/AnonResourceTestTrait.php Defines a trait for testing with no authentication provider. 104
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. 2
AnonymousUserSession class Drupal\Core\Session core/lib/Drupal/Core/Session/AnonymousUserSession.php An account implementation representing an anonymous user. 15
AnonymousUserSessionTest class Drupal\Tests\Core\Session core/tests/Drupal/Tests/Core/Session/AnonymousUserSessionTest.php @coversDefaultClass \Drupal\Core\Session\AnonymousUserSession @group Session
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.
ApiRequestTrait trait Drupal\Tests core/tests/Drupal/Tests/ApiRequestTrait.php Boilerplate for API Functional tests' HTTP requests. 2
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\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
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\Annotation core/lib/Drupal/Core/Archiver/Annotation/Archiver.php Defines an archiver annotation object.
ArchiverException class Drupal\Core\Archiver core/lib/Drupal/Core/Archiver/ArchiverException.php Defines an exception class for Drupal\Core\Archiver\ArchiverInterface.
ArchiverInterface interface Drupal\Core\Archiver core/lib/Drupal/Core/Archiver/ArchiverInterface.php Defines the common interface for all Archiver classes. 2
ArchiverManager class Drupal\Core\Archiver core/lib/Drupal/Core/Archiver/ArchiverManager.php Provides an Archiver plugin manager. 1 2
ArchiverTestBase abstract class Drupal\KernelTests\Core\Archiver core/tests/Drupal/KernelTests/Core/Archiver/ArchiverTestBase.php Provides archive specific assertions and helper properties for archive tests. 2
ArchiveTar class Drupal\Core\Archiver core/lib/Drupal/Core/Archiver/ArchiveTar.php Extends Pear's Archive_Tar to use exceptions. 4
AreaDisplayLinkTest class Drupal\Tests\views\Kernel\Handler core/modules/views/tests/src/Kernel/Handler/AreaDisplayLinkTest.php Tests the core views_handler_area_display_link handler.
AreaEmptyTest class Drupal\Tests\views\Kernel\Handler core/modules/views/tests/src/Kernel/Handler/AreaEmptyTest.php Tests the generic entity area handler.
AreaEntityTest class Drupal\Tests\views\Kernel\Handler core/modules/views/tests/src/Kernel/Handler/AreaEntityTest.php Tests the generic entity area handler.
AreaEntityUITest class Drupal\Tests\views_ui\Functional core/modules/views_ui/tests/src/Functional/AreaEntityUITest.php Tests the entity area UI test.
AreaHTTPStatusCodeTest class Drupal\Tests\views\Functional\Handler core/modules/views/tests/src/Functional/Handler/AreaHTTPStatusCodeTest.php Tests the http_status_code area handler.
AreaMessagesTest class Drupal\Tests\views\Kernel\Handler core/modules/views/tests/src/Kernel/Handler/AreaMessagesTest.php Tests the messages area handler.
AreaOrderTest class Drupal\Tests\views\Kernel\Handler core/modules/views/tests/src/Kernel/Handler/AreaOrderTest.php Tests the view area handler.
AreaPluginBase abstract class Drupal\views\Plugin\views\area core/modules/views/src/Plugin/views/area/AreaPluginBase.php Base class for area handler plugins. 11 3
AreaResultTest class Drupal\Tests\views\Kernel\Handler core/modules/views/tests/src/Kernel/Handler/AreaResultTest.php Tests the result area handler.
AreaTest class Drupal\Tests\views\Functional\Handler core/modules/views/tests/src/Functional/Handler/AreaTest.php Tests the plugin base of the area handler.
AreaTest class Drupal\Tests\views\Kernel\Handler core/modules/views/tests/src/Kernel/Handler/AreaTest.php Tests the plugin base of the area handler.
AreaTextTest class Drupal\Tests\views\Kernel\Handler core/modules/views/tests/src/Kernel/Handler/AreaTextTest.php Tests the core views_handler_area_text handler.

Pages

Other projects