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

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
BanIpTest class Drupal\Tests\ban\Kernel core/modules/ban/tests/src/Kernel/BanIpTest.php Tests Ban Ip.
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 Tests Drupal\ban\BanMiddleware.
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 A test access policy for 'foo' and 'bar' permissions.
BarAlterAccessPolicy class Drupal\Tests\Core\Session core/tests/Drupal/Tests/Core/Session/AccessPolicyProcessorTest.php A test access policy that adds a permission if another permission exists.
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. 2
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 4
BarTest abstract class Drupal\Tests\Core\Foo core/tests/PHPStan/fixtures/test-classes-with-metadata.php @group metadata @coversNothing[[api-linebreak]]
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 106
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. 12
BaseFieldOverrideAccessControlHandler class Drupal\Core\Field core/lib/Drupal/Core/Field/BaseFieldOverrideAccessControlHandler.php Provides en entity access control handler for base field override entity. 1
BaseFieldOverrideJsonAnonTest class Drupal\FunctionalTests\Rest core/tests/Drupal/FunctionalTests/Rest/BaseFieldOverrideJsonAnonTest.php Tests Base Field Override Json Anon.
BaseFieldOverrideJsonBasicAuthTest class Drupal\FunctionalTests\Rest core/tests/Drupal/FunctionalTests/Rest/BaseFieldOverrideJsonBasicAuthTest.php Tests Base Field Override Json Basic Auth.
BaseFieldOverrideJsonCookieTest class Drupal\FunctionalTests\Rest core/tests/Drupal/FunctionalTests/Rest/BaseFieldOverrideJsonCookieTest.php Tests Base Field Override Json Cookie.
BaseFieldOverrideResourceTestBase abstract class Drupal\FunctionalTests\Rest core/tests/Drupal/FunctionalTests/Rest/BaseFieldOverrideResourceTestBase.php Resource test base for BaseFieldOverride entity. 6
BaseFieldOverrideStorage class Drupal\Core\Field core/lib/Drupal/Core/Field/BaseFieldOverrideStorage.php Storage class for base field overrides. 1
BaseFieldOverrideTest class Drupal\KernelTests\Core\Field\Entity core/tests/Drupal/KernelTests/Core/Field/Entity/BaseFieldOverrideTest.php Tests Drupal\Core\Field\Entity\BaseFieldOverride.
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 Tests Base Field Override Xml Anon.
BaseFieldOverrideXmlBasicAuthTest class Drupal\FunctionalTests\Rest core/tests/Drupal/FunctionalTests/Rest/BaseFieldOverrideXmlBasicAuthTest.php Tests Base Field Override Xml Basic Auth.
BaseFieldOverrideXmlCookieTest class Drupal\FunctionalTests\Rest core/tests/Drupal/FunctionalTests/Rest/BaseFieldOverrideXmlCookieTest.php Tests Base Field Override Xml Cookie.
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 Tests Base Requirements Fulfilled Validator.
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.
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
BasicAuthHooks class Drupal\basic_auth\Hook core/modules/basic_auth/src/Hook/BasicAuthHooks.php Hook implementations for basic_auth.
BasicAuthResourceTestTrait trait Drupal\Tests\rest\Functional core/modules/rest/tests/src/Functional/BasicAuthResourceTestTrait.php Trait for ResourceTestBase subclasses testing $auth=basic_auth. 96
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 Provides routes for HTTP Basic Authentication testing.
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.
BasicFormNoContainerInjectionInterface class Drupal\Tests\Core\Entity core/tests/Drupal/Tests/Core/Entity/EntityResolverManagerTest.php A basic form without a container injection interface implemented.
BasicFormNoUpcasting class Drupal\Tests\Core\Entity core/tests/Drupal/Tests/Core/Entity/EntityResolverManagerTest.php A basic form with a passed entity without an interface.
BasicRecursiveValidatorFactory class Drupal\Core\Validation core/lib/Drupal/Core/Validation/BasicRecursiveValidatorFactory.php A factory for creating Symfony recursive validators. 2 2

Other projects

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