Classes, traits, and interfaces - 11.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 1519

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
AnonymousUserSessionTest class Drupal\Tests\Core\Session core/tests/Drupal/Tests/Core/Session/AnonymousUserSessionTest.php @coversDefaultClass \Drupal\Core\Session\AnonymousUserSession[[api-linebreak]] @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 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. 3
AppendCommand class Drupal\Core\Ajax core/lib/Drupal/Core/Ajax/AppendCommand.php An AJAX command for calling the jQuery append() method. 1 5
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[[api-linebreak]]
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" ) 2
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. 5
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.
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. 3 1
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 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.
ArgumentDefaultPluginBase abstract class Drupal\views\Plugin\views\argument_default core/modules/views/src/Plugin/views/argument_default/ArgumentDefaultPluginBase.php The fixed argument default handler; also used as the base. 8 5
ArgumentDefaultTest class Drupal\Tests\user\Kernel\Views core/modules/user/tests/src/Kernel/Views/ArgumentDefaultTest.php Tests views user argument default plugin.
ArgumentDefaultTest class Drupal\Tests\views\Functional\Plugin core/modules/views/tests/src/Functional/Plugin/ArgumentDefaultTest.php Tests pluggable argument_default for views.
ArgumentDefaultTest class Drupal\views_test_data\Plugin\views\argument_default core/modules/views/tests/modules/views_test_data/src/Plugin/views/argument_default/ArgumentDefaultTest.php Defines an argument default test plugin. 1
ArgumentLanguageTest class Drupal\Tests\language\Kernel\Views core/modules/language/tests/src/Kernel/Views/ArgumentLanguageTest.php Tests the argument language handler.
ArgumentNodeRevisionIdTest class Drupal\Tests\node\Kernel\Views core/modules/node/tests/src/Kernel/Views/ArgumentNodeRevisionIdTest.php Tests the node_vid handler.
ArgumentNullTest class Drupal\Tests\views\Kernel\Handler core/modules/views/tests/src/Kernel/Handler/ArgumentNullTest.php Tests the core Drupal\views\Plugin\views\argument\NullArgument handler.
ArgumentPluginBase abstract class Drupal\views\Plugin\views\argument core/modules/views/src/Plugin/views/argument/ArgumentPluginBase.php Base class for argument (contextual filter) handler plugins. 13 9
ArgumentsAllNull class Drupal\Tests\Component\Plugin\Factory core/tests/Drupal/Tests/Component/Plugin/Factory/ReflectionFactoryTest.php A stub class used by testGetInstanceArguments().
ArgumentsConfigArrayKey class Drupal\Tests\Component\Plugin\Factory core/tests/Drupal/Tests/Component/Plugin/Factory/ReflectionFactoryTest.php A stub class used by testGetInstanceArguments().

Other projects

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