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
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. 18
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.
BatchNegotiator class Drupal\system\Theme core/modules/system/src/Theme/BatchNegotiator.php Sets the active theme for the batch page. 2
BatchNegotiatorTest class Drupal\KernelTests\Core\Batch core/tests/Drupal/KernelTests/Core/Batch/BatchNegotiatorTest.php Tests the BatchNegotiator.
BatchStorage class Drupal\Core\Batch core/lib/Drupal/Core/Batch/BatchStorage.php 2
BatchStorage class Drupal\Core\ProxyClass\Batch core/lib/Drupal/Core/ProxyClass/Batch/BatchStorage.php Provides a proxy class for \Drupal\Core\Batch\BatchStorage.
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.
BcRoute class Drupal\Core\Routing core/lib/Drupal/Core/Routing/BcRoute.php A backwards compatibility route.
BcTimestampNormalizerUnixTestTrait trait Drupal\Tests\rest\Functional core/modules/rest/tests/src/Functional/BcTimestampNormalizerUnixTestTrait.php Trait for ResourceTestBase subclasses formatting expected timestamp data.
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.
BigPipeMarkup final class Drupal\big_pipe\Render core/modules/big_pipe/src/Render/BigPipeMarkup.php Defines an object that passes safe strings through BigPipe's render pipeline. 3
BigPipePlaceholderTestCase class Drupal\big_pipe_test core/modules/big_pipe/tests/modules/big_pipe_test/src/BigPipePlaceholderTestCases.php
BigPipePlaceholderTestCases class Drupal\big_pipe_test core/modules/big_pipe/tests/modules/big_pipe_test/src/BigPipePlaceholderTestCases.php BigPipe placeholder test cases for use in both unit and integration tests. 2
BigPipeRegressionTest class Drupal\Tests\big_pipe\FunctionalJavascript core/modules/big_pipe/tests/src/FunctionalJavascript/BigPipeRegressionTest.php BigPipe regression tests.
BigPipeRegressionTest class Drupal\Tests\ckeditor\FunctionalJavascript core/modules/ckeditor/tests/src/FunctionalJavascript/BigPipeRegressionTest.php BigPipe regression test for CKEditor 4.
BigPipeRegressionTestController class Drupal\big_pipe_regression_test core/modules/big_pipe/tests/modules/big_pipe_regression_test/src/BigPipeRegressionTestController.php 1
BigPipeResponse class Drupal\big_pipe\Render core/modules/big_pipe/src/Render/BigPipeResponse.php A response that is sent in chunks by the BigPipe service. 3
BigPipeResponseAttachmentsProcessor class Drupal\big_pipe\Render core/modules/big_pipe/src/Render/BigPipeResponseAttachmentsProcessor.php Processes attachments of HTML responses with BigPipe enabled. 1 2
BigPipeResponseAttachmentsProcessorTest class Drupal\Tests\big_pipe\Unit\Render core/modules/big_pipe/tests/src/Unit/Render/BigPipeResponseAttachmentsProcessorTest.php @coversDefaultClass \Drupal\big_pipe\Render\BigPipeResponseAttachmentsProcessor @group big_pipe
BigPipeStrategy class Drupal\big_pipe\Render\Placeholder core/modules/big_pipe/src/Render/Placeholder/BigPipeStrategy.php Defines the BigPipe placeholder strategy, to send HTML in chunks. 4 2
BigPipeStrategyTest class Drupal\Tests\big_pipe\Unit\Render\Placeholder core/modules/big_pipe/tests/src/Unit/Render/Placeholder/BigPipeStrategyTest.php @coversDefaultClass \Drupal\big_pipe\Render\Placeholder\BigPipeStrategy @group big_pipe
BigPipeTest class Drupal\Tests\big_pipe\Functional core/modules/big_pipe/tests/src/Functional/BigPipeTest.php Tests BigPipe's no-JS detection & response delivery (with and without JS).
BigPipeTestController class Drupal\big_pipe_test core/modules/big_pipe/tests/modules/big_pipe_test/src/BigPipeTestController.php
BigPipeTestForm class Drupal\big_pipe_test\Form core/modules/big_pipe/tests/modules/big_pipe_test/src/Form/BigPipeTestForm.php Form to test BigPipe.
BigPipeTestSubscriber class Drupal\big_pipe_test\EventSubscriber core/modules/big_pipe/tests/modules/big_pipe_test/src/EventSubscriber/BigPipeTestSubscriber.php 1 2
BinaryData class Drupal\Core\TypedData\Plugin\DataType core/lib/Drupal/Core/TypedData/Plugin/DataType/BinaryData.php The binary data type.
BinaryInterface interface Drupal\Core\TypedData\Type core/lib/Drupal/Core/TypedData/Type/BinaryInterface.php Interface for binary data. 1 3
BlankLayout class Drupal\layout_builder\Plugin\Layout core/modules/layout_builder/src/Plugin/Layout/BlankLayout.php Provides a layout plugin that produces no output.

Other projects

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