Classes, traits, and interfaces - 9.5.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 1523

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
BackendCompilerPassTest class Drupal\Tests\Core\DependencyInjection\Compiler core/tests/Drupal/Tests/Core/DependencyInjection/Compiler/BackendCompilerPassTest.php @coversDefaultClass \Drupal\Core\DependencyInjection\Compiler\BackendCompilerPass @group DependencyInjection
BackwardCompatibilityTest class Drupal\FunctionalJavascriptTests\Ajax core/tests/Drupal/FunctionalJavascriptTests/Ajax/BackwardCompatibilityTest.php Tests the compatibility of the ajax.es6.js file.
BadPluginDefinitionException class Drupal\migrate\Plugin\Exception core/modules/migrate/src/Plugin/Exception/BadPluginDefinitionException.php Defines a class for bad plugin definition exceptions. 4
BaloneySpam class Drupal\block_test\Plugin\Condition core/modules/block/tests/modules/block_test/src/Plugin/Condition/BaloneySpam.php Provides a 'baloney_spam' condition.
BanAdmin class Drupal\ban\Form core/modules/ban/src/Form/BanAdmin.php Displays banned IP addresses. 1
Banana class Drupal\plugin_test\Plugin\plugin_test\fruit core/modules/system/tests/modules/plugin_test/src/Plugin/plugin_test/fruit/Banana.php Plugin annotation @Plugin( id = "banana", label = "Banana", color = "yellow", uses = { "bread" = @Translation("Banana bread"), "loaf" = @PluralTranslation( singular = "@count loaf", plural = "@count loaves" ) } )
BanDelete class Drupal\ban\Form core/modules/ban/src/Form/BanDelete.php Provides a form to unban IP addresses. 1
BanIpManager class Drupal\ban core/modules/ban/src/BanIpManager.php Ban IP manager. 1 2
BanIpManagerInterface interface Drupal\ban core/modules/ban/src/BanIpManagerInterface.php Provides an interface defining a BanIp manager. 1 3
BanMiddleware class Drupal\ban core/modules/ban/src/BanMiddleware.php Provides a HTTP middleware to implement IP based banning. 1 2
BanMiddlewareTest class Drupal\Tests\ban\Unit core/modules/ban/tests/src/Unit/BanMiddlewareTest.php @coversDefaultClass \Drupal\ban\BanMiddleware @group ban
Bar class Drupal\image_test\Plugin\ImageToolkit\Operation\test core/modules/system/tests/modules/image_test/src/Plugin/ImageToolkit/Operation/test/Bar.php Builds an image toolkit operation.
BarClass class Drupal\Tests\Core\DependencyInjection\Fixture core/tests/Drupal/Tests/Core/DependencyInjection/Fixture/BarClass.php Stub class which acts as a service to test the container. 2
BareHtmlPageRenderer class Drupal\Core\ProxyClass\Render core/lib/Drupal/Core/ProxyClass/Render/BareHtmlPageRenderer.php Provides a proxy class for \Drupal\Core\Render\BareHtmlPageRenderer.
BareHtmlPageRenderer class Drupal\Core\Render core/lib/Drupal/Core/Render/BareHtmlPageRenderer.php Default bare HTML page renderer. 2
BareHtmlPageRendererInterface interface Drupal\Core\Render core/lib/Drupal/Core/Render/BareHtmlPageRendererInterface.php Bare HTML page renderer. 2 4
BartikTest class Drupal\Tests\bartik\Functional core/themes/bartik/tests/src/Functional/BartikTest.php Tests the Bartik theme.
BaseCommand class Drupal\Core\Ajax core/lib/Drupal/Core/Ajax/BaseCommand.php Base command that only exists to simplify AJAX commands. 6 6
BaseFieldAccessTest class Drupal\Tests\views\Functional\Entity core/modules/views/tests/src/Functional/Entity/BaseFieldAccessTest.php Tests views base field access.
BaseFieldDefinition class Drupal\Core\Field core/lib/Drupal/Core/Field/BaseFieldDefinition.php A class for defining entity fields. 2 99
BaseFieldDefinitionTest class Drupal\Tests\Core\Entity core/tests/Drupal/Tests/Core/Entity/BaseFieldDefinitionTest.php Unit test for BaseFieldDefinition.
BaseFieldDefinitionTest class Drupal\Tests\migrate\Unit\Plugin\migrate\destination core/modules/migrate/tests/src/Unit/Plugin/migrate/destination/EntityTestBase.php Stub class for BaseFieldDefinition.
BaseFieldDefinitionTestBase abstract class Drupal\Tests\Core\Field core/tests/Drupal/Tests/Core/Field/BaseFieldDefinitionTestBase.php Provides setup method for testing base field definitions. 1 1
BaseFieldFileFormatterBase abstract class Drupal\file\Plugin\Field\FieldFormatter core/modules/file/src/Plugin/Field/FieldFormatter/BaseFieldFileFormatterBase.php Base class for file formatters, which allow to link to the file download URL. 4
BaseFieldOverride class Drupal\Core\Field\Entity core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php Defines the base field override entity. 14
BaseFieldOverrideAccessControlHandler class Drupal\Core\Field core/lib/Drupal/Core/Field/BaseFieldOverrideAccessControlHandler.php Provides en entity access control handler for base field override entity.
BaseFieldOverrideHalJsonAnonTest class Drupal\Tests\hal\Functional\Core core/modules/hal/tests/src/Functional/Core/BaseFieldOverrideHalJsonAnonTest.php @group hal @group legacy
BaseFieldOverrideHalJsonBasicAuthTest class Drupal\Tests\hal\Functional\Core core/modules/hal/tests/src/Functional/Core/BaseFieldOverrideHalJsonBasicAuthTest.php @group hal @group legacy
BaseFieldOverrideHalJsonCookieTest class Drupal\Tests\hal\Functional\Core core/modules/hal/tests/src/Functional/Core/BaseFieldOverrideHalJsonCookieTest.php @group hal @group legacy
BaseFieldOverrideJsonAnonTest class Drupal\FunctionalTests\Rest core/tests/Drupal/FunctionalTests/Rest/BaseFieldOverrideJsonAnonTest.php @group rest
BaseFieldOverrideJsonBasicAuthTest class Drupal\FunctionalTests\Rest core/tests/Drupal/FunctionalTests/Rest/BaseFieldOverrideJsonBasicAuthTest.php @group rest
BaseFieldOverrideJsonCookieTest class Drupal\FunctionalTests\Rest core/tests/Drupal/FunctionalTests/Rest/BaseFieldOverrideJsonCookieTest.php @group rest
BaseFieldOverrideResourceTestBase abstract class Drupal\FunctionalTests\Rest core/tests/Drupal/FunctionalTests/Rest/BaseFieldOverrideResourceTestBase.php 9 3
BaseFieldOverrideStorage class Drupal\Core\Field core/lib/Drupal/Core/Field/BaseFieldOverrideStorage.php Storage class for base field overrides.
BaseFieldOverrideTest class Drupal\KernelTests\Core\Field\Entity core/tests/Drupal/KernelTests/Core/Field/Entity/BaseFieldOverrideTest.php @coversDefaultClass \Drupal\Core\Field\Entity\BaseFieldOverride @group Field
BaseFieldOverrideTest class Drupal\Tests\jsonapi\Functional core/modules/jsonapi/tests/src/Functional/BaseFieldOverrideTest.php JSON:API integration test for the "BaseFieldOverride" config entity type.
BaseFieldOverrideXmlAnonTest class Drupal\FunctionalTests\Rest core/tests/Drupal/FunctionalTests/Rest/BaseFieldOverrideXmlAnonTest.php @group rest
BaseFieldOverrideXmlBasicAuthTest class Drupal\FunctionalTests\Rest core/tests/Drupal/FunctionalTests/Rest/BaseFieldOverrideXmlBasicAuthTest.php @group rest
BaseFieldOverrideXmlCookieTest class Drupal\FunctionalTests\Rest core/tests/Drupal/FunctionalTests/Rest/BaseFieldOverrideXmlCookieTest.php @group rest
BaseFormIdInterface interface Drupal\Core\Form core/lib/Drupal/Core/Form/BaseFormIdInterface.php Provides an interface for a Form that has a base form ID. 5 5
BaseThemeMissingTest class Drupal\KernelTests\Core\Theme core/tests/Drupal/KernelTests/Core/Theme/BaseThemeMissingTest.php Tests the behavior of a theme when base_theme info key is missing.
BaseThemeRequiredTest class Drupal\KernelTests\Core\Theme core/tests/Drupal/KernelTests/Core/Theme/BaseThemeRequiredTest.php Tests the behavior of the `base theme` key.
Basic class Drupal\views\Plugin\views\exposed_form core/modules/views/src/Plugin/views/exposed_form/Basic.php Exposed form plugin that provides a basic exposed form.
BasicAuth class Drupal\basic_auth\Authentication\Provider core/modules/basic_auth/src/Authentication/Provider/BasicAuth.php HTTP Basic authentication provider. 2
BasicAuthResourceTestTrait trait Drupal\Tests\rest\Functional core/modules/rest/tests/src/Functional/BasicAuthResourceTestTrait.php Trait for ResourceTestBase subclasses testing $auth=basic_auth. 154
BasicAuthTest class Drupal\Tests\basic_auth\Functional core/modules/basic_auth/tests/src/Functional/BasicAuthTest.php Tests for BasicAuth authentication provider.
BasicAuthTestController class Drupal\basic_auth_test core/modules/basic_auth/tests/modules/basic_auth_test/src/BasicAuthTestController.php
BasicAuthTestTrait trait Drupal\Tests\basic_auth\Traits core/modules/basic_auth/tests/src/Traits/BasicAuthTestTrait.php Provides common functionality for Basic Authentication test classes. 2
BasicControllerClass class Drupal\Tests\Core\Entity core/tests/Drupal/Tests/Core/Entity/EntityResolverManagerTest.php A class containing all kind of different controller methods.
BasicForm class Drupal\Tests\Core\Entity core/tests/Drupal/Tests/Core/Entity/EntityResolverManagerTest.php A basic form with a passed entity with an interface.

Other projects

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