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

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
ComponentValidator final class Drupal\sdc\Component core/modules/sdc/src/Component/ComponentValidator.php Validates a component based on its definition and the component schema. 3
ComponentValidatorTest final class Drupal\Tests\sdc\Unit core/modules/sdc/tests/src/Unit/ComponentValidatorTest.php Unit tests for the component validation.
ComponentValidatorTest class Drupal\Tests\Core\Theme\Component core/tests/Drupal/Tests/Core/Theme/Component/ComponentValidatorTest.php Unit tests for the component validation.
Composer class Drupal\Composer composer/Composer.php Provides static functions for composer script events. 9
Composer class Drupal\Core\Composer core/lib/Drupal/Core/Composer/Composer.php Provides static functions for composer script events.
ComposerBuildTestBase abstract class Drupal\BuildTests\Composer core/tests/Drupal/BuildTests/Composer/ComposerBuildTestBase.php Base class for Composer build tests. 3 3
ComposerHookTest class Drupal\Tests\Composer\Plugin\Scaffold\Functional core/tests/Drupal/Tests/Composer/Plugin/Scaffold/Functional/ComposerHookTest.php Tests Composer Hooks that run scaffold operations.
ComposerInspector class Drupal\package_manager core/modules/package_manager/src/ComposerInspector.php Defines a class to get information from Composer. 23
ComposerInspectorTest class Drupal\Tests\package_manager\Kernel core/modules/package_manager/tests/src/Kernel/ComposerInspectorTest.php @coversDefaultClass \Drupal\package_manager\ComposerInspector
ComposerInstallersTrait trait Drupal\Tests\package_manager\Traits core/modules/package_manager/tests/src/Traits/ComposerInstallersTrait.php A utility for kernel tests that need to use 'composer/installers'. 3
ComposerIntegrationTest class Drupal\Tests core/tests/Drupal/Tests/ComposerIntegrationTest.php Tests Composer integration.
ComposerIntegrationTrait trait Drupal\Tests\Composer core/tests/Drupal/Tests/Composer/ComposerIntegrationTrait.php Some utility functions for testing the Composer integration. 2
ComposerMinimumStabilityValidator final class Drupal\package_manager\Validator core/modules/package_manager/src/Validator/ComposerMinimumStabilityValidator.php Checks that the packages to install meet the minimum stability.
ComposerMinimumStabilityValidatorTest class Drupal\Tests\package_manager\Kernel core/modules/package_manager/tests/src/Kernel/ComposerMinimumStabilityValidatorTest.php @covers \Drupal\package_manager\Validator\ComposerMinimumStabilityValidator @group package_manager @internal
ComposerNotReadyException final class Drupal\package_manager\Exception core/modules/package_manager/src/Exception/ComposerNotReadyException.php Exception thrown if we cannot reliably use Composer. 2
ComposerPatches class cweagans\Fake core/modules/package_manager/tests/fixtures/path_repos/cweagans--composer-patches/src/ComposerPatches.php Dummy composer plugin implementation.
ComposerPatchesValidator final class Drupal\package_manager\Validator core/modules/package_manager/src/Validator/ComposerPatchesValidator.php Validates the configuration of the cweagans/composer-patches plugin.
ComposerPatchesValidatorTest class Drupal\Tests\package_manager\Kernel core/modules/package_manager/tests/src/Kernel/ComposerPatchesValidatorTest.php @covers \Drupal\package_manager\Validator\ComposerPatchesValidator @group package_manager @internal
ComposerPluginImplementsScaffoldEvents class Drupal\Tests\fixture\Composer\Plugin core/tests/Drupal/Tests/Composer/Plugin/Scaffold/fixtures/composer-plugin-implements-scaffold-events/src/ComposerPluginImplementsScaffoldEvents.php A fixture composer plugin implement Drupal scaffold events.
ComposerPluginsValidator final class Drupal\package_manager\Validator core/modules/package_manager/src/Validator/ComposerPluginsValidator.php Validates the allowed Composer plugins, both in active and stage.
ComposerPluginsValidatorTest class Drupal\Tests\package_manager\Kernel core/modules/package_manager/tests/src/Kernel/ComposerPluginsValidatorTest.php @covers \Drupal\package_manager\Validator\ComposerPluginsValidator @group package_manager @internal
ComposerProjectTemplatesTest class Drupal\BuildTests\Composer\Template core/tests/Drupal/BuildTests/Composer/Template/ComposerProjectTemplatesTest.php Demonstrate that Composer project templates can be built as patched.
ComposerRequirementTest class Drupal\Tests\package_manager\Functional core/modules/package_manager/tests/src/Functional/ComposerRequirementTest.php Tests that Package Manager shows the Composer version on the status report.
ComposerScaffoldCommand class Drupal\Composer\Plugin\Scaffold composer/Plugin/Scaffold/ComposerScaffoldCommand.php The "drupal:scaffold" command class.
ComposerStagerExceptionTrait trait Drupal\package_manager_bypass core/modules/package_manager/tests/modules/package_manager_bypass/src/ComposerStagerExceptionTrait.php Trait to make Composer Stager throw pre-determined exceptions in tests.
ComposerStagerTestTrait trait Drupal\Tests\package_manager\Traits core/modules/package_manager/tests/src/Traits/ComposerStagerTestTrait.php Contains helper methods for testing Composer Stager interactions. 1
ComposerTest class Drupal\Tests\Composer core/tests/Drupal/Tests/Composer/ComposerTest.php @coversDefaultClass \Drupal\Composer\Composer @group Composer
ComposerValidateTest class Drupal\BuildTests\Composer core/tests/Drupal/BuildTests/Composer/ComposerValidateTest.php @group Composer
ComposerValidator final class Drupal\package_manager\Validator core/modules/package_manager/src/Validator/ComposerValidator.php Validates the project can be used by the Composer Inspector.
ComposerValidatorTest class Drupal\Tests\package_manager\Kernel core/modules/package_manager/tests/src/Kernel/ComposerValidatorTest.php @covers \Drupal\package_manager\Validator\ComposerValidator @group package_manager @internal
CompositeConstraintBase abstract class Drupal\Core\Entity\Plugin\Validation\Constraint core/lib/Drupal/Core/Entity/Plugin/Validation/Constraint/CompositeConstraintBase.php Provides a base class for constraints validating multiple fields. 4 6
CompositeFormElementTrait trait Drupal\Core\Render\Element core/lib/Drupal/Core/Render/Element/CompositeFormElementTrait.php Provides a trait for radios, checkboxes, and similar composite form elements.
ComputedBundleFieldTest class Drupal\Tests\views\Kernel\Handler core/modules/views/tests/src/Kernel/Handler/ComputedBundleFieldTest.php Provides some integration tests for computed bundle fields.
ComputedFieldTest class Drupal\Tests\views\Kernel\Handler core/modules/views/tests/src/Kernel/Handler/ComputedFieldTest.php Provides some integration tests for the Field handler.
ComputedFileUrl class Drupal\file core/modules/file/src/ComputedFileUrl.php Computed file URL property class. 2
ComputedFileUrlTest class Drupal\Tests\file\Kernel core/modules/file/tests/src/Kernel/ComputedFileUrlTest.php @coversDefaultClass \Drupal\file\ComputedFileUrl
ComputedItemListTrait trait Drupal\Core\TypedData core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php Provides common functionality for computed item lists. 7
ComputedReferenceTestFieldItemList class Drupal\entity_test\Plugin\Field core/modules/system/tests/modules/entity_test/src/Plugin/Field/ComputedReferenceTestFieldItemList.php A computed entity reference field item list. 2
ComputedString class Drupal\entity_test\TypedData core/modules/system/tests/modules/entity_test/src/TypedData/ComputedString.php A computed property for test strings. 2
ComputedTestBundleFieldItemList class Drupal\entity_test\Plugin\Field core/modules/system/tests/modules/entity_test/src/Plugin/Field/ComputedTestBundleFieldItemList.php A computed field item list for a bundle field. 1
ComputedTestCacheableIntegerItemList class Drupal\entity_test\Plugin\Field core/modules/system/tests/modules/entity_test/src/Plugin/Field/ComputedTestCacheableIntegerItemList.php Item list class for computed cacheable string field. 1
ComputedTestCacheableString class Drupal\entity_test\Plugin\DataType core/modules/system/tests/modules/entity_test/src/Plugin/DataType/ComputedTestCacheableString.php The string data type with cacheability metadata.
ComputedTestCacheableStringItem class Drupal\entity_test\Plugin\Field\FieldType core/modules/system/tests/modules/entity_test/src/Plugin/Field/FieldType/ComputedTestCacheableStringItem.php Defines the 'string' entity field type with cacheability metadata.
ComputedTestCacheableStringItemList class Drupal\entity_test\Plugin\Field core/modules/system/tests/modules/entity_test/src/Plugin/Field/ComputedTestCacheableStringItemList.php Item list class for computed cacheable string field. 2
ComputedTestFieldItemList class Drupal\entity_test\Plugin\Field core/modules/system/tests/modules/entity_test/src/Plugin/Field/ComputedTestFieldItemList.php A computed field item list. 2
Concat class Drupal\migrate\Plugin\migrate\process core/modules/migrate/src/Plugin/migrate/process/Concat.php Concatenates a set of strings. 1 2
ConcatTest class Drupal\Tests\migrate\Unit\process core/modules/migrate/tests/src/Unit/process/ConcatTest.php Tests the concat process plugin.
Condition class Drupal\Core\Entity\KeyValueStore\Query core/lib/Drupal/Core/Entity/KeyValueStore/Query/Condition.php Defines the condition class for the key value entity query.
Condition class Drupal\Core\Condition\Attribute core/lib/Drupal/Core/Condition/Attribute/Condition.php Defines a condition plugin attribute. 12
Condition class Drupal\Core\Condition\Annotation core/lib/Drupal/Core/Condition/Annotation/Condition.php Defines a condition plugin annotation object.

Other projects

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