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

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
EntityTranslationRenderTrait trait Drupal\views\Entity\Render core/modules/views/src/Entity/Render/EntityTranslationRenderTrait.php Trait used to instantiate the view's entity translation renderer. 6
EntityTranslationSettings class Drupal\content_translation\Plugin\migrate\source\d7 core/modules/content_translation/src/Plugin/migrate/source/d7/EntityTranslationSettings.php Drupal 7 Entity Translation settings (variables) from database. 1
EntityTranslationSettingsTest class Drupal\Tests\content_translation\Kernel\Plugin\migrate\source\d7 core/modules/content_translation/tests/src/Kernel/Plugin/migrate/source/d7/EntityTranslationSettingsTest.php Tests entity translation settings source plugin.
EntityTranslationTest class Drupal\KernelTests\Core\Entity core/tests/Drupal/KernelTests/Core/Entity/EntityTranslationTest.php Tests entity translation functionality.
EntityType class Drupal\Core\Entity\Attribute core/lib/Drupal/Core/Entity/Attribute/EntityType.php Defines an entity type for plugin discovery. 2 2
EntityType class Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityType.php Provides an implementation of an entity type and its metadata. 2 13
EntityType class Drupal\Core\Entity\Annotation core/lib/Drupal/Core/Entity/Annotation/EntityType.php Defines an Entity type annotation object. 2
EntityTypeBundleInfo class Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityTypeBundleInfo.php Provides discovery and retrieval of entity type bundles. 1 2
EntityTypeBundleInfoInterface interface Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityTypeBundleInfoInterface.php Provides an interface for an entity type bundle info. 1 82
EntityTypeBundleInfoTest class Drupal\Tests\Core\Entity core/tests/Drupal/Tests/Core/Entity/EntityTypeBundleInfoTest.php Tests Drupal\Core\Entity\EntityTypeBundleInfo.
EntityTypeConstraint class Drupal\Core\Entity\Plugin\Validation\Constraint core/lib/Drupal/Core/Entity/Plugin/Validation/Constraint/EntityTypeConstraint.php Checks if a value is a valid entity type.
EntityTypeConstraintsTest class Drupal\KernelTests\Core\Entity core/tests/Drupal/KernelTests/Core/Entity/EntityTypeConstraintsTest.php Tests entity level validation constraints.
EntityTypeConstraintValidator class Drupal\Core\Entity\Plugin\Validation\Constraint core/lib/Drupal/Core/Entity/Plugin/Validation/Constraint/EntityTypeConstraintValidator.php Validates the EntityType constraint.
EntityTypeConstraintValidatorTest class Drupal\KernelTests\Core\Entity core/tests/Drupal/KernelTests/Core/Entity/EntityTypeConstraintValidatorTest.php Tests validation constraints for EntityTypeConstraintValidator.
EntityTypedDataDefinitionTest class Drupal\KernelTests\Core\Entity core/tests/Drupal/KernelTests/Core/Entity/EntityTypedDataDefinitionTest.php Tests deriving metadata of entity and field data types.
EntityTypeEvent class Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityTypeEvent.php Defines a base class for all entity type events. 1
EntityTypeEvents final class Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityTypeEvents.php Contains all events thrown while handling entity types. 3
EntityTypeEventSubscriberTrait trait Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityTypeEventSubscriberTrait.php Helper methods for EntityTypeListenerInterface. 4
EntityTypeIdLengthException class Drupal\Core\Entity\Exception core/lib/Drupal/Core/Entity/Exception/EntityTypeIdLengthException.php Defines an exception thrown when an entity ID is too long. 2
EntityTypeInfo class Drupal\content_moderation core/modules/content_moderation/src/EntityTypeInfo.php Manipulates entity type information. 2
EntityTypeInfo class Drupal\workspaces\Hook core/modules/workspaces/src/Hook/EntityTypeInfo.php Defines a class for reacting to entity type information hooks.
EntityTypeInfoTest class Drupal\Tests\content_moderation\Kernel core/modules/content_moderation/tests/src/Kernel/EntityTypeInfoTest.php Tests Drupal\content_moderation\EntityTypeInfo.
EntityTypeInterface interface Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityTypeInterface.php Provides an interface for an entity type and its metadata. 3 268
EntityTypeListener class Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityTypeListener.php Reacts to entity type CRUD on behalf of the Entity system. 2
EntityTypeListenerInterface interface Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityTypeListenerInterface.php Interface for entity type create, delete and update operations. 6 5
EntityTypeManager class Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityTypeManager.php Manages entity type plugin definitions. 1 8 2
EntityTypeManagerInterface interface Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityTypeManagerInterface.php Provides an interface for entity type managers. 1 441
EntityTypeManagerTest class Drupal\Tests\Core\Entity core/tests/Drupal/Tests/Core/Entity/EntityTypeManagerTest.php Tests Drupal\Core\Entity\EntityTypeManager.
EntityTypeManagerTestEntity abstract class Drupal\Tests\Core\Entity core/tests/Drupal/Tests/Core/Entity/EntityFieldManagerTest.php Provides a content entity with dummy static method implementations. 1
EntityTypeManagerTestEntityBundle abstract class Drupal\Tests\Core\Entity core/tests/Drupal/Tests/Core/Entity/EntityFieldManagerTest.php Provides a bundle specific class with dummy static method implementations.
EntityTypeRepository class Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityTypeRepository.php Provides helper methods for loading entity types. 1 2
EntityTypeRepositoryInterface interface Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityTypeRepositoryInterface.php Provides an interface for helper methods for loading entity types. 1 11
EntityTypeRepositoryTest class Drupal\Tests\Core\Entity core/tests/Drupal/Tests/Core/Entity/EntityTypeRepositoryTest.php Tests Drupal\Core\Entity\EntityTypeRepository.
EntityTypeTest class Drupal\Tests\Core\Entity core/tests/Drupal/Tests/Core/Entity/EntityTypeTest.php Tests Drupal\Core\Entity\EntityType.
EntityTypeTest class Drupal\KernelTests\Core\Entity core/tests/Drupal/KernelTests/Core/Entity/EntityTypeTest.php Tests general features of entity types.
EntityTypeWithoutLanguageFormTest class Drupal\Tests\language\Functional core/modules/language/tests/src/Functional/EntityTypeWithoutLanguageFormTest.php Tests entity type without language support.
EntityTypeWithoutViewsDataTest class Drupal\Tests\datetime_range\Kernel\Views core/modules/datetime_range/tests/src/Kernel/Views/EntityTypeWithoutViewsDataTest.php Tests datetime_range.module when an entity type provides no views data.
EntityUnitTest class Drupal\Tests\Core\Entity core/tests/Drupal/Tests/Core/Entity/EntityUnitTest.php Tests Drupal\Core\Entity\EntityBase.
EntityUntranslatableFieldsConstraint class Drupal\Core\Entity\Plugin\Validation\Constraint core/lib/Drupal/Core/Entity/Plugin/Validation/Constraint/EntityUntranslatableFieldsConstraint.php Validation constraint for the entity changed timestamp.
EntityUntranslatableFieldsConstraintValidator class Drupal\Core\Entity\Plugin\Validation\Constraint core/lib/Drupal/Core/Entity/Plugin/Validation/Constraint/EntityUntranslatableFieldsConstraintValidator.php Validates the EntityChanged constraint.
EntityUpdateInitialTest class Drupal\Tests\system\Functional\UpdateSystem core/modules/system/tests/src/Functional/UpdateSystem/EntityUpdateInitialTest.php Tests handling of existing initial keys during updates.
EntityUpdateTest class Drupal\Tests\editor\Kernel core/modules/editor/tests/src/Kernel/EntityUpdateTest.php Tests updating an entity.
EntityUrlLanguageTest class Drupal\Tests\language\Kernel core/modules/language/tests/src/Kernel/EntityUrlLanguageTest.php Tests the language of entity URLs.
EntityUrlTest class Drupal\Tests\Core\Entity core/tests/Drupal/Tests/Core/Entity/EntityUrlTest.php Tests URL handling of the \Drupal\Core\Entity\EntityBase class.
EntityUser class Drupal\user\Plugin\migrate\destination core/modules/user/src/Plugin/migrate/destination/EntityUser.php Provides a destination plugin for migrating user entities.
EntityUserRole

in drupal:11.3.0 and is removed from drupal:12.0.0. There is no replacement.

class Drupal\user\Plugin\migrate\destination core/modules/user/src/Plugin/migrate/destination/EntityUserRole.php Provides a destination plugin for migrating user role entities.
EntityUuidConverter class Drupal\jsonapi\ParamConverter core/modules/jsonapi/src/ParamConverter/EntityUuidConverter.php Parameter converter for upcasting entity UUIDs to full objects. 2
EntityUuidIdTest class Drupal\FunctionalTests\Entity core/tests/Drupal/FunctionalTests/Entity/EntityUuidIdTest.php Tests that an entity with a UUID as ID can be managed.
EntityUUIDTest class Drupal\KernelTests\Core\Entity core/tests/Drupal/KernelTests/Core/Entity/EntityUUIDTest.php Tests creation, saving, and loading of entity UUIDs.
EntityValidationException class Drupal\migrate\Exception core/modules/migrate/src/Exception/EntityValidationException.php To throw when an entity generated during the import is not valid. 1

Other projects


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