Classes, traits, and interfaces - 9.5.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 1523

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
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 2
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 9
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. 5 4
EntityBaseFieldOverride class Drupal\migrate\Plugin\migrate\destination core/modules/migrate/src/Plugin/migrate/destination/EntityBaseFieldOverride.php Provides entity base field override destination plugin.
EntityBaseTest class Drupal\KernelTests\Core\Entity core/tests/Drupal/KernelTests/Core/Entity/EntityBaseTest.php Tests the functionality provided by \Drupal\Core\Entity\EntityBase.
EntityBlock class Drupal\block\Plugin\migrate\destination core/modules/block/src/Plugin/migrate/destination/EntityBlock.php Plugin annotation @MigrateDestination( id = "entity:block" )
EntityBundle class Drupal\Core\Entity\Plugin\Condition\Deriver core/lib/Drupal/Core/Entity/Plugin/Condition/Deriver/EntityBundle.php Deriver that creates a condition for each entity type with bundles.
EntityBundle class Drupal\Core\Entity\Plugin\Condition core/lib/Drupal/Core/Entity/Plugin/Condition/EntityBundle.php Provides the 'Entity Bundle' condition.
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.
EntityBundleConditionTest class Drupal\KernelTests\Core\Entity core/tests/Drupal/KernelTests/Core/Entity/EntityBundleConditionTest.php Tests that entity bundle conditions works properly.
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. 2 1
EntityBundleListenerTest class Drupal\KernelTests\Core\Entity core/tests/Drupal/KernelTests/Core/Entity/EntityBundleListenerTest.php @coversDefaultClass \Drupal\Core\Entity\EntityBundleListener
EntityBundleRouteEnhancer class Drupal\Core\Entity\Enhancer core/lib/Drupal/Core/Entity/Enhancer/EntityBundleRouteEnhancer.php Sets the bundle parameter for routes with the _field_ui option. 1 1 4
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. 1 1
EntityChangedConstraintValidator class Drupal\Core\Entity\Plugin\Validation\Constraint core/lib/Drupal/Core/Entity/Plugin/Validation/Constraint/EntityChangedConstraintValidator.php Validates the EntityChanged constraint. 1 1
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

Other projects


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