Classes, traits, and interfaces - main - 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 1529

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
ComputedFileUrlTest class Drupal\Tests\file\Kernel core/modules/file/tests/src/Kernel/ComputedFileUrlTest.php Tests 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.
ConcreteWithAnnotationTest class Drupal\Tests\Core\Foo core/tests/PHPStan/fixtures/test-classes-with-metadata.php @group metadata
ConcreteWithAttributeTest class Drupal\Tests\Core\Foo core/tests/PHPStan/fixtures/test-classes-with-metadata.php #[Group('Test')]
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\pgsql\EntityQuery core/modules/pgsql/src/EntityQuery/Condition.php Implements entity query conditions for PostgreSQL databases.
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\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. 1 1
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\Core\Entity\KeyValueStore\Query core/lib/Drupal/Core/Entity/KeyValueStore/Query/Condition.php Defines the condition class for the key value entity query.
ConditionAccessResolverTrait trait Drupal\Core\Condition core/lib/Drupal/Core/Condition/ConditionAccessResolverTrait.php Resolves a set of conditions. 2
ConditionAccessResolverTraitTest class Drupal\Tests\Core\Condition core/tests/Drupal/Tests/Core/Condition/ConditionAccessResolverTraitTest.php Tests Drupal\Core\Condition\ConditionAccessResolverTrait.
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
ConditionBase abstract class Drupal\Core\Entity\Query core/lib/Drupal/Core/Entity/Query/ConditionBase.php Defines a common base class for all entity condition implementations. 3 3
ConditionFormTest class Drupal\Tests\system\Functional\Condition core/modules/system/tests/src/Functional/Condition/ConditionFormTest.php Tests that condition plugins basic form handling is working.
ConditionFundamentals abstract class Drupal\Core\Entity\Query core/lib/Drupal/Core/Entity/Query/ConditionFundamentals.php Common code for all implementations of the entity query condition interfaces. 2
ConditionInterface interface Drupal\Core\Entity\Query core/lib/Drupal/Core/Entity/Query/ConditionInterface.php Defines the entity query condition interface. 1 2
ConditionInterface interface Drupal\Core\Condition core/lib/Drupal/Core/Condition/ConditionInterface.php An interface for condition plugins. 1 1 1
ConditionInterface interface Drupal\Core\Database\Query core/lib/Drupal/Core/Database/Query/ConditionInterface.php Interface for a conditional clause in a query. 5 3
ConditionManager class Drupal\Core\Condition core/lib/Drupal/Core/Condition/ConditionManager.php A plugin manager for condition plugins. 2 2
ConditionPluginBase abstract class Drupal\Core\Condition core/lib/Drupal/Core/Condition/ConditionPluginBase.php Provides a basis for fulfilling contexts for condition plugins. 11 11
ConditionPluginCollection class Drupal\Core\Condition core/lib/Drupal/Core/Condition/ConditionPluginCollection.php Provides a collection of condition plugins. 2
ConditionPluginCollectionTest class Drupal\KernelTests\Core\Condition core/tests/Drupal/KernelTests/Core/Condition/ConditionPluginCollectionTest.php Tests Drupal\Core\Condition\ConditionPluginCollection.
ConditionTest class Drupal\Tests\Core\Database core/tests/Drupal/Tests/Core/Database/ConditionTest.php Tests Drupal\Core\Database\Query\Condition.
ConditionTestDualUser class Drupal\condition_test\Plugin\Condition core/modules/system/tests/modules/condition_test/src/Plugin/Condition/ConditionTestDualUser.php Provides a condition that requires two users.
ConditionTestDualUserTest class Drupal\KernelTests\Core\Plugin\Condition core/tests/Drupal/KernelTests/Core/Plugin/Condition/ConditionTestDualUserTest.php Tests a condition that requires two users.
ConditionTestNoExistingType class Drupal\condition_test\Plugin\Condition core/modules/system/tests/modules/condition_test/src/Plugin/Condition/ConditionTestNoExistingType.php Provides a condition that has a no existing context.
Config class Drupal\migrate\Plugin\migrate\destination core/modules/migrate/src/Plugin/migrate/destination/Config.php Provides Configuration Management destination plugin. 1 4
Config class Drupal\Core\Config core/lib/Drupal/Core/Config/Config.php Defines the default configuration object. 1 28
Config class Drupal\Composer\Plugin\VendorHardening composer/Plugin/VendorHardening/Config.php Determine configuration. 3
Config

in drupal:11.2.0 and is removed from drupal:12.0.0. Use \Drupal\migrate\Plugin\migrate\source\ConfigEntity instead.

Available configuration keys:

  • collections: (optional) The collection of configuration storage to retrieve from the source - can be a string or an array. If omitted, configuration objects of all available collections are retrieved.
  • names: (optional) Names of configuration objects to retrieve from the source - can be a string or an array. If omitted, all available configuration objects are retrieved.

Examples:

 class Drupal\migrate_drupal\Plugin\migrate\source\d8 core/modules/migrate_drupal/src/Plugin/migrate/source/d8/Config.php Drupal 8+ configuration source from database. 1
ConfigAccessTest class Drupal\Tests\settings_tray\FunctionalJavascript core/modules/settings_tray/tests/src/FunctionalJavascript/ConfigAccessTest.php Tests handling of configuration overrides.
ConfigAction final class Drupal\Core\Config\Action\Attribute core/lib/Drupal/Core/Config/Action/Attribute/ConfigAction.php Defines a ConfigAction attribute object. 17
ConfigActionAttributeTest class Drupal\Tests\Core\Config\Action core/tests/Drupal/Tests/Core/Config/Action/ConfigActionAttributeTest.php Tests Drupal\Core\Config\Action\Attribute\ConfigAction.
ConfigActionException final class Drupal\Core\Config\Action core/lib/Drupal/Core/Config/Action/ConfigActionException.php @internal This API is experimental. 26

Other projects

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