Classes, traits, and interfaces - main - drupal

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
EntityReferenceIdFormatter class Drupal\Core\Field\Plugin\Field\FieldFormatter core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/EntityReferenceIdFormatter.php Plugin implementation of the 'entity reference ID' formatter.
EntityReferenceIntegrationTest class Drupal\Tests\field\Functional\EntityReference core/modules/field/tests/src/Functional/EntityReference/EntityReferenceIntegrationTest.php Tests various Entity reference UI components.
EntityReferenceItem class Drupal\Core\Field\Plugin\Field\FieldType core/lib/Drupal/Core/Field/Plugin/Field/FieldType/EntityReferenceItem.php Defines the 'entity_reference' entity field type. 3 19
EntityReferenceItemBase abstract class Drupal\Core\Field\Plugin\Field\FieldType core/lib/Drupal/Core/Field/Plugin/Field/FieldType/EntityReferenceItemBase.php Base class for field items referencing other entities. 1
EntityReferenceItemInterface interface Drupal\Core\Field\Plugin\Field\FieldType core/lib/Drupal/Core/Field/Plugin/Field/FieldType/EntityReferenceItemInterface.php Interface definition for field items referencing other entities. 1 2
EntityReferenceItemSubclass class Drupal\media_library_test\Plugin\Field\FieldType core/modules/media_library/tests/modules/media_library_test/src/Plugin/Field/FieldType/EntityReferenceItemSubclass.php Plugin implementation of the 'entity_reference_subclass' field type.
EntityReferenceItemTest class Drupal\Tests\field\Kernel\EntityReference core/modules/field/tests/src/Kernel/EntityReference/EntityReferenceItemTest.php Tests the new entity API for the entity reference field type.
EntityReferenceLabelFormatter class Drupal\Core\Field\Plugin\Field\FieldFormatter core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/EntityReferenceLabelFormatter.php Plugin implementation of the 'entity reference label' formatter.
EntityReferenceRelationshipTest class Drupal\Tests\field\Kernel\EntityReference\Views core/modules/field/tests/src/Kernel/EntityReference/Views/EntityReferenceRelationshipTest.php Tests entity reference relationship data.
EntityReferenceSelection class Drupal\Core\Entity\Attribute core/lib/Drupal/Core/Entity/Attribute/EntityReferenceSelection.php Defines an EntityReferenceSelection attribute for plugin discovery. 14
EntityReferenceSelection class Drupal\Core\Entity\Annotation core/lib/Drupal/Core/Entity/Annotation/EntityReferenceSelection.php Defines an EntityReferenceSelection plugin annotation object.
EntityReferenceSelectionAccessTest class Drupal\Tests\system\Kernel\Entity\EntityReferenceSelection core/modules/system/tests/src/Kernel/Entity/EntityReferenceSelection/EntityReferenceSelectionAccessTest.php Tests for the base handlers provided by Entity Reference.
EntityReferenceSelectionReferenceableTest class Drupal\Tests\system\Kernel\Entity core/modules/system/tests/src/Kernel/Entity/EntityReferenceSelectionReferenceableTest.php Tests entity reference selection plugins.
EntityReferenceSelectionSortTest class Drupal\KernelTests\Core\Entity\EntityReferenceSelection core/tests/Drupal/KernelTests/Core/Entity/EntityReferenceSelection/EntityReferenceSelectionSortTest.php Tests sorting referenced items.
EntityReferenceSettingsTest class Drupal\Tests\field\Kernel\EntityReference core/modules/field/tests/src/Kernel/EntityReference/EntityReferenceSettingsTest.php Tests entity reference field settings.
EntityReferenceSupportedNewEntitiesConstraint class Drupal\workspaces\Plugin\Validation\Constraint core/modules/workspaces/src/Plugin/Validation/Constraint/EntityReferenceSupportedNewEntitiesConstraint.php The entity reference supported new entities constraint.
EntityReferenceSupportedNewEntitiesConstraintValidator class Drupal\workspaces\Plugin\Validation\Constraint core/modules/workspaces/src/Plugin/Validation/Constraint/EntityReferenceSupportedNewEntitiesConstraintValidator.php Checks if new entities created for entity reference fields are supported. 1
EntityReferenceSupportedNewEntitiesConstraintValidatorTest class Drupal\Tests\workspaces\Kernel core/modules/workspaces/tests/src/Kernel/EntityReferenceSupportedNewEntitiesConstraintValidatorTest.php Tests Drupal\workspaces\Plugin\Validation\Constraint\EntityReferenceSupportedNewEntitiesConstraintValidator.
EntityReferenceTaxonomyTermRssFormatter class Drupal\taxonomy\Plugin\Field\FieldFormatter core/modules/taxonomy/src/Plugin/Field/FieldFormatter/EntityReferenceTaxonomyTermRssFormatter.php Plugin implementation of the 'entity reference taxonomy term RSS' formatter.
EntityReferenceTestHooks class Drupal\entity_reference_test\Hook core/modules/system/tests/modules/entity_reference_test/src/Hook/EntityReferenceTestHooks.php Hook implementations for entity_reference_test.
EntityReferenceTranslationDeriver class Drupal\migrate_drupal\Plugin\migrate core/modules/migrate_drupal/src/Plugin/migrate/EntityReferenceTranslationDeriver.php Deriver for entity reference field translations. 2
EntityReferenceUuidItem class Drupal\jsonapi_test_field_type\Plugin\Field\FieldType core/modules/jsonapi/tests/modules/jsonapi_test_field_type/src/Plugin/Field/FieldType/EntityReferenceUuidItem.php Defines the 'entity_reference_uuid' entity field type.
EntityReferenceWidgetTest class Drupal\Tests\media_library\FunctionalJavascript core/modules/media_library/tests/src/FunctionalJavascript/EntityReferenceWidgetTest.php Tests the Media library entity reference widget. 1 1
EntityReferenceXSSTest class Drupal\Tests\field\Functional\EntityReference core/modules/field/tests/src/Functional/EntityReference/EntityReferenceXSSTest.php Tests possible XSS security issues in entity references.
EntityRepository class Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityRepository.php Provides several mechanisms for retrieving entities. 2 2
EntityRepositoryInterface interface Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityRepositoryInterface.php Provides an interface for an entity repository. 2 80
EntityRepositoryTest class Drupal\KernelTests\Core\Entity core/tests/Drupal/KernelTests/Core/Entity/EntityRepositoryTest.php Tests the entity repository.
EntityRepositoryTest class Drupal\Tests\Core\Entity core/tests/Drupal/Tests/Core/Entity/EntityRepositoryTest.php Tests Drupal\Core\Entity\EntityRepository.
EntityResolverInterface interface Drupal\serialization\EntityResolver core/modules/serialization/src/EntityResolver/EntityResolverInterface.php Interface for entity resolvers. 3
EntityResolverManager class Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityResolverManager.php Sets the entity route parameter converter options automatically. 2 2
EntityResolverManagerTest class Drupal\Tests\Core\Entity core/tests/Drupal/Tests/Core/Entity/EntityResolverManagerTest.php Tests Drupal\Core\Entity\EntityResolverManager.
EntityResource class Drupal\rest\Plugin\rest\resource core/modules/rest/src/Plugin/rest/resource/EntityResource.php Represents entities as resources. 1 1
EntityResource class Drupal\jsonapi\Controller core/modules/jsonapi/src/Controller/EntityResource.php Process all entity requests. 1 2
EntityResourceAccessTrait trait Drupal\rest\Plugin\rest\resource core/modules/rest/src/Plugin/rest/resource/EntityResourceAccessTrait.php @internal @todo Consider making public in https://www.drupal.org/node/2300677 1
EntityResourcePostRouteSubscriber class Drupal\rest\EventSubscriber core/modules/rest/src/EventSubscriber/EntityResourcePostRouteSubscriber.php Generates a 'create' route for an entity type if it has a REST POST route. 2
EntityResourceRestTestCoverageTest class Drupal\Tests\rest\Kernel\EntityResource core/modules/rest/tests/src/Kernel/EntityResource/EntityResourceRestTestCoverageTest.php Checks that all core content/config entity types have REST test coverage.
EntityResourceTest class Drupal\Tests\jsonapi\Kernel\Controller core/modules/jsonapi/tests/src/Kernel/Controller/EntityResourceTest.php Tests Drupal\jsonapi\Controller\EntityResource.
EntityResourceTestBase abstract class Drupal\Tests\rest\Functional\EntityResource core/modules/rest/tests/src/Functional/EntityResource/EntityResourceTestBase.php Defines a base class for testing all entity resources. 13 12
EntityResourceValidationTrait trait Drupal\rest\Plugin\rest\resource core/modules/rest/src/Plugin/rest/resource/EntityResourceValidationTrait.php @internal @todo Consider making public in https://www.drupal.org/node/2300677 3
EntityResourceValidationTraitTest class Drupal\Tests\rest\Unit core/modules/rest/tests/src/Unit/EntityResourceValidationTraitTest.php Tests Drupal\rest\Plugin\rest\resource\EntityResourceValidationTrait.
EntityResourceValidationTraitTestClass class Drupal\Tests\rest\Unit core/modules/rest/tests/src/Unit/EntityResourceValidationTraitTest.php A test class to use to test EntityResourceValidationTrait.
EntityReverse class Drupal\views\Plugin\views\relationship core/modules/views/src/Plugin/views/relationship/EntityReverse.php A relationship handlers which reverse entity references.
EntityReverseJoinTest class Drupal\Tests\views\Kernel\Plugin core/modules/views/tests/src/Kernel/Plugin/EntityReverseJoinTest.php Tests the EntityReverse join plugin.
EntityRevision class Drupal\migrate\Plugin\migrate\destination core/modules/migrate/src/Plugin/migrate/destination/EntityRevision.php Provides entity revision destination plugin. 2 2
EntityRevision class Drupal\Tests\migrate\Unit\destination core/modules/migrate/tests/src/Unit/destination/EntityRevisionTest.php Mock that exposes from internal methods for testing.
EntityRevisionParamConverter class Drupal\Core\ParamConverter core/lib/Drupal/Core/ParamConverter/EntityRevisionParamConverter.php Parameter converter for upcasting entity revision IDs to full objects. 1 2
EntityRevisionParamConverterTest class Drupal\Tests\Core\ParamConverter core/tests/Drupal/Tests/Core/ParamConverter/EntityRevisionParamConverterTest.php Tests Drupal\Core\ParamConverter\EntityRevisionParamConverter.
EntityRevisionRouteEnhancer class Drupal\Core\Routing\Enhancer core/lib/Drupal/Core/Routing/Enhancer/EntityRevisionRouteEnhancer.php Adds _entity_revision to the request attributes, if possible. 1 2
EntityRevisionRouteEnhancerTest class Drupal\Tests\Core\Enhancer core/tests/Drupal/Tests/Core/Enhancer/EntityRevisionRouteEnhancerTest.php Tests Drupal\Core\Routing\Enhancer\EntityRevisionRouteEnhancer.
EntityRevisionsTest class Drupal\KernelTests\Core\Entity core/tests/Drupal/KernelTests/Core/Entity/EntityRevisionsTest.php Tests the loaded Revision of an entity.

Other projects

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