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
BubbleableMetadataTest class Drupal\Tests\Core\Render core/tests/Drupal/Tests/Core/Render/BubbleableMetadataTest.php @coversDefaultClass \Drupal\Core\Render\BubbleableMetadata @group Render
BubblingTest class Drupal\Tests\Core\Render core/tests/Drupal/Tests/Core/Render/RendererBubblingTest.php
BuilderInterface interface Drupal\Composer\Generator composer/Generator/BuilderInterface.php Produce the output for a metapackage. 1 1
BuilderTest class Drupal\Tests\Composer\Generator core/tests/Drupal/Tests/Composer/Generator/BuilderTest.php Test DrupalCoreRecommendedBuilder
BuildTestBase abstract class Drupal\BuildTests\Framework core/tests/Drupal/BuildTests/Framework/BuildTestBase.php Provides a workspace to test build processes. 4 4
BuildTestSuite class Drupal\Tests\TestSuites core/tests/TestSuites/BuildTestSuite.php Discovers tests for the build test suite.
BuildTestTest class Drupal\BuildTests\Framework\Tests core/tests/Drupal/BuildTests/Framework/Tests/BuildTestTest.php @coversDefaultClass \Drupal\BuildTests\Framework\BuildTestBase @group Build
BulkDeleteTest class Drupal\Tests\field\Kernel core/modules/field/tests/src/Kernel/BulkDeleteTest.php Bulk delete storages and fields, and clean up afterwards.
BulkForm class Drupal\views\Plugin\views\field core/modules/views/src/Plugin/views/field/BulkForm.php Defines a actions-based bulk operation form element. 4 4
BulkForm

in drupal:8.5.0 and is removed from drupal:9.0.0. Use \Drupal\views\Plugin\views\field\BulkForm instead.

class Drupal\system\Plugin\views\field core/modules/system/src/Plugin/views/field/BulkForm.php Defines a actions-based bulk operation form element.
BulkFormAccessTest class Drupal\Tests\node\Functional\Views core/modules/node/tests/src/Functional/Views/BulkFormAccessTest.php Tests if entity access is respected on a node bulk operations form.
BulkFormAccessTest class Drupal\Tests\user\Functional\Views core/modules/user/tests/src/Functional/Views/BulkFormAccessTest.php Tests if entity access is respected on a user bulk form.
BulkFormTest class Drupal\Tests\user\Functional\Views core/modules/user/tests/src/Functional/Views/BulkFormTest.php Tests a user bulk form.
BulkFormTest class Drupal\Tests\node\Functional\Views core/modules/node/tests/src/Functional/Views/BulkFormTest.php Tests a node bulk form.
BulkFormTest class Drupal\Tests\views\Functional core/modules/views/tests/src/Functional/BulkFormTest.php Tests the views bulk form test.
BulkFormUpdateTest class Drupal\Tests\views\Functional\Update core/modules/views/tests/src/Functional/Update/BulkFormUpdateTest.php Tests Views image style dependencies update.
Bundle class Drupal\views\Plugin\views\filter core/modules/views/src/Plugin/views/filter/Bundle.php Filter class which allows filtering by entity bundles.
BundleConfigImportValidate class Drupal\Core\Entity\Event core/lib/Drupal/Core/Entity/Event/BundleConfigImportValidate.php Entity config importer validation event subscriber. 2
BundleConstraint class Drupal\Core\Entity\Plugin\Validation\Constraint core/lib/Drupal/Core/Entity/Plugin/Validation/Constraint/BundleConstraint.php Checks if a value is a valid entity type. 1
BundleConstraintValidator class Drupal\Core\Entity\Plugin\Validation\Constraint core/lib/Drupal/Core/Entity/Plugin/Validation/Constraint/BundleConstraintValidator.php Validates the Bundle constraint.
BundleConstraintValidatorTest class Drupal\KernelTests\Core\Entity core/tests/Drupal/KernelTests/Core/Entity/BundleConstraintValidatorTest.php Tests validation constraints for BundleConstraintValidator.
BundleEntityFormBase class Drupal\Core\Entity core/lib/Drupal/Core/Entity/BundleEntityFormBase.php Class BundleEntityFormBase is a base form for bundle config entities. 4 5
BundleTranslationSettingsInterface interface Drupal\content_translation core/modules/content_translation/src/BundleTranslationSettingsInterface.php Interface providing support for content translation bundle settings. 1 2
Button class Drupal\Core\Render\Element core/lib/Drupal/Core/Render/Element/Button.php Provides an action button form element. 1
Bytes class Drupal\Component\Utility core/lib/Drupal/Component/Utility/Bytes.php Provides helper methods for byte conversions. 11
BytesTest class Drupal\Tests\Component\Utility core/tests/Drupal/Tests/Component/Utility/BytesTest.php Tests bytes size parsing helper methods.
Cache class Drupal\Core\Cache core/lib/Drupal/Core/Cache/Cache.php Helper methods for cache. 216
CacheabilityMetadataConfigOverride class Drupal\config_override_integration_test core/modules/config/tests/config_override_integration_test/src/CacheabilityMetadataConfigOverride.php Test implementation of a config override that provides cacheability metadata. 2
CacheabilityMetadataConfigOverrideIntegrationTest class Drupal\Tests\config\Functional core/modules/config/tests/src/Functional/CacheabilityMetadataConfigOverrideIntegrationTest.php Tests if configuration overrides correctly affect cacheability metadata.
CacheabilityMetadataConfigOverrideTest class Drupal\KernelTests\Core\Config core/tests/Drupal/KernelTests/Core/Config/CacheabilityMetadataConfigOverrideTest.php Tests if configuration overrides correctly affect cacheability metadata.
CacheabilityMetadataUpdateTest class Drupal\Tests\views\Functional\Update core/modules/views/tests/src/Functional/Update/CacheabilityMetadataUpdateTest.php Tests that views cacheability metadata post update hook runs properly.
CacheableAccessDeniedHttpException class Drupal\Core\Http\Exception core/lib/Drupal/Core/Http/Exception/CacheableAccessDeniedHttpException.php A cacheable AccessDeniedHttpException. 1 4
CacheableBadRequestHttpException class Drupal\Core\Http\Exception core/lib/Drupal/Core/Http/Exception/CacheableBadRequestHttpException.php A cacheable BadRequestHttpException. 11
CacheableConflictHttpException class Drupal\Core\Http\Exception core/lib/Drupal/Core/Http/Exception/CacheableConflictHttpException.php A cacheable ConflictHttpException.
CacheableDependencyInterface interface Drupal\Core\Cache core/lib/Drupal/Core/Cache/CacheableDependencyInterface.php Defines an interface for objects which may be used by other cached objects. 63 80
CacheableDependencyTrait trait Drupal\Core\Cache core/lib/Drupal/Core/Cache/CacheableDependencyTrait.php Trait for \Drupal\Core\Cache\CacheableDependencyInterface. 21
CacheableGoneHttpException class Drupal\Core\Http\Exception core/lib/Drupal/Core/Http/Exception/CacheableGoneHttpException.php A cacheable GoneHttpException.
CacheableHttpException class Drupal\Core\Http\Exception core/lib/Drupal/Core/Http/Exception/CacheableHttpException.php A cacheable HttpException. 1
CacheableJsonResponse class Drupal\Core\Cache core/lib/Drupal/Core/Cache/CacheableJsonResponse.php A JsonResponse that contains and can expose cacheability metadata. 6
CacheableLengthRequiredHttpException class Drupal\Core\Http\Exception core/lib/Drupal/Core/Http/Exception/CacheableLengthRequiredHttpException.php A cacheable LengthRequiredHttpException.
CacheableMetadata class Drupal\Core\Cache core/lib/Drupal/Core/Cache/CacheableMetadata.php Defines a generic class for passing cacheability metadata. 2 144
CacheableMetadataCalculationTest class Drupal\views_test_cacheable_metadata_calculation\Plugin\views\access core/modules/views/tests/modules/views_test_cacheable_metadata_calculation/src/Plugin/views/access/CacheableMetadataCalculationTest.php Tests plugin that reports when cacheable metadata is being calculated.
CacheableMetadataCalculationTest class Drupal\Tests\views\Kernel core/modules/views/tests/src/Kernel/CacheableMetadataCalculationTest.php Tests that cacheability metadata is only calculated when needed.
CacheableMetadataTest class Drupal\Tests\Core\Cache core/tests/Drupal/Tests/Core/Cache/CacheableMetadataTest.php @coversDefaultClass \Drupal\Core\Cache\CacheableMetadata @group Cache
CacheableMethodNotAllowedHttpException class Drupal\Core\Http\Exception core/lib/Drupal/Core/Http/Exception/CacheableMethodNotAllowedHttpException.php A cacheable MethodNotAllowedHttpException. 1
CacheableNormalization class Drupal\jsonapi\Normalizer\Value core/modules/jsonapi/src/Normalizer/Value/CacheableNormalization.php Use to store normalized data and its cacheability. 2 15
CacheableNormalizerInterface interface Drupal\serialization\Normalizer core/modules/serialization/src/Normalizer/CacheableNormalizerInterface.php Defines the interface for normalizers producing cacheable normalizations. 1 4
CacheableNotAcceptableHttpException class Drupal\Core\Http\Exception core/lib/Drupal/Core/Http/Exception/CacheableNotAcceptableHttpException.php A cacheable NotAcceptableHttpException.
CacheableNotFoundHttpException class Drupal\Core\Http\Exception core/lib/Drupal/Core/Http/Exception/CacheableNotFoundHttpException.php A cacheable NotFoundHttpException. 2
CacheableOmission final class Drupal\jsonapi\Normalizer\Value core/modules/jsonapi/src/Normalizer/Value/CacheableOmission.php Represents the cacheability associated with the omission of a value. 2

Other projects


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