Classes, traits, and interfaces - 11.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 1519

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
BatchBidSerialUpdateTest class Drupal\Tests\system\Functional\Update core/modules/system/tests/src/Functional/Update/BatchBidSerialUpdateTest.php Tests system_update_10101() upgrade path.
BatchBuilder class Drupal\Core\Batch core/lib/Drupal/Core/Batch/BatchBuilder.php Builds an array for a batch process. 19
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. 1
BatchControllerTest class Drupal\Tests\system\Unit\Batch core/modules/system/tests/src/Unit/Batch/BatchControllerTest.php Tests for the batch controller class.
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.
BatchNotFoundTest class Drupal\Tests\system\Functional\Batch core/modules/system/tests/src/Functional/Batch/BatchNotFoundTest.php Tests if a page not found error is returned when a batch ID does not exist.
BatchStorage class Drupal\Core\Batch core/lib/Drupal/Core/Batch/BatchStorage.php Defines the storage handler class for batches. 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 5
BatchTestCallbacks class Drupal\batch_test core/modules/system/tests/modules/batch_test/src/BatchTestCallbacks.php Batch callbacks for testing batches. 2
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.
BatchTestDefinitions class Drupal\batch_test core/modules/system/tests/modules/batch_test/src/BatchTestDefinitions.php Batch definitions for testing batches. 4
BatchTestHelper class Drupal\batch_test core/modules/system/tests/modules/batch_test/src/BatchTestHelper.php Batch helper for testing batches. 8
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.
BazAccessPolicy class Drupal\Tests\Core\Session core/tests/Drupal/Tests/Core/Session/AccessPolicyProcessorTest.php A test access policy setting a 'baz' permission requirement.
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

in drupal:11.2.0 and is removed from drupal:12.0.0. Use route aliases instead.

class Drupal\Core\Routing core/lib/Drupal/Core/Routing/BcRoute.php A backwards compatibility route.
BeforeCommand class Drupal\Core\Ajax core/lib/Drupal/Core/Ajax/BeforeCommand.php An AJAX command for calling the jQuery before() method. 3
BeforeOrAfter class Drupal\Core\Hook\OrderOperation core/lib/Drupal/Core/Hook/OrderOperation/BeforeOrAfter.php Moves one listener to be called before or after other listeners. 1
BHooks class Drupal\bbb_hook_order_test\Hook core/modules/system/tests/modules/HookOrder/bbb_hook_order_test/src/Hook/BHooks.php This class contains hook implementations. 1
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). 5 2
BigPipeBypassJsHooks class Drupal\big_pipe_bypass_js\Hook core/modules/big_pipe/tests/modules/big_pipe_bypass_js/src/Hook/BigPipeBypassJsHooks.php Hook implementations for big_pipe_bypass_js.
BigPipeController class Drupal\big_pipe\Controller core/modules/big_pipe/src/Controller/BigPipeController.php Returns responses for BigPipe module routes.
BigPipeHooks class Drupal\big_pipe\Hook core/modules/big_pipe/src/Hook/BigPipeHooks.php Hook implementations for big_pipe.
BigPipeInterfacePreviewThemeSuggestionsTest class Drupal\Tests\big_pipe\Kernel core/modules/big_pipe/tests/src/Kernel/BigPipeInterfacePreviewThemeSuggestionsTest.php Tests the big_pipe_theme_suggestions_big_pipe_interface_preview() function.
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
BigPipeMessagesHooks class Drupal\big_pipe_messages_test\Hook core/modules/big_pipe/tests/modules/big_pipe_messages_test/src/Hook/BigPipeMessagesHooks.php Hook implementations for big_pipe_test.
BigPipePlaceholderTestCase class Drupal\big_pipe_test core/modules/big_pipe/tests/modules/big_pipe_test/src/BigPipePlaceholderTestCases.php Provides a placeholder for the BigPipe placeholder test cases.
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
BigPipePreviewTest class Drupal\Tests\big_pipe\FunctionalJavascript core/modules/big_pipe/tests/src/FunctionalJavascript/BigPipePreviewTest.php Tests placeholder preview functionality.
BigPipeRegressionTest class Drupal\Tests\big_pipe\FunctionalJavascript core/modules/big_pipe/tests/src/FunctionalJavascript/BigPipeRegressionTest.php BigPipe regression tests.
BigPipeRegressionTestController class Drupal\big_pipe_regression_test core/modules/big_pipe/tests/modules/big_pipe_regression_test/src/BigPipeRegressionTestController.php Controller for BigPipe regression tests. 1
BigPipeRegressionTestHooks class Drupal\big_pipe_regression_test\Hook core/modules/big_pipe/tests/modules/big_pipe_regression_test/src/Hook/BigPipeRegressionTestHooks.php Hook implementations for big_pipe_regression_test.
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. 7
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[[api-linebreak]] @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. 5 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[[api-linebreak]] @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 Returns responses for Big Pipe routes.

Other projects


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