Classes, traits, and interfaces - 8.9.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 1511

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
EntityChangedInterface interface Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityChangedInterface.php Defines an interface for entity change timestamp tracking. 12 20
EntityChangedTrait trait Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityChangedTrait.php Provides a trait for accessing changed time. 6
EntityChangesDetectionTrait trait Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityChangesDetectionTrait.php Provides helper methods to detect changes in an entity object. 2
EntityComment class Drupal\comment\Plugin\migrate\destination core/modules/comment/src/Plugin/migrate/destination/EntityComment.php Plugin annotation @MigrateDestination( id = "entity:comment" )
EntityCommentType class Drupal\comment\Plugin\migrate\destination core/modules/comment/src/Plugin/migrate/destination/EntityCommentType.php Plugin annotation @MigrateDestination( id = "entity:comment_type" )
EntityCondition class Drupal\jsonapi\Query core/modules/jsonapi/src/Query/EntityCondition.php A condition object for the EntityQuery. 2
EntityConditionGroup class Drupal\jsonapi\Query core/modules/jsonapi/src/Query/EntityConditionGroup.php A condition group for the EntityQuery. 2
EntityConditionGroupTest class Drupal\Tests\jsonapi\Unit\Query core/modules/jsonapi/tests/src/Unit/Query/EntityConditionGroupTest.php @coversDefaultClass \Drupal\jsonapi\Query\EntityConditionGroup @group jsonapi
EntityConditionTest class Drupal\Tests\jsonapi\Unit\Query core/modules/jsonapi/tests/src/Unit/Query/EntityConditionTest.php @coversDefaultClass \Drupal\jsonapi\Query\EntityCondition @group jsonapi
EntityConfigBase class Drupal\migrate\Plugin\migrate\destination core/modules/migrate/src/Plugin/migrate/destination/EntityConfigBase.php Base destination class for importing configuration entities. 11 8
EntityConfirmFormBase abstract class Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityConfirmFormBase.php Provides a generic base class for an entity-based confirmation form. 7 6
EntityConstraintViolationList class Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityConstraintViolationList.php Implements an entity constraint violation list. 3
EntityConstraintViolationListInterface interface Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityConstraintViolationListInterface.php Interface for the result of entity validation. 1 10
EntityConstraintViolationListTest class Drupal\Tests\Core\Entity core/tests/Drupal/Tests/Core/Entity/EntityConstraintViolationListTest.php @coversDefaultClass \Drupal\Core\Entity\EntityConstraintViolationList @group entity
EntityContentBase class Drupal\migrate\Plugin\migrate\destination core/modules/migrate/src/Plugin/migrate/destination/EntityContentBase.php Provides destination class for all content entities lacking a specific class. 8 9
EntityContentBaseTest class Drupal\Tests\migrate\Unit\Plugin\migrate\destination core/modules/migrate/tests/src/Unit/Plugin/migrate/destination/EntityContentBaseTest.php Tests base entity migration destination functionality.
EntityContentBaseTest class Drupal\Tests\migrate_drupal\Kernel\d6 core/modules/migrate_drupal/tests/src/Kernel/d6/EntityContentBaseTest.php @group migrate_drupal
EntityContentComplete class Drupal\migrate\Plugin\migrate\destination core/modules/migrate/src/Plugin/migrate/destination/EntityContentComplete.php Provides a destination for migrating the entire entity revision table. 2
EntityContext class Drupal\Core\Plugin\Context core/lib/Drupal/Core/Plugin/Context/EntityContext.php Class to provide a specific entity context. 17
EntityContextDefinition class Drupal\Core\Plugin\Context core/lib/Drupal/Core/Plugin/Context/EntityContextDefinition.php Defines a class to provide entity context definitions. 14
EntityContextDefinitionDeprecationTest class Drupal\Tests\Core\Plugin\Context core/tests/Drupal/Tests/Core/Plugin/Context/EntityContextDefinitionDeprecationTest.php Test deprecated use of ContextDefinition as an EntityContextDefinition.
EntityContextDefinitionIsSatisfiedTest class Drupal\Tests\Core\Plugin\Context core/tests/Drupal/Tests/Core/Plugin/Context/EntityContextDefinitionIsSatisfiedTest.php @coversDefaultClass \Drupal\Core\Plugin\Context\EntityContextDefinition @group Plugin
EntityContextTypedDataTest class Drupal\KernelTests\Core\Plugin core/tests/Drupal/KernelTests/Core/Plugin/EntityContextTypedDataTest.php Tests the interaction between entity context and typed data.
EntityController class Drupal\Core\Entity\Controller core/lib/Drupal/Core/Entity/Controller/EntityController.php Provides the add-page and title callbacks for entities. 1
EntityConverter class Drupal\Core\ParamConverter core/lib/Drupal/Core/ParamConverter/EntityConverter.php Parameter converter for upcasting entity IDs to full objects. 3 3 2
EntityConverterLatestRevisionTest class Drupal\KernelTests\Core\ParamConverter core/tests/Drupal/KernelTests/Core/ParamConverter/EntityConverterLatestRevisionTest.php Tests the entity converter when the "load_latest_revision" flag is set.
EntityConverterTest class Drupal\Tests\Core\ParamConverter core/tests/Drupal/Tests/Core/ParamConverter/EntityConverterTest.php @coversDefaultClass \Drupal\Core\ParamConverter\EntityConverter @group ParamConverter @group Entity
EntityCreateAccessCheck class Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityCreateAccessCheck.php Defines an access checker for entity creation. 1 2
EntityCreateAccessCheckTest class Drupal\Tests\Core\Entity core/tests/Drupal/Tests/Core/Entity/EntityCreateAccessCheckTest.php @coversDefaultClass \Drupal\Core\Entity\EntityCreateAccessCheck
EntityCreateAnyAccessCheck class Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityCreateAnyAccessCheck.php Defines an access checker for creating an entity of any bundle. 2
EntityCrudHookTest class Drupal\KernelTests\Core\Entity core/tests/Drupal/KernelTests/Core/Entity/EntityCrudHookTest.php Tests the invocation of hooks when creating, inserting, loading, updating or deleting an entity.
EntityDataDefinition class Drupal\Core\Entity\TypedData core/lib/Drupal/Core/Entity/TypedData/EntityDataDefinition.php A typed data definition class for describing entities. 5
EntityDataDefinitionInterface interface Drupal\Core\Entity\TypedData core/lib/Drupal/Core/Entity/TypedData/EntityDataDefinitionInterface.php Interface for typed data entity definitions. 1 4
EntityDateFormat class Drupal\system\Plugin\migrate\destination core/modules/system/src/Plugin/migrate/destination/EntityDateFormat.php Plugin annotation @MigrateDestination( id = "entity:date_format" )
EntityDecoupledTranslationRevisionsTest class Drupal\KernelTests\Core\Entity core/tests/Drupal/KernelTests/Core/Entity/EntityDecoupledTranslationRevisionsTest.php Test decoupled translation revisions.
EntityDefaultLanguageTest class Drupal\Tests\language\Kernel core/modules/language/tests/src/Kernel/EntityDefaultLanguageTest.php Tests default language code is properly generated for entities.
EntityDefinitionTestTrait

in drupal:8.6.0 and is removed from drupal:9.0.0. Use \Drupal\Tests\system\Functional\Entity\Traits\EntityDefinitionTestTrait.

trait Drupal\system\Tests\Entity core/modules/system/src/Tests/Entity/EntityDefinitionTestTrait.php Provides some test methods used to update existing entity definitions.
EntityDefinitionTestTrait trait Drupal\Tests\system\Functional\Entity\Traits core/modules/system/tests/src/Functional/Entity/Traits/EntityDefinitionTestTrait.php Provides some test methods used to update existing entity definitions. 16
EntityDefinitionUpdateManager class Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityDefinitionUpdateManager.php Manages entity definition updates. 1 2
EntityDefinitionUpdateManagerInterface interface Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityDefinitionUpdateManagerInterface.php Defines an interface for managing entity definition updates. 1 5
EntityDefinitionUpdateManagerTest class Drupal\Tests\Core\Entity core/tests/Drupal/Tests/Core/Entity/EntityDefinitionUpdateManagerTest.php @coversDefaultClass \Drupal\Core\Entity\EntityDefinitionUpdateManager @group Entity @group legacy
EntityDefinitionUpdateTest class Drupal\KernelTests\Core\Entity core/tests/Drupal/KernelTests/Core/Entity/EntityDefinitionUpdateTest.php Tests EntityDefinitionUpdateManager functionality.
EntityDeleteActionDeriver class Drupal\Core\Action\Plugin\Action\Derivative core/lib/Drupal/Core/Action/Plugin/Action/Derivative/EntityDeleteActionDeriver.php Provides an action deriver that finds entity types with delete form. 1
EntityDeleteForm class Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityDeleteForm.php Provides a generic base class for an entity deletion form. 14 14
EntityDeleteFormTrait trait Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityDeleteFormTrait.php Provides a trait for an entity deletion form.
EntityDeleteMultipleAccessCheck class Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityDeleteMultipleAccessCheck.php Checks if the current user has delete access to the items of the tempstore. 2
EntityDenormalizerBase abstract class Drupal\jsonapi\Normalizer core/modules/jsonapi/src/Normalizer/EntityDenormalizerBase.php Converts the Drupal entity object to a JSON:API array structure. 2
EntityDeriver class Drupal\Core\Entity\Plugin\DataType\Deriver core/lib/Drupal/Core/Entity/Plugin/DataType/Deriver/EntityDeriver.php Provides data type plugins for each existing entity type and bundle.
EntityDeriver class Drupal\rest\Plugin\Deriver core/modules/rest/src/Plugin/Deriver/EntityDeriver.php Provides a resource plugin definition for every entity type.
EntityDeriverTest class Drupal\KernelTests\Core\Entity core/tests/Drupal/KernelTests/Core/Entity/EntityDeriverTest.php Tests EntityDeriver functionality.

Other projects


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