Classes, traits, and interfaces - 8.9.x - 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 1511

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
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
BaseThemeDefaultDeprecationTest class Drupal\KernelTests\Core\Theme core/tests/Drupal/KernelTests/Core/Theme/BaseThemeDefaultDeprecationTest.php Tests the behavior of the Stable theme.
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

in drupal:8.3.0 and is removed from drupal:9.0.0. Use \Drupal\Tests\basic_auth\Traits\BasicAuthTestTrait instead.

trait Drupal\basic_auth\Tests core/modules/basic_auth/src/Tests/BasicAuthTestTrait.php Provides common functionality for Basic Authentication test classes.
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
BasicFormNoUpcasting class Drupal\Tests\Core\Entity core/tests/Drupal/Tests/Core/Entity/EntityResolverManagerTest.php A basic form with a passed entity without an interface.
BasicSettingsForm class Drupal\views_ui\Form core/modules/views_ui/src/Form/BasicSettingsForm.php Form builder for the admin display defaults page. 1
BasicStringFormatter class Drupal\Core\Field\Plugin\Field\FieldFormatter core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/BasicStringFormatter.php Plugin implementation of the 'basic_string' formatter.
BasicSyntaxTest class Drupal\KernelTests\Core\Database core/tests/Drupal/KernelTests/Core/Database/BasicSyntaxTest.php Tests SQL syntax interpretation.
BasicTest class Drupal\Tests\views\Kernel core/modules/views/tests/src/Kernel/BasicTest.php A basic query test for Views.
BasicTest class Drupal\Tests\views\Functional\Wizard core/modules/views/tests/src/Functional/Wizard/BasicTest.php Tests creating views with the wizard and viewing them on the listing page.
Batch class Drupal\Core\Queue core/lib/Drupal/Core/Queue/Batch.php Defines a batch queue handler used by the Batch API.
BatchBuilder class Drupal\Core\Batch core/lib/Drupal/Core/Batch/BatchBuilder.php Builds an array for a batch process. 2
BatchBuilderTest class Drupal\Tests\Core\Batch core/tests/Drupal/Tests/Core/Batch/BatchBuilderTest.php Tests for the batch builder class.
BatchController class Drupal\system\Controller core/modules/system/src/Controller/BatchController.php Controller routines for batch routes.
BatchKernelTest class Drupal\KernelTests\Core\Batch core/tests/Drupal/KernelTests/Core/Batch/BatchKernelTest.php Tests batch functionality.
BatchMemory class Drupal\Core\Queue core/lib/Drupal/Core/Queue/BatchMemory.php Defines a batch queue handler used by the Batch API for non-progressive batches.
BatchNegotiator class Drupal\system\Theme core/modules/system/src/Theme/BatchNegotiator.php Sets the active theme for the batch page. 2
BatchStorage class Drupal\Core\ProxyClass\Batch core/lib/Drupal/Core/ProxyClass/Batch/BatchStorage.php Provides a proxy class for \Drupal\Core\Batch\BatchStorage.
BatchStorage class Drupal\Core\Batch core/lib/Drupal/Core/Batch/BatchStorage.php 2
BatchStorageInterface interface Drupal\Core\Batch core/lib/Drupal/Core/Batch/BatchStorageInterface.php Defines a common interface for batch storage operations. 2 1
BatchTestChainedForm class Drupal\batch_test\Form core/modules/system/tests/modules/batch_test/src/Form/BatchTestChainedForm.php Generate form of id batch_test_chained_form. 1
BatchTestController class Drupal\batch_test\Controller core/modules/system/tests/modules/batch_test/src/Controller/BatchTestController.php Controller routines for batch tests.
BatchTestMockForm class Drupal\batch_test\Form core/modules/system/tests/modules/batch_test/src/Form/BatchTestMockForm.php Generate form of id batch_test_mock_form.
BatchTestMultiStepForm class Drupal\batch_test\Form core/modules/system/tests/modules/batch_test/src/Form/BatchTestMultiStepForm.php Generate form of id batch_test_multistep_form. 1
BatchTestSimpleForm class Drupal\batch_test\Form core/modules/system/tests/modules/batch_test/src/Form/BatchTestSimpleForm.php Generate form of id batch_test_simple_form. 1
BatchUserAction class Drupal\user_batch_action_test\Plugin\Action core/modules/views/tests/modules/user_batch_action_test/src/Plugin/Action/BatchUserAction.php Provides action that sets batch precessing.
BazCacheContext class Drupal\Tests\Core\Cache\Context core/tests/Drupal/Tests/Core/Cache/Context/CacheContextsManagerTest.php Fake calculated cache context class.
BazClass class Drupal\Tests\Core\DependencyInjection\Fixture core/tests/Drupal/Tests/Core/DependencyInjection/Fixture/BazClass.php Stub class which acts as a service dependency, to test the container.
BcConfigSubscriber class Drupal\serialization\EventSubscriber core/modules/serialization/src/EventSubscriber/BcConfigSubscriber.php Config event subscriber to rebuild the container when BC config is saved. 2
BcEditor class Drupal\Tests\editor\Unit core/modules/editor/tests/src/Unit/EditorBaseTest.php
BcRoute class Drupal\Core\Routing core/lib/Drupal/Core/Routing/BcRoute.php A backwards compatibility route. 2
BcRoutesTest class Drupal\Tests\settings_tray\Kernel core/modules/settings_tray/tests/src/Kernel/BcRoutesTest.php Tests Settings Tray BC routes.
BcTimestampNormalizerUnixTestTrait trait Drupal\Tests\rest\Functional core/modules/rest/tests/src/Functional/BcTimestampNormalizerUnixTestTrait.php Trait for ResourceTestBase subclasses formatting expected timestamp data. 21
BeforeCommand class Drupal\Core\Ajax core/lib/Drupal/Core/Ajax/BeforeCommand.php An AJAX command for calling the jQuery before() method. 2
BigApple class Drupal\plugin_test_extended\Plugin\plugin_test\fruit core/modules/system/tests/modules/plugin_test_extended/src/Plugin/plugin_test/fruit/BigApple.php Plugin annotation @PluginExtended( id = "big_apple", label = "Big Apple", color = "green" )
BigPipe class Drupal\big_pipe\Render core/modules/big_pipe/src/Render/BigPipe.php Service for sending an HTML response in chunks (to get faster page loads). 4 2
BigPipeController class Drupal\big_pipe\Controller core/modules/big_pipe/src/Controller/BigPipeController.php Returns responses for BigPipe module routes.

Other projects


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