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
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\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.
Config class Drupal\Core\Config core/lib/Drupal/Core/Config/Config.php Defines the default configuration object. 1 27
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. 16
ConfigActionAttributeTest class Drupal\Tests\Core\Config\Action core/tests/Drupal/Tests/Core/Config/Action/ConfigActionAttributeTest.php @coversDefaultClass \Drupal\Core\Config\Action\Attribute\ConfigAction[[api-linebreak]] @group Config
ConfigActionException final class Drupal\Core\Config\Action core/lib/Drupal/Core/Config/Action/ConfigActionException.php @internal This API is experimental. 24
ConfigActionManager class Drupal\Core\Config\Action core/lib/Drupal/Core/Config/Action/ConfigActionManager.php 12 2
ConfigActionPluginInterface interface Drupal\Core\Config\Action core/lib/Drupal/Core/Config/Action/ConfigActionPluginInterface.php @internal This API is experimental. 14 14
ConfigActionsTest class Drupal\Tests\block\Kernel core/modules/block/tests/src/Kernel/ConfigActionsTest.php @covers \Drupal\block\Plugin\ConfigAction\PlaceBlock[[api-linebreak]] @covers \Drupal\block\Plugin\ConfigAction\PlaceBlockDeriver[[api-linebreak]] @group block
ConfigActionsTest class Drupal\Tests\image\Kernel core/modules/image/tests/src/Kernel/ConfigActionsTest.php @group image
ConfigActionsTest class Drupal\Tests\media\Kernel core/modules/media/tests/src/Kernel/ConfigActionsTest.php @group media
ConfigActionsTest class Drupal\Tests\language\Kernel core/modules/language/tests/src/Kernel/ConfigActionsTest.php @group language
ConfigActionsTest class Drupal\Tests\node\Kernel core/modules/node/tests/src/Kernel/ConfigActionsTest.php @group node
ConfigActionsTest class Drupal\Tests\field\Kernel core/modules/field/tests/src/Kernel/ConfigActionsTest.php @group field
ConfigActionsTest class Drupal\Tests\layout_builder\Kernel core/modules/layout_builder/tests/src/Kernel/ConfigActionsTest.php @group Recipe
ConfigActionsTest class Drupal\Tests\contact\Kernel core/modules/contact/tests/src/Kernel/ConfigActionsTest.php @group contact
ConfigActionTest class Drupal\KernelTests\Core\Config\Action core/tests/Drupal/KernelTests/Core/Config/Action/ConfigActionTest.php Tests the config action system.
ConfigActionValidationTest class Drupal\KernelTests\Core\Recipe core/tests/Drupal/KernelTests/Core/Recipe/ConfigActionValidationTest.php @group Recipe
ConfigAfterInstallerTestBase abstract class Drupal\FunctionalTests\Installer core/tests/Drupal/FunctionalTests/Installer/ConfigAfterInstallerTestBase.php Provides a class for install profiles to check their installed config. 2
ConfigBase abstract class Drupal\Core\Config core/lib/Drupal/Core/Config/ConfigBase.php Provides a base class for configuration objects with get/set support. 2 1
ConfigCacheTag class Drupal\system\EventSubscriber core/modules/system/src/EventSubscriber/ConfigCacheTag.php A subscriber invalidating cache tags when system config objects are saved. 2
ConfigCollectionEvents final class Drupal\Core\Config core/lib/Drupal/Core/Config/ConfigCollectionEvents.php Defines events for working with configuration collections. 8
ConfigCollectionInfo class Drupal\Core\Config core/lib/Drupal/Core/Config/ConfigCollectionInfo.php Gets information on all the possible configuration collections. 3
ConfigConfigurator final class Drupal\Core\Recipe core/lib/Drupal/Core/Recipe/ConfigConfigurator.php @internal This API is experimental.
ConfigConfiguratorTest class Drupal\KernelTests\Core\Recipe core/tests/Drupal/KernelTests/Core/Recipe/ConfigConfiguratorTest.php @covers \Drupal\Core\Recipe\ConfigConfigurator[[api-linebreak]] @group Recipe
ConfigController class Drupal\config\Controller core/modules/config/src/Controller/ConfigController.php Returns responses for config module routes.
ConfigCrudEvent class Drupal\Core\Config core/lib/Drupal/Core/Config/ConfigCrudEvent.php Wraps a configuration event for event listeners. 1 23
ConfigCRUDTest class Drupal\KernelTests\Core\Config core/tests/Drupal/KernelTests/Core/Config/ConfigCRUDTest.php Tests CRUD operations on configuration objects.
ConfigDependencies class Drupal\rest\Entity core/modules/rest/src/Entity/ConfigDependencies.php Calculates rest resource config dependencies. 1
ConfigDependenciesTest class Drupal\Tests\rest\Kernel\Entity core/modules/rest/tests/src/Kernel/Entity/ConfigDependenciesTest.php @coversDefaultClass \Drupal\rest\Entity\ConfigDependencies[[api-linebreak]]
ConfigDependencyDeleteFormTrait trait Drupal\Core\Config\Entity core/lib/Drupal/Core/Config/Entity/ConfigDependencyDeleteFormTrait.php Lists affected configuration entities by a dependency removal. 2
ConfigDependencyManager class Drupal\Core\Config\Entity core/lib/Drupal/Core/Config/Entity/ConfigDependencyManager.php Provides a class to discover configuration entity dependencies. 6
ConfigDependencyManagerTest class Drupal\Tests\Core\Config core/tests/Drupal/Tests/Core/Config/ConfigDependencyManagerTest.php Tests the ConfigDependencyManager class.
ConfigDependencyManagerTest class Drupal\Tests\Core\Config\Entity core/tests/Drupal/Tests/Core/Config/Entity/ConfigDependencyManagerTest.php Tests the ConfigDependencyManager class.
ConfigDependencyTest class Drupal\KernelTests\Core\Config core/tests/Drupal/KernelTests/Core/Config/ConfigDependencyTest.php Tests for configuration dependencies.
ConfigDependencyWebTest class Drupal\Tests\config\Functional core/modules/config/tests/src/Functional/ConfigDependencyWebTest.php Tests configuration entities.
ConfigDiffTest class Drupal\KernelTests\Core\Config core/tests/Drupal/KernelTests/Core/Config/ConfigDiffTest.php Calculating the difference between two sets of configuration.
ConfigDirectoryNotDefinedException class Drupal\Core\Config core/lib/Drupal/Core/Config/ConfigDirectoryNotDefinedException.php An exception thrown when the config sync directory is not defined. 1
ConfigDraggableListBuilderTest class Drupal\Tests\config\Functional core/modules/config/tests/src/Functional/ConfigDraggableListBuilderTest.php Tests draggable list builder.
ConfigDuplicateUUIDException class Drupal\Core\Config core/lib/Drupal/Core/Config/ConfigDuplicateUUIDException.php Exception thrown when a config object UUID causes a conflict. 3
ConfigEntity class Drupal\migrate\Plugin\migrate\source core/modules/migrate/src/Plugin/migrate/source/ConfigEntity.php Drupal configuration source from database.
ConfigEntityAdapter class Drupal\Core\Entity\Plugin\DataType core/lib/Drupal/Core/Entity/Plugin/DataType/ConfigEntityAdapter.php Enhances EntityAdapter for config entities. 5
ConfigEntityAdapterTest class Drupal\KernelTests\Core\Entity core/tests/Drupal/KernelTests/Core/Entity/ConfigEntityAdapterTest.php Tests entity adapter for configuration entities.
ConfigEntityBase abstract class Drupal\Core\Config\Entity core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php Defines a base configuration entity class. 26 26
ConfigEntityBaseUnitTest class Drupal\Tests\Core\Config\Entity core/tests/Drupal/Tests/Core/Config/Entity/ConfigEntityBaseUnitTest.php @coversDefaultClass \Drupal\Core\Config\Entity\ConfigEntityBase[[api-linebreak]] @group Config
ConfigEntityBaseWithPluginCollections abstract class Drupal\Tests\Core\Config\Entity\Fixtures core/tests/Drupal/Tests/Core/Config/Entity/Fixtures/ConfigEntityBaseWithPluginCollections.php Enables testing of dependency calculation. 1 1

Other projects

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