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 1519

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
ComposerPatchesValidatorTest class Drupal\Tests\package_manager\Kernel core/modules/package_manager/tests/src/Kernel/ComposerPatchesValidatorTest.php @covers \Drupal\package_manager\Validator\ComposerPatchesValidator[[api-linebreak]] @group package_manager @group #slow @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.
ComposerPluginsValidatorComplexInvalidTest class Drupal\Tests\package_manager\Kernel core/modules/package_manager/tests/src/Kernel/ComposerPluginsValidatorComplexInvalidTest.php @covers \Drupal\package_manager\Validator\ComposerPluginsValidator[[api-linebreak]] @group package_manager @group #slow @internal
ComposerPluginsValidatorInsecureTest class Drupal\Tests\package_manager\Kernel core/modules/package_manager/tests/src/Kernel/ComposerPluginsValidatorInsecureTest.php @covers \Drupal\package_manager\Validator\ComposerPluginsValidator[[api-linebreak]] @group package_manager @internal
ComposerPluginsValidatorSimpleInvalidTest class Drupal\Tests\package_manager\Kernel core/modules/package_manager/tests/src/Kernel/ComposerPluginsValidatorSimpleInvalidTest.php @covers \Drupal\package_manager\Validator\ComposerPluginsValidator[[api-linebreak]] @group package_manager @group #slow @internal
ComposerPluginsValidatorSimpleValidTest class Drupal\Tests\package_manager\Kernel core/modules/package_manager/tests/src/Kernel/ComposerPluginsValidatorSimpleValidTest.php @covers \Drupal\package_manager\Validator\ComposerPluginsValidator[[api-linebreak]] @group #slow @group package_manager @internal
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
ComposerPluginsValidatorTestBase abstract class Drupal\Tests\package_manager\Kernel core/modules/package_manager/tests/src/Kernel/ComposerPluginsValidatorTestBase.php @internal 3
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[[api-linebreak]] @group Composer
ComposerValidateTest class Drupal\BuildTests\Composer core/tests/Drupal/BuildTests/Composer/ComposerValidateTest.php Tests.
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[[api-linebreak]] @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[[api-linebreak]]
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.
Condition class Drupal\core_fake\Driver\Database\CoreFakeWithAllCustomClasses core/tests/fixtures/database_drivers/module/core_fake/src/Driver/Database/CoreFakeWithAllCustomClasses/Condition.php CoreFakeWithAllCustomClasses implementation of \Drupal\Core\Database\Condition.
Condition class Drupal\Core\Config\Entity\Query core/lib/Drupal/Core/Config/Entity/Query/Condition.php Defines the condition class for the config entity query. 1 1
Condition class Drupal\Core\Database\Query core/lib/Drupal/Core/Database/Query/Condition.php Generic class for a series of conditions in a query. 2 6
Condition class Drupal\Core\Entity\Query\Sql core/lib/Drupal/Core/Entity/Query/Sql/Condition.php Implements entity query conditions for SQL databases. 2 2
Condition

in drupal:11.2.0 and is removed from drupal:12.0.0. The PostgreSQL override of the entity query has been moved to the pgsql module.

 class Drupal\Core\Entity\Query\Sql\pgsql core/lib/Drupal/Core/Entity/Query/Sql/pgsql/Condition.php Implements entity query conditions for PostgreSQL databases.
Condition class Drupal\Core\Entity\Query\Null core/lib/Drupal/Core/Entity/Query/Null/Condition.php Defines the condition class for the null entity query.
Condition class Drupal\pgsql\EntityQuery core/modules/pgsql/src/EntityQuery/Condition.php Implements entity query conditions for PostgreSQL databases.
ConditionAccessResolverTrait trait Drupal\Core\Condition core/lib/Drupal/Core/Condition/ConditionAccessResolverTrait.php Resolves a set of conditions. 1
ConditionAccessResolverTraitTest class Drupal\Tests\Core\Condition core/tests/Drupal/Tests/Core/Condition/ConditionAccessResolverTraitTest.php @coversDefaultClass \Drupal\Core\Condition\ConditionAccessResolverTrait[[api-linebreak]] @group Condition
ConditionAggregate class Drupal\Core\Entity\Query\Sql core/lib/Drupal/Core/Entity/Query/Sql/ConditionAggregate.php Defines the aggregate condition for sql based storage. 1
ConditionAggregateBase abstract class Drupal\Core\Entity\Query core/lib/Drupal/Core/Entity/Query/ConditionAggregateBase.php A common base class for all aggregation entity condition implementations. 1 1
ConditionAggregateInterface interface Drupal\Core\Entity\Query core/lib/Drupal/Core/Entity/Query/ConditionAggregateInterface.php Defines aggregated entity query conditions. 1 1

Other projects

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