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
EntityConverterTest class Drupal\KernelTests\Core\ParamConverter core/tests/Drupal/KernelTests/Core/ParamConverter/EntityConverterTest.php Tests the entity param converter.
EntityConverterTest class Drupal\Tests\Core\ParamConverter core/tests/Drupal/Tests/Core/ParamConverter/EntityConverterTest.php @coversDefaultClass \Drupal\Core\ParamConverter\EntityConverter[[api-linebreak]] @group ParamConverter @group Entity
EntityCreate final class Drupal\Core\Config\Action\Plugin\ConfigAction core/lib/Drupal/Core/Config/Action/Plugin/ConfigAction/EntityCreate.php @internal This API is experimental.
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[[api-linebreak]]
EntityCreateAnyAccessCheck class Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityCreateAnyAccessCheck.php Defines an access checker for creating an entity of any bundle. 2
EntityCreateDeriver final class Drupal\Core\Config\Action\Plugin\ConfigAction\Deriver core/lib/Drupal/Core/Config/Action/Plugin/ConfigAction/Deriver/EntityCreateDeriver.php @internal This API is experimental. 1
EntityCrudHookTest class Drupal\KernelTests\Core\Entity core/tests/Drupal/KernelTests/Core/Entity/EntityCrudHookTest.php Tests entity CRUD via hooks.
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 Migration destination for date format entity.
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 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. 10
EntityDefinitionUpdateManager class Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityDefinitionUpdateManager.php Manages entity definition updates. 2
EntityDefinitionUpdateManagerInterface interface Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityDefinitionUpdateManagerInterface.php Defines an interface for managing entity definition updates. 1 9
EntityDefinitionUpdateProviderTest class Drupal\KernelTests\Core\Entity core/tests/Drupal/KernelTests/Core/Entity/EntityDefinitionUpdateProviderTest.php Tests EntityDefinitionUpdateManager functionality.
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. 2
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
EntityDeprecationTest class Drupal\KernelTests\Core\Entity core/tests/Drupal/KernelTests/Core/Entity/EntityDeprecationTest.php Tests the deprecations for the \Drupal\KernelTests\Core\Entity namespace.
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. 1
EntityDeriver class Drupal\rest\Plugin\Deriver core/modules/rest/src/Plugin/Deriver/EntityDeriver.php Provides a resource plugin definition for every entity type. 1
EntityDeriverTest class Drupal\KernelTests\Core\Entity core/tests/Drupal/KernelTests/Core/Entity/EntityDeriverTest.php Tests EntityDeriver functionality.
EntityDescriptionInterface interface Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityDescriptionInterface.php Defines the interface for entities that have a description. 3 4
EntityDisplayBase abstract class Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityDisplayBase.php Provides a common base class for entity view and form displays. 3 4
EntityDisplayBaseMockableClass class Drupal\Tests\Core\Config\Entity core/tests/Drupal/Tests/Core/Config/Entity/EntityDisplayBaseTest.php A class extending EntityDisplayBase for testing purposes.
EntityDisplayBaseTest class Drupal\KernelTests\Core\Entity core/tests/Drupal/KernelTests/Core/Entity/EntityDisplayBaseTest.php @coversDefaultClass \Drupal\Core\Entity\EntityDisplayBase[[api-linebreak]]
EntityDisplayBaseTest class Drupal\Tests\Core\Config\Entity core/tests/Drupal/Tests/Core/Config/Entity/EntityDisplayBaseTest.php @coversDefaultClass \Drupal\Core\Entity\EntityDisplayBase[[api-linebreak]]
EntityDisplayFormBase abstract class Drupal\field_ui\Form core/modules/field_ui/src/Form/EntityDisplayFormBase.php Base class for EntityDisplay edit forms. 2
EntityDisplayFormBaseTest class Drupal\Tests\field_ui\Functional core/modules/field_ui/tests/src/Functional/EntityDisplayFormBaseTest.php Tests the UI for configuring entity displays.
EntityDisplayFormBaseTest class Drupal\KernelTests\Core\Entity core/tests/Drupal/KernelTests/Core/Entity/EntityDisplayFormBaseTest.php @coversDefaultClass \Drupal\field_ui\Form\EntityDisplayFormBase[[api-linebreak]]
EntityDisplayInterface interface Drupal\Core\Entity\Display core/lib/Drupal/Core/Entity/Display/EntityDisplayInterface.php Provides a common interface for entity displays. 5 6
EntityDisplayModeAddForm class Drupal\field_ui\Form core/modules/field_ui/src/Form/EntityDisplayModeAddForm.php Provides the add form for entity display modes. 1
EntityDisplayModeBase abstract class Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityDisplayModeBase.php Base class for config entity types with settings for form and view modes. 3 3
EntityDisplayModeBaseTestableClass class Drupal\Tests\Core\Config\Entity core/tests/Drupal/Tests/Core/Config/Entity/EntityDisplayModeBaseUnitTest.php A class extending EntityDisplayModeBase for testing purposes.
EntityDisplayModeBaseUnitTest class Drupal\Tests\Core\Config\Entity core/tests/Drupal/Tests/Core/Config/Entity/EntityDisplayModeBaseUnitTest.php @coversDefaultClass \Drupal\Core\Entity\EntityDisplayModeBase[[api-linebreak]] @group Config
EntityDisplayModeController class Drupal\field_ui\Controller core/modules/field_ui/src/Controller/EntityDisplayModeController.php Provides methods for entity display mode routes.
EntityDisplayModeDeleteForm class Drupal\field_ui\Form core/modules/field_ui/src/Form/EntityDisplayModeDeleteForm.php Provides the delete form for entity display modes.
EntityDisplayModeEditForm class Drupal\field_ui\Form core/modules/field_ui/src/Form/EntityDisplayModeEditForm.php Provides the edit form for entity display modes.
EntityDisplayModeFormBase abstract class Drupal\field_ui\Form core/modules/field_ui/src/Form/EntityDisplayModeFormBase.php Provides the generic base class for entity display mode forms. 2
EntityDisplayModeInterface interface Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityDisplayModeInterface.php Provides an interface for entity types that hold form and view mode settings. 3
EntityDisplayModeListBuilder class Drupal\field_ui core/modules/field_ui/src/EntityDisplayModeListBuilder.php Defines a class to build a listing of view mode entities. 1
EntityDisplayModeTest class Drupal\Tests\field_ui\Functional core/modules/field_ui/tests/src/Functional/EntityDisplayModeTest.php Tests the entity display modes UI.
EntityDisplayPluginCollection class Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityDisplayPluginCollection.php A collection of formatters or widgets. 2
EntityDisplayRebuilder class Drupal\field core/modules/field/src/EntityDisplayRebuilder.php Rebuilds all form and view modes for a passed entity bundle. 1
EntityDisplayRepository class Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityDisplayRepository.php Provides a repository for entity display objects (view modes and form modes). 2

Other projects


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