Classes, traits, and interfaces - main - 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 1529

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
AnnounceRenderer final class Drupal\announcements_feed core/modules/announcements_feed/src/AnnounceRenderer.php Service to render announcements from the external feed. 3 2
AnnounceRendererTest class Drupal\Tests\announcements_feed\Kernel core/modules/announcements_feed/tests/src/Kernel/AnnounceRendererTest.php Tests Drupal\announcements_feed\AnnounceRenderer.
AnnounceTestBase abstract 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. 5 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. 23
AnonymousUserSessionTest class Drupal\Tests\Core\Session core/tests/Drupal/Tests/Core/Session/AnonymousUserSessionTest.php Tests Drupal\Core\Session\AnonymousUserSession.
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 Defines the APCU backend factory. 2
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. 4
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 Tests Drupal\Composer\Plugin\Scaffold\Operations\AppendOp.
Apple class Drupal\Tests\Core\Entity core/tests/Drupal/Tests/Core/Entity/EntityTypeRepositoryTest.php A Fruit class for testing. 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. 3
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

in drupal:11.3.0 and is removed from drupal:12.0.0. There is no replacement.

class Drupal\Core\Archiver\Attribute core/lib/Drupal/Core/Archiver/Attribute/Archiver.php Defines an archiver attribute object. 3
Archiver

in drupal:11.3.0 and is removed from drupal:12.0.0. There is no replacement.

class Drupal\Core\Archiver\Annotation core/lib/Drupal/Core/Archiver/Annotation/Archiver.php Defines an archiver annotation object.
ArchiverException

in drupal:11.3.0 and is removed from drupal:12.0.0. There is no replacement.

class Drupal\Core\Archiver core/lib/Drupal/Core/Archiver/ArchiverException.php Defines an exception class for Drupal\Core\Archiver\ArchiverInterface.
ArchiverInterface

in drupal:11.3.0 and is removed from drupal:12.0.0. There is no replacement.

interface Drupal\Core\Archiver core/lib/Drupal/Core/Archiver/ArchiverInterface.php Defines the common interface for all Archiver classes. 2
ArchiverManager

in drupal:11.3.0 and is removed from drupal:12.0.0. There is no replacement.

class Drupal\Core\Archiver core/lib/Drupal/Core/Archiver/ArchiverManager.php Provides an Archiver plugin manager.
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. 5
ArchiveTest class Drupal\Tests\views\Functional core/modules/views/tests/src/Functional/ArchiveTest.php Tests archive view.
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 4
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\Kernel\Handler core/modules/views/tests/src/Kernel/Handler/AreaTest.php Tests the plugin base of the 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.
AreaTextTest class Drupal\Tests\views\Kernel\Handler core/modules/views/tests/src/Kernel/Handler/AreaTextTest.php Tests the core views_handler_area_text handler.
AreaTextTokenTest class Drupal\Tests\views\Kernel\Handler core/modules/views/tests/src/Kernel/Handler/AreaTextTokenTest.php Tests the token in text area handler.
AreaTitleTest class Drupal\Tests\views\Kernel\Handler core/modules/views/tests/src/Kernel/Handler/AreaTitleTest.php Tests the title area handler.
AreaTitleWebTest class Drupal\Tests\views\Functional\Handler core/modules/views/tests/src/Functional/Handler/AreaTitleWebTest.php Tests the title area handler with a web test.
AreaViewTest class Drupal\Tests\views\Kernel\Handler core/modules/views/tests/src/Kernel/Handler/AreaViewTest.php Tests the view area handler.
ArgumentDateTest class Drupal\Tests\views\Kernel\Handler core/modules/views/tests/src/Kernel/Handler/ArgumentDateTest.php Tests the core date argument handlers.
ArgumentDateTimeTest class Drupal\Tests\datetime\Kernel\Views core/modules/datetime/tests/src/Kernel/Views/ArgumentDateTimeTest.php Tests the Drupal\datetime\Plugin\views\filter\Date handler.

Other projects


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