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
EndOfTransactionQueriesTest class Drupal\KernelTests\Core\Cache core/tests/Drupal/KernelTests/Core/Cache/EndOfTransactionQueriesTest.php Tests that cache tag invalidation queries are delayed to the end of transactions.
Endpoint class Drupal\media\OEmbed core/modules/media/src/OEmbed/Endpoint.php Value object for oEmbed provider endpoints.
EnforcedFormResponseSubscriber class Drupal\Core\EventSubscriber core/lib/Drupal/Core/EventSubscriber/EnforcedFormResponseSubscriber.php Handle the EnforcedResponseException and deliver an EnforcedResponse. 2
EnforcedResponse class Drupal\Core\Form core/lib/Drupal/Core/Form/EnforcedResponse.php A wrapper containing a response which is to be enforced upon delivery. 1
EnforcedResponseException class Drupal\Core\Form core/lib/Drupal/Core/Form/EnforcedResponseException.php Custom exception to break out of the main request and enforce a response. 6
EngineNyanCatTest class Drupal\Tests\system\Functional\Theme core/modules/system/tests/src/Functional/Theme/EngineNyanCatTest.php Tests the multi theme engine support.
EngineTwigTest class Drupal\Tests\system\Functional\Theme core/modules/system/tests/src/Functional/Theme/EngineTwigTest.php Tests Twig-specific theme functionality.
EnhancerInterface interface Drupal\Core\Routing core/lib/Drupal/Core/Routing/EnhancerInterface.php A route enhance service to determine route enhance rules. 8 8
Entity class Drupal\Tests\Component\Annotation\Doctrine\Ticket core/tests/Drupal/Tests/Component/Annotation/Doctrine/Ticket/DCOM58Test.php
Entity class core/tests/Drupal/Tests/Component/Annotation/Doctrine/Ticket/DCOM58Entity.php This class is a near-copy of tests/Doctrine/Tests/Common/Annotations/Ticket/DCOM58Entity.php, which is part of the Doctrine project: <http://www.doctrine-project.org>. It was copied from version 1.2.7.
Entity

in drupal:8.7.0 and is removed from drupal:9.0.0. Use \Drupal\Core\Entity\EntityBase instead.

abstract class Drupal\Core\Entity core/lib/Drupal/Core/Entity/Entity.php Defines a base entity class.
Entity abstract class Drupal\migrate\Plugin\migrate\destination core/modules/migrate/src/Plugin/migrate/destination/Entity.php Provides a generic destination to import entities. 2
Entity class Drupal\views\Plugin\views\argument_validator core/modules/views/src/Plugin/views/argument_validator/Entity.php Defines a argument validator plugin for each entity type. 3 4
Entity class Drupal\views\Plugin\views\area core/modules/views/src/Plugin/views/area/Entity.php Provides an area handler which renders an entity in a certain view mode. 1
EntityAccess class Drupal\workspaces core/modules/workspaces/src/EntityAccess.php Service wrapper for hooks relating to entity access control. 1
EntityAccessCheck class Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityAccessCheck.php Provides a generic access checker for entities. 1 2
EntityAccessChecker class Drupal\jsonapi\Access core/modules/jsonapi/src/Access/EntityAccessChecker.php Checks access to entities. 2 2
EntityAccessCheckTest class Drupal\Tests\Core\Entity core/tests/Drupal/Tests/Core/Entity/EntityAccessCheckTest.php Unit test of entity access checking system.
EntityAccessControlHandler class Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityAccessControlHandler.php Defines a default implementation for entity access control handler. 35 36
EntityAccessControlHandlerInterface interface Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityAccessControlHandlerInterface.php Defines an interface for entity access control handlers. 2 3
EntityAccessControlHandlerTest class Drupal\KernelTests\Core\Entity core/tests/Drupal/KernelTests/Core/Entity/EntityAccessControlHandlerTest.php Tests the entity access control handler.
EntityAccessDeniedHttpException class Drupal\jsonapi\Exception core/modules/jsonapi/src/Exception/EntityAccessDeniedHttpException.php Enhances the access denied exception with information about the entity. 8
EntityAccessDeniedHttpExceptionNormalizer class Drupal\jsonapi\Normalizer core/modules/jsonapi/src/Normalizer/EntityAccessDeniedHttpExceptionNormalizer.php Normalizes an EntityAccessDeniedException. 2
EntityActionBase abstract class Drupal\Core\Action\Plugin\Action core/lib/Drupal/Core/Action/Plugin/Action/EntityActionBase.php Base class for entity-based actions. 4
EntityActionDeriverBase abstract class Drupal\Core\Action\Plugin\Action\Derivative core/lib/Drupal/Core/Action/Plugin/Action/Derivative/EntityActionDeriverBase.php Provides a base action for each entity type with specific interfaces. 3
EntityAdapter class Drupal\Core\Entity\Plugin\DataType core/lib/Drupal/Core/Entity/Plugin/DataType/EntityAdapter.php Defines the "entity" data type. 1 6
EntityAdapterUnitTest class Drupal\Tests\Core\Entity\TypedData core/tests/Drupal/Tests/Core/Entity/TypedData/EntityAdapterUnitTest.php @coversDefaultClass \Drupal\Core\Entity\Plugin\DataType\EntityAdapter @group Entity @group TypedData
EntityAddUITest class Drupal\Tests\system\Functional\Entity core/modules/system/tests/src/Functional/Entity/EntityAddUITest.php Tests the /add and /add/{type} controllers.
EntityApiTest class Drupal\KernelTests\Core\Entity core/tests/Drupal/KernelTests/Core/Entity/EntityApiTest.php Tests basic CRUD functionality.
EntityAutocomplete class Drupal\Core\Entity\Element core/lib/Drupal/Core/Entity/Element/EntityAutocomplete.php Provides an entity autocomplete form element. 4
EntityAutocompleteController class Drupal\system\Controller core/modules/system/src/Controller/EntityAutocompleteController.php Defines a route controller for entity autocomplete form elements. 1
EntityAutocompleteElementFormTest class Drupal\KernelTests\Core\Entity\Element core/tests/Drupal/KernelTests/Core/Entity/Element/EntityAutocompleteElementFormTest.php Tests the EntityAutocomplete Form API element.
EntityAutocompleteMatcher class Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityAutocompleteMatcher.php Matcher class to get autocompletion results for entity reference. 2
EntityAutocompleteMatcherInterface interface Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityAutocompleteMatcherInterface.php 1 1
EntityAutocompleteTest class Drupal\KernelTests\Core\Entity core/tests/Drupal/KernelTests/Core/Entity/EntityAutocompleteTest.php Tests the autocomplete functionality.
EntityBase abstract class Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityBase.php Defines a base entity class. 6 4
EntityBaseFieldOverride class Drupal\migrate\Plugin\migrate\destination core/modules/migrate/src/Plugin/migrate/destination/EntityBaseFieldOverride.php Provides entity base field override destination plugin.
EntityBlock class Drupal\block\Plugin\migrate\destination core/modules/block/src/Plugin/migrate/destination/EntityBlock.php Plugin annotation @MigrateDestination( id = "entity:block" )
EntityBundleAccessCheck class Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityBundleAccessCheck.php Provides an entity bundle checker for the _entity_bundles route requirement. 1 2
EntityBundleAccessCheckTest class Drupal\Tests\Core\Entity core/tests/Drupal/Tests/Core/Entity/EntityBundleAccessCheckTest.php Unit test of entity access checking system.
EntityBundleFieldTest class Drupal\KernelTests\Core\Entity core/tests/Drupal/KernelTests/Core/Entity/EntityBundleFieldTest.php Tests adding a custom bundle field.
EntityBundleListCacheTest class Drupal\FunctionalTests\Entity core/tests/Drupal/FunctionalTests/Entity/EntityBundleListCacheTest.php Tests that bundle tags are invalidated when entities change.
EntityBundleListener class Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityBundleListener.php Reacts to entity bundle CRUD on behalf of the Entity system. 2
EntityBundleListenerInterface interface Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityBundleListenerInterface.php An interface for reacting to entity bundle creation and deletion. 3 1
EntityBundleListenerTest class Drupal\KernelTests\Core\Entity core/tests/Drupal/KernelTests/Core/Entity/EntityBundleListenerTest.php @coversDefaultClass \Drupal\Core\Entity\EntityBundleListener
EntityCacheTagsTestBase

in drupal:8.?.? and is removed from drupal:9.0.0. Use \Drupal\Tests\system\Functional\Entity\EntityCacheTagsTestBase instead.

abstract class Drupal\system\Tests\Entity core/modules/system/src/Tests/Entity/EntityCacheTagsTestBase.php Provides helper methods for Entity cache tags tests. 1
EntityCacheTagsTestBase abstract class Drupal\Tests\system\Functional\Entity core/modules/system/tests/src/Functional/Entity/EntityCacheTagsTestBase.php Provides helper methods for Entity cache tags tests. 4 3
EntityChangedActionDeriver class Drupal\Core\Action\Plugin\Action\Derivative core/lib/Drupal/Core/Action/Plugin/Action/Derivative/EntityChangedActionDeriver.php Provides an action deriver that finds entity types of EntityChangedInterface. 1
EntityChangedConstraint class Drupal\Core\Entity\Plugin\Validation\Constraint core/lib/Drupal/Core/Entity/Plugin/Validation/Constraint/EntityChangedConstraint.php Validation constraint for the entity changed timestamp.
EntityChangedConstraintValidator class Drupal\Core\Entity\Plugin\Validation\Constraint core/lib/Drupal/Core/Entity/Plugin/Validation/Constraint/EntityChangedConstraintValidator.php Validates the EntityChanged constraint.

Other projects


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