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

Name	Deprecated	Object type	Namespace	File name	Summary	Direct uses	Use statements	Strings
Fieldset		class	Drupal\Core\Render\Element	core/lib/Drupal/Core/Render/Element/Fieldset.php	Provides a render element for a group of form elements.	1
FieldSettings		class	Drupal\field\Plugin\migrate\process\d6	core/modules/field/src/Plugin/migrate/process/d6/FieldSettings.php	Get the field settings.		1
FieldSettings		class	Drupal\field\Plugin\migrate\process\d7	core/modules/field/src/Plugin/migrate/process/d7/FieldSettings.php	Plugin annotation @MigrateProcessPlugin( id = "d7_field_settings" )		1
FieldSettingsTest		class	Drupal\Tests\field\Unit\Plugin\migrate\process\d6	core/modules/field/tests/src/Unit/Plugin/migrate/process/d6/FieldSettingsTest.php	@coversDefaultClass \Drupal\field\Plugin\migrate\process\d6\FieldSettings @group field
FieldSettingsTest		class	Drupal\Tests\field\Unit\Plugin\migrate\process\d7	core/modules/field/tests/src/Unit/Plugin/migrate/process/d7/FieldSettingsTest.php	@coversDefaultClass \Drupal\field\Plugin\migrate\process\d7\FieldSettings @group field
FieldSettingsTest		class	Drupal\KernelTests\Core\Field	core/tests/Drupal/KernelTests/Core/Field/FieldSettingsTest.php	Tests field settings methods on field definition structures.
FieldsOverlapException		class	Drupal\Core\Database\Query	core/lib/Drupal/Core/Database/Query/FieldsOverlapException.php	Exception thrown if an insert query specifies a field twice.
FieldSqlStorageTest		class	Drupal\KernelTests\Core\Entity	core/tests/Drupal/KernelTests/Core/Entity/FieldSqlStorageTest.php	Tests Field SQL Storage .
FieldStorageAddForm		class	Drupal\field_ui\Form	core/modules/field_ui/src/Form/FieldStorageAddForm.php	Provides a form for the "field storage" add page.
FieldStorageConfig		class	Drupal\field\Entity	core/modules/field/src/Entity/FieldStorageConfig.php	Defines the Field storage configuration entity.		289
FieldStorageConfigAccessControlHandler		class	Drupal\field	core/modules/field/src/FieldStorageConfigAccessControlHandler.php	Defines the access control handler for the field storage config entity type.		1
FieldStorageConfigAccessControlHandlerTest		class	Drupal\Tests\field\Unit	core/modules/field/tests/src/Unit/FieldStorageConfigAccessControlHandlerTest.php	Tests the field storage config access controller.	1
FieldStorageConfigEditForm		class	Drupal\field_ui\Form	core/modules/field_ui/src/Form/FieldStorageConfigEditForm.php	Provides a form for the "field storage" edit page.
FieldStorageConfigEntityUnitTest		class	Drupal\Tests\field\Unit	core/modules/field/tests/src/Unit/FieldStorageConfigEntityUnitTest.php	@coversDefaultClass \Drupal\field\Entity\FieldStorageConfig
FieldStorageConfigHalJsonAnonTest		class	Drupal\Tests\field\Functional\Hal	core/modules/field/tests/src/Functional/Hal/FieldStorageConfigHalJsonAnonTest.php	@group hal
FieldStorageConfigHalJsonBasicAuthTest		class	Drupal\Tests\field\Functional\Hal	core/modules/field/tests/src/Functional/Hal/FieldStorageConfigHalJsonBasicAuthTest.php	@group hal
FieldStorageConfigHalJsonCookieTest		class	Drupal\Tests\field\Functional\Hal	core/modules/field/tests/src/Functional/Hal/FieldStorageConfigHalJsonCookieTest.php	@group hal
FieldStorageConfigInterface		interface	Drupal\field	core/modules/field/src/FieldStorageConfigInterface.php	Provides an interface defining a field storage entity.	1	20
FieldStorageConfigJsonAnonTest		class	Drupal\Tests\field\Functional\Rest	core/modules/field/tests/src/Functional/Rest/FieldStorageConfigJsonAnonTest.php	@group rest
FieldStorageConfigJsonBasicAuthTest		class	Drupal\Tests\field\Functional\Rest	core/modules/field/tests/src/Functional/Rest/FieldStorageConfigJsonBasicAuthTest.php	@group rest
FieldStorageConfigJsonCookieTest		class	Drupal\Tests\field\Functional\Rest	core/modules/field/tests/src/Functional/Rest/FieldStorageConfigJsonCookieTest.php	@group rest
FieldStorageConfigListBuilder		class	Drupal\field_ui	core/modules/field_ui/src/FieldStorageConfigListBuilder.php	Defines a class to build a listing of fields.
FieldStorageConfigResourceTestBase	in drupal:8.6.0 and is removed from drupal:9.0.0. Use Drupal\Tests\field\Functional\Rest\FieldStorageConfigResourceTestBase instead.	abstract class	Drupal\Tests\rest\Functional\EntityResource\FieldStorageConfig	core/modules/rest/tests/src/Functional/EntityResource/FieldStorageConfig/FieldStorageConfigResourceTestBase.php
FieldStorageConfigResourceTestBase		abstract class	Drupal\Tests\field\Functional\Rest	core/modules/field/tests/src/Functional/Rest/FieldStorageConfigResourceTestBase.php		10	4
FieldStorageConfigStorage		class	Drupal\field	core/modules/field/src/FieldStorageConfigStorage.php	Storage handler for "field storage" configuration entities.
FieldStorageConfigTest		class	Drupal\Tests\jsonapi\Functional	core/modules/jsonapi/tests/src/Functional/FieldStorageConfigTest.php	JSON:API integration test for the "FieldStorageConfig" config entity type.
FieldStorageConfigUpdateForbiddenException		class	Drupal\field	core/modules/field/src/FieldStorageConfigUpdateForbiddenException.php	Exception class thrown by hook_field_storage_config_update_forbid().
FieldStorageConfigXmlAnonTest		class	Drupal\Tests\field\Functional\Rest	core/modules/field/tests/src/Functional/Rest/FieldStorageConfigXmlAnonTest.php	@group rest
FieldStorageConfigXmlBasicAuthTest		class	Drupal\Tests\field\Functional\Rest	core/modules/field/tests/src/Functional/Rest/FieldStorageConfigXmlBasicAuthTest.php	@group rest
FieldStorageConfigXmlCookieTest		class	Drupal\Tests\field\Functional\Rest	core/modules/field/tests/src/Functional/Rest/FieldStorageConfigXmlCookieTest.php	@group rest
FieldStorageCrudTest		class	Drupal\Tests\field\Kernel	core/modules/field/tests/src/Kernel/FieldStorageCrudTest.php	Tests field storage create, read, update, and delete.
FieldStorageDefinition		class	Drupal\entity_test	core/modules/system/tests/modules/entity_test/src/FieldStorageDefinition.php	A custom field storage definition class.		5
FieldStorageDefinitionEvent		class	Drupal\Core\Field	core/lib/Drupal/Core/Field/FieldStorageDefinitionEvent.php	Defines a base class for all field storage definition events.
FieldStorageDefinitionEvents		final class	Drupal\Core\Field	core/lib/Drupal/Core/Field/FieldStorageDefinitionEvents.php	Contains all events thrown while handling field storage definitions.		2
FieldStorageDefinitionEventSubscriberTrait		trait	Drupal\Core\Field	core/lib/Drupal/Core/Field/FieldStorageDefinitionEventSubscriberTrait.php	Helper methods for FieldStorageDefinitionListenerInterface.		1
FieldStorageDefinitionInterface		interface	Drupal\Core\Field	core/lib/Drupal/Core/Field/FieldStorageDefinitionInterface.php	Defines an interface for entity field storage definitions.	3	168
FieldStorageDefinitionListener		class	Drupal\Core\Field	core/lib/Drupal/Core/Field/FieldStorageDefinitionListener.php	Reacts to field storage definition CRUD on behalf of the Entity system.			2
FieldStorageDefinitionListenerInterface		interface	Drupal\Core\Field	core/lib/Drupal/Core/Field/FieldStorageDefinitionListenerInterface.php	Defines an interface for reacting to field storage definition creation, deletion, and updates.	5	6
FieldStorageDefinitionUpdateForbiddenException		class	Drupal\Core\Entity\Exception	core/lib/Drupal/Core/Entity/Exception/FieldStorageDefinitionUpdateForbiddenException.php	Exception thrown when a storage definition update is forbidden.		8
FieldTest		class	Drupal\Tests\quickedit\FunctionalJavascript	core/modules/quickedit/tests/src/FunctionalJavascript/FieldTest.php	Tests quickedit.
FieldTest		class	Drupal\views_test_data\Plugin\views\field	core/modules/views/tests/modules/views_test_data/src/Plugin/views/field/FieldTest.php	Plugin annotation @ViewsField("test_field");
FieldTest		class	Drupal\Tests\field\Kernel\Plugin\migrate\source\d6	core/modules/field/tests/src/Kernel/Plugin/migrate/source/d6/FieldTest.php	Tests D6 field source plugin.
FieldTest		class	Drupal\Tests\field\Kernel\Plugin\migrate\source\d7	core/modules/field/tests/src/Kernel/Plugin/migrate/source/d7/FieldTest.php	Tests D7 field source plugin.
FieldTest		class	Drupal\Tests\views\Unit\Plugin\field	core/modules/views/tests/src/Unit/Plugin/field/FieldTest.php	@coversDefaultClass \Drupal\views\Plugin\views\field\EntityField @group views
FieldTest		class	Drupal\Tests\views\FunctionalJavascript\Plugin\views\Handler	core/modules/views/tests/src/FunctionalJavascript/Plugin/views/Handler/FieldTest.php	Tests the field field handler UI.
FieldTestBase	in drupal:8.6.0 and is removed from drupal:9.0.0. Use \Drupal\Tests\field\Functional\Views\FieldTestBase instead.	abstract class	Drupal\field\Tests\Views	core/modules/field/src/Tests/Views/FieldTestBase.php	Provides some helper methods for testing fieldapi integration into views.
FieldTestBase	in drupal:8.?.? and is removed from drupal:9.0.0. Use \Drupal\Tests\field\Functional\FieldTestBase instead.	abstract class	Drupal\field\Tests	core/modules/field/src/Tests/FieldTestBase.php	Parent class for Field API tests.
FieldTestBase		abstract class	Drupal\Tests\field\Functional\Views	core/modules/field/tests/src/Functional/Views/FieldTestBase.php	Provides some helper methods for testing fieldapi integration into views.	1
FieldTestBase		abstract class	Drupal\Tests\field\Functional	core/modules/field/tests/src/Functional/FieldTestBase.php	Parent class for Field API tests.	9	4
FieldTestEntityField		class	Drupal\Tests\views\Unit\Plugin\field	core/modules/views/tests/src/Unit/Plugin/field/FieldTest.php

Other projects

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