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 1518

Name	Deprecated	Object type	Namespace	File name	Summary	Direct uses	Use statements	Strings
BackendChain		class	Drupal\Core\Cache	core/lib/Drupal/Core/Cache/BackendChain.php	Defines a chained cache implementation for combining multiple cache backends.		2	4
BackendChainImplementationUnitTest		class	Drupal\Tests\Core\Cache	core/tests/Drupal/Tests/Core/Cache/BackendChainImplementationUnitTest.php	Unit test of backend chain implementation specifics.
BackendChainTest		class	Drupal\KernelTests\Core\Cache	core/tests/Drupal/KernelTests/Core/Cache/BackendChainTest.php	Unit test of the backend chain using the generic cache unit test base.
BackendCompilerPass		class	Drupal\Core\DependencyInjection\Compiler	core/lib/Drupal/Core/DependencyInjection/Compiler/BackendCompilerPass.php	Defines a compiler pass to allow automatic override per backend.		2
BackendCompilerPassTest		class	Drupal\Tests\Core\DependencyInjection\Compiler	core/tests/Drupal/Tests/Core/DependencyInjection/Compiler/BackendCompilerPassTest.php	@coversDefaultClass \Drupal\Core\DependencyInjection\Compiler\BackendCompilerPass @group DependencyInjection
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	1
BanAdminTest		class	Drupal\Tests\ban\Unit	core/modules/ban/tests/src/Unit/BanAdminTest.php	Tests the BanAdmin form.
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
BanHooks		class	Drupal\ban\Hook	core/modules/ban/src/Hook/BanHooks.php	Hook implementations for ban.
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	5
BanIpTest		class	Drupal\Tests\ban\Kernel	core/modules/ban/tests/src/Kernel/BanIpTest.php	@group ban
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.
BarAccessPolicy		class	Drupal\Tests\Core\Session	core/tests/Drupal/Tests/Core/Session/AccessPolicyProcessorTest.php
BarAlterAccessPolicy		class	Drupal\Tests\Core\Session	core/tests/Drupal/Tests/Core/Session/AccessPolicyProcessorTest.php
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.		1
BareHtmlPageRenderer		class	Drupal\Core\Render	core/lib/Drupal/Core/Render/BareHtmlPageRenderer.php	Default bare HTML page renderer.
BareHtmlPageRenderer		class	Drupal\Core\ProxyClass\Render	core/lib/Drupal/Core/ProxyClass/Render/BareHtmlPageRenderer.php	Provides a proxy class for \Drupal\Core\Render\BareHtmlPageRenderer.
BareHtmlPageRendererInterface		interface	Drupal\Core\Render	core/lib/Drupal/Core/Render/BareHtmlPageRendererInterface.php	Bare HTML page renderer.	2	3
BaseCommand		class	Drupal\Core\Ajax	core/lib/Drupal/Core/Ajax/BaseCommand.php	Base command that only exists to simplify AJAX commands.
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	100
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.		13
BaseFieldOverrideAccessControlHandler		class	Drupal\Core\Field	core/lib/Drupal/Core/Field/BaseFieldOverrideAccessControlHandler.php	Provides en entity access control handler for base field override entity.
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		6
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.
BaseFieldOverrideValidationTest		class	Drupal\KernelTests\Core\Entity	core/tests/Drupal/KernelTests/Core/Entity/BaseFieldOverrideValidationTest.php	Tests validation of base_field_override entities.
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
BaseFileConstraintValidator		abstract class	Drupal\file\Plugin\Validation\Constraint	core/modules/file/src/Plugin/Validation/Constraint/BaseFileConstraintValidator.php	Provides a base class for file constraint validators.	7
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
BaseRequirementsFulfilledValidator		final class	Drupal\package_manager\Validator	core/modules/package_manager/src/Validator/BaseRequirementsFulfilledValidator.php	Validates that base requirements do not have any errors.		1
BaseRequirementsFulfilledValidatorTest		class	Drupal\Tests\package_manager\Kernel	core/modules/package_manager/tests/src/Kernel/BaseRequirementsFulfilledValidatorTest.php	@covers \Drupal\package_manager\Validator\BaseRequirementsFulfilledValidator @covers \Drupal\package_manager\Validator\BaseRequirementValidatorTrait
BaseRequirementValidatorTrait		trait	Drupal\package_manager\Validator	core/modules/package_manager/src/Validator/BaseRequirementValidatorTrait.php	Provides methods for base requirement validators.		1
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.

Other projects

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