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

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
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
ConfigEntityBundleBase abstract class Drupal\Core\Config\Entity core/lib/Drupal/Core/Config/Entity/ConfigEntityBundleBase.php A base class for config entity types that act as bundles. 9 9
ConfigEntityDenormalizer final class Drupal\jsonapi\Normalizer core/modules/jsonapi/src/Normalizer/ConfigEntityDenormalizer.php Converts the Drupal config entity object to a JSON:API array structure. 2
ConfigEntityDependency class Drupal\Core\Config\Entity core/lib/Drupal/Core/Config/Entity/ConfigEntityDependency.php Provides a value object to discover configuration dependencies. 3
ConfigEntityDependencyTest class Drupal\Tests\Core\Config\Entity core/tests/Drupal/Tests/Core/Config/Entity/ConfigEntityDependencyTest.php Tests the ConfigEntityDependency class.
ConfigEntityFormOverrideTest class Drupal\Tests\config\Functional core/modules/config/tests/src/Functional/ConfigEntityFormOverrideTest.php Tests that config overrides do not bleed through in entity forms and lists.
ConfigEntityIdLengthException class Drupal\Core\Config\Entity\Exception core/lib/Drupal/Core/Config/Entity/Exception/ConfigEntityIdLengthException.php Defines an exception thrown when a configuration entity ID is too long. 5
ConfigEntityImportTest class Drupal\Tests\system\Kernel\Entity core/modules/system/tests/src/Kernel/Entity/ConfigEntityImportTest.php Tests ConfigEntity importing.
ConfigEntityInterface interface Drupal\Core\Config\Entity core/lib/Drupal/Core/Config/Entity/ConfigEntityInterface.php Defines a common interface for configuration entities. 31 70
ConfigEntityListBuilder class Drupal\Core\Config\Entity core/lib/Drupal/Core/Config/Entity/ConfigEntityListBuilder.php Defines the default class to build a listing of configuration entities. 20 19
ConfigEntityListMultilingualTest class Drupal\Tests\config\Functional core/modules/config/tests/src/Functional/ConfigEntityListMultilingualTest.php Tests the listing of configuration entities in a multilingual scenario.
ConfigEntityListTest class Drupal\Tests\config\Functional core/modules/config/tests/src/Functional/ConfigEntityListTest.php Tests the listing of configuration entities.
ConfigEntityMapper class Drupal\config_translation core/modules/config_translation/src/ConfigEntityMapper.php Configuration mapper for configuration entities. 2 2
ConfigEntityMapperInterface interface Drupal\config_translation core/modules/config_translation/src/ConfigEntityMapperInterface.php Defines an interface for configuration entity mappers. 1 1
ConfigEntityMapperTest class Drupal\Tests\config_translation\Unit core/modules/config_translation/tests/src/Unit/ConfigEntityMapperTest.php Tests the functionality provided by the configuration entity mapper.
ConfigEntityNormalizer class Drupal\serialization\Normalizer core/modules/serialization/src/Normalizer/ConfigEntityNormalizer.php Normalizes/denormalizes Drupal config entity objects into an array structure. 1 2 2
ConfigEntityNormalizerTest class Drupal\Tests\serialization\Unit\Normalizer core/modules/serialization/tests/src/Unit/Normalizer/ConfigEntityNormalizerTest.php @coversDefaultClass \Drupal\serialization\Normalizer\ConfigEntityNormalizer @group serialization
ConfigEntityNormalizeTest class Drupal\KernelTests\Core\Config core/tests/Drupal/KernelTests/Core/Config/ConfigEntityNormalizeTest.php Tests the listing of configuration entities.
ConfigEntityQueryTest class Drupal\KernelTests\Core\Entity core/tests/Drupal/KernelTests/Core/Entity/ConfigEntityQueryTest.php Tests Config Entity Query functionality.
ConfigEntityResourceTestBase abstract class Drupal\Tests\jsonapi\Functional core/modules/jsonapi/tests/src/Functional/ConfigEntityResourceTestBase.php Resource test base class for config entities. 32 3
ConfigEntityResourceTestBase abstract class Drupal\Tests\rest\Functional\EntityResource core/modules/rest/tests/src/Functional/EntityResource/ConfigEntityResourceTestBase.php Resource test base class for config entities. 37 38
ConfigEntityStaticCacheTest class Drupal\KernelTests\Core\Config core/tests/Drupal/KernelTests/Core/Config/ConfigEntityStaticCacheTest.php Tests the entity static cache when used by config entities.
ConfigEntityStatusTest class Drupal\KernelTests\Core\Config core/tests/Drupal/KernelTests/Core/Config/ConfigEntityStatusTest.php Tests configuration entity status functionality.
ConfigEntityStatusUITest class Drupal\Tests\config\Functional core/modules/config/tests/src/Functional/ConfigEntityStatusUITest.php Tests configuration entity status UI functionality.
ConfigEntityStorage class Drupal\Core\Config\Entity core/lib/Drupal/Core/Config/Entity/ConfigEntityStorage.php Defines the storage class for configuration entities. 9 16
ConfigEntityStorageClassException class Drupal\Core\Config\Entity\Exception core/lib/Drupal/Core/Config/Entity/Exception/ConfigEntityStorageClassException.php Thrown when a storage class is not an instance of ConfigEntityStorage. 2
ConfigEntityStorageInterface interface Drupal\Core\Config\Entity core/lib/Drupal/Core/Config/Entity/ConfigEntityStorageInterface.php Provides an interface for configuration entity storage. 5 8
ConfigEntityStorageTest class Drupal\Tests\Core\Config\Entity core/tests/Drupal/Tests/Core/Config/Entity/ConfigEntityStorageTest.php @coversDefaultClass \Drupal\Core\Config\Entity\ConfigEntityStorage @group Config
ConfigEntityStorageTest class Drupal\KernelTests\Core\Config core/tests/Drupal/KernelTests/Core/Config/ConfigEntityStorageTest.php Tests configuration entity storage.
ConfigEntityTest class Drupal\Tests\config\FunctionalJavascript core/modules/config/tests/src/FunctionalJavascript/ConfigEntityTest.php Tests the Config operations through the UI.
ConfigEntityTest class Drupal\Tests\config\Functional core/modules/config/tests/src/Functional/ConfigEntityTest.php Tests configuration entities.
ConfigEntityType class Drupal\Core\Config\Entity core/lib/Drupal/Core/Config/Entity/ConfigEntityType.php Provides an implementation of a configuration entity type and its metadata. 5
ConfigEntityType class Drupal\Core\Entity\Annotation core/lib/Drupal/Core/Entity/Annotation/ConfigEntityType.php Defines a config entity type annotation object.
ConfigEntityTypeInterface interface Drupal\Core\Config\Entity core/lib/Drupal/Core/Config/Entity/ConfigEntityTypeInterface.php Provides an interface for a configuration entity type and its metadata. 1 12
ConfigEntityTypeTest class Drupal\Tests\Core\Config\Entity core/tests/Drupal/Tests/Core/Config/Entity/ConfigEntityTypeTest.php @coversDefaultClass \Drupal\Core\Config\Entity\ConfigEntityType @group Config
ConfigEntityUnitTest class Drupal\KernelTests\Core\Config core/tests/Drupal/KernelTests/Core/Config/ConfigEntityUnitTest.php Unit tests for configuration entity base methods.
ConfigEntityUpdater class Drupal\Core\Config\Entity core/lib/Drupal/Core/Config/Entity/ConfigEntityUpdater.php A utility class to make updating configuration entities simple. 18
ConfigEntityUpdaterTest class Drupal\KernelTests\Core\Config\Entity core/tests/Drupal/KernelTests/Core/Config/Entity/ConfigEntityUpdaterTest.php Tests \Drupal\Core\Config\Entity\ConfigEntityUpdater.
ConfigEntityValidationTestBase abstract class Drupal\KernelTests\Core\Config core/tests/Drupal/KernelTests/Core/Config/ConfigEntityValidationTestBase.php Base class for testing validation of config entities. 31 31
ConfigEvents final class Drupal\Core\Config core/lib/Drupal/Core/Config/ConfigEvents.php Defines events for the configuration system. 24
ConfigEventsTest class Drupal\KernelTests\Core\Config core/tests/Drupal/KernelTests/Core/Config/ConfigEventsTest.php Tests events fired on configuration objects.
ConfigException class Drupal\Core\Config core/lib/Drupal/Core/Config/ConfigException.php A base exception thrown in any configuration system operations. 13 3
ConfigExistsConstraint class Drupal\Core\Config\Plugin\Validation\Constraint core/lib/Drupal/Core/Config/Plugin/Validation/Constraint/ConfigExistsConstraint.php Checks that the value is the name of an existing config object.
ConfigExistsConstraintValidator class Drupal\Core\Config\Plugin\Validation\Constraint core/lib/Drupal/Core/Config/Plugin/Validation/Constraint/ConfigExistsConstraintValidator.php Validates that a given config object exists.
ConfigExistsConstraintValidatorTest class Drupal\KernelTests\Core\Config core/tests/Drupal/KernelTests/Core/Config/ConfigExistsConstraintValidatorTest.php Tests the ConfigExists constraint validator.
ConfigExportForm class Drupal\config\Form core/modules/config/src/Form/ConfigExportForm.php Defines the configuration export form. 1
ConfigExportImportUITest class Drupal\Tests\config\Functional core/modules/config/tests/src/Functional/ConfigExportImportUITest.php Tests the user interface for importing/exporting configuration.
ConfigExportStorageTest class Drupal\KernelTests\Core\Config core/tests/Drupal/KernelTests/Core/Config/ConfigExportStorageTest.php Tests configuration export storage.
ConfigExportTest class Drupal\Tests\config\FunctionalJavascript core/modules/config/tests/src/FunctionalJavascript/ConfigExportTest.php Tests the config export form.
ConfigExportUITest class Drupal\Tests\config\Functional core/modules/config/tests/src/Functional/ConfigExportUITest.php Tests the user interface for exporting configuration.

Other projects


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