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
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.
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. 102
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 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.
BasicRecursiveValidatorFactory class Drupal\Core\Validation core/lib/Drupal/Core/Validation/BasicRecursiveValidatorFactory.php A factory for creating Symfony recursive validators. 3
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\Functional\Wizard core/modules/views/tests/src/Functional/Wizard/BasicTest.php Tests creating views with the wizard and viewing them on the listing page.
BasicTest class Drupal\Tests\views\Kernel core/modules/views/tests/src/Kernel/BasicTest.php A basic query test for Views.
Batch class Drupal\Core\Queue core/lib/Drupal/Core/Queue/Batch.php Defines a batch queue handler used by the Batch API.
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
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 4
BatchTestHelper class Drupal\batch_test core/modules/system/tests/modules/batch_test/src/BatchTestHelper.php 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
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

Other projects


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