Classes, traits, and interfaces - 10.3.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 1518

Name	Deprecated	Object type	Namespace	File name	Summary	Direct uses	Use statements	Strings
FormErrorHandlerInterface		interface	Drupal\Core\Form	core/lib/Drupal/Core/Form/FormErrorHandlerInterface.php	Provides an interface for handling form errors.	1
FormErrorHandlerTest		class	Drupal\Tests\Core\Form	core/tests/Drupal/Tests/Core/Form/FormErrorHandlerTest.php	@coversDefaultClass \Drupal\Core\Form\FormErrorHandler[[api-linebreak]] @group Form
FormErrorHandlerTest		class	Drupal\Tests\inline_form_errors\Unit	core/modules/inline_form_errors/tests/src/Unit/FormErrorHandlerTest.php	@coversDefaultClass \Drupal\inline_form_errors\FormErrorHandler[[api-linebreak]] @group InlineFormErrors
FormGroupingElementsTest		class	Drupal\FunctionalJavascriptTests\Core\Form	core/tests/Drupal/FunctionalJavascriptTests/Core/Form/FormGroupingElementsTest.php	Tests for form grouping elements.
FormHelper		class	Drupal\Core\Form	core/lib/Drupal/Core/Form/FormHelper.php	Provides helpers to operate on forms.		6
FormHelperTest		class	Drupal\Tests\Core\Form	core/tests/Drupal/Tests/Core/Form/FormHelperTest.php	@coversDefaultClass \Drupal\Core\Form\FormHelper[[api-linebreak]] @group Form
FormInterface		interface	Drupal\Core\Form	core/lib/Drupal/Core/Form/FormInterface.php	Provides an interface for a Form.	39	41
FormModeAccessCheck		class	Drupal\field_ui\Access	core/modules/field_ui/src/Access/FormModeAccessCheck.php	Defines an access check for entity form mode routes.			2
FormObjectTest		class	Drupal\Tests\system\Kernel\Form	core/modules/system/tests/src/Kernel/Form/FormObjectTest.php	Tests building a form from an object.
FormObjectTest		class	Drupal\Tests\system\Functional\Form	core/modules/system/tests/src/Functional/Form/FormObjectTest.php	Tests building a form from an object.
FormOperations		class	Drupal\workspaces	core/modules/workspaces/src/FormOperations.php	Defines a class for reacting to form operations.		1
FormRouteEnhancer		class	Drupal\Core\Routing\Enhancer	core/lib/Drupal/Core/Routing/Enhancer/FormRouteEnhancer.php	Enhancer to add a wrapping controller for _form routes.			2
FormState		class	Drupal\Core\Form	core/lib/Drupal/Core/Form/FormState.php	Stores information about the state of a form.		82
FormStateDecoratorBase		abstract class	Drupal\Core\Form	core/lib/Drupal/Core/Form/FormStateDecoratorBase.php	Decorates another form state.	2	1
FormStateDecoratorBaseTest		class	Drupal\Tests\Core\Form	core/tests/Drupal/Tests/Core/Form/FormStateDecoratorBaseTest.php	@coversDefaultClass \Drupal\Core\Form\FormStateDecoratorBase[[api-linebreak]]
FormStateInterface		interface	Drupal\Core\Form	core/lib/Drupal/Core/Form/FormStateInterface.php	Provides an interface for an object containing the current state of a form.	3	897
FormStateTest		class	Drupal\Tests\Core\Form	core/tests/Drupal/Tests/Core/Form/FormStateTest.php	@coversDefaultClass \Drupal\Core\Form\FormState[[api-linebreak]]
FormStateValuesTrait		trait	Drupal\Core\Form	core/lib/Drupal/Core/Form/FormStateValuesTrait.php	Provides methods to manage form state values.		1
FormStateValuesTraitStub		class	Drupal\Tests\Core\Form	core/tests/Drupal/Tests/Core/Form/FormStateValuesTraitTest.php
FormStateValuesTraitTest		class	Drupal\Tests\Core\Form	core/tests/Drupal/Tests/Core/Form/FormStateValuesTraitTest.php	@coversDefaultClass \Drupal\Core\Form\FormStateValuesTrait[[api-linebreak]]
FormStoragePageCacheTest		class	Drupal\Tests\system\Functional\Form	core/modules/system/tests/src/Functional/Form/FormStoragePageCacheTest.php	Tests form storage from cached pages.
FormSubmitter		class	Drupal\Core\Form	core/lib/Drupal/Core/Form/FormSubmitter.php	Provides submission processing for forms.			2
FormSubmitterInterface		interface	Drupal\Core\Form	core/lib/Drupal/Core/Form/FormSubmitterInterface.php	Provides an interface for processing form submissions.	2
FormSubmitterTest		class	Drupal\Tests\Core\Form	core/tests/Drupal/Tests/Core/Form/FormSubmitterTest.php	@coversDefaultClass \Drupal\Core\Form\FormSubmitter[[api-linebreak]] @group Form
FormTest		class	Drupal\Tests\system\Functional\Form	core/modules/system/tests/src/Functional/Form/FormTest.php	Tests various form element validation mechanisms.
FormTest		class	Drupal\Tests\field\Functional	core/modules/field/tests/src/Functional/FormTest.php	Tests field form handling.
FormTestAlterForm		class	Drupal\form_test\Form	core/modules/system/tests/modules/form_test/src/Form/FormTestAlterForm.php	Form builder for testing hook_form_alter() and hook_form_FORM_ID_alter().			1
FormTestArgumentsObject		class	Drupal\form_test	core/modules/system/tests/modules/form_test/src/FormTestArgumentsObject.php	Provides a test form object that needs arguments.			1
FormTestAutocompleteForm		class	Drupal\form_test	core/modules/system/tests/modules/form_test/src/FormTestAutocompleteForm.php	Defines a test form using autocomplete textfields.			1
FormTestBase		abstract class	Drupal\Tests\Core\Form	core/tests/Drupal/Tests/Core/Form/FormTestBase.php	Provides a base class for testing form functionality.	1
FormTestButtonClassForm		class	Drupal\form_test\Form	core/modules/system/tests/modules/form_test/src/Form/FormTestButtonClassForm.php	Builds a simple form to test form button classes.			1
FormTestCheckboxesRadiosForm		class	Drupal\form_test\Form	core/modules/system/tests/modules/form_test/src/Form/FormTestCheckboxesRadiosForm.php	Form constructor to test expansion of #type checkboxes and radios.			1
FormTestCheckboxesZeroForm		class	Drupal\form_test\Form	core/modules/system/tests/modules/form_test/src/Form/FormTestCheckboxesZeroForm.php	Tests checkboxes zero.			1
FormTestCheckboxForm		class	Drupal\form_test\Form	core/modules/system/tests/modules/form_test/src/Form/FormTestCheckboxForm.php	Form for testing checkbox.			1
FormTestCheckboxTypeJugglingForm		class	Drupal\form_test\Form	core/modules/system/tests/modules/form_test/src/Form/FormTestCheckboxTypeJugglingForm.php	Builds a form to test return values for checkboxes.
FormTestClickedButtonForm		class	Drupal\form_test\Form	core/modules/system/tests/modules/form_test/src/Form/FormTestClickedButtonForm.php	Form builder to test button click detection.			1
FormTestColorForm		class	Drupal\form_test\Form	core/modules/system/tests/modules/form_test/src/Form/FormTestColorForm.php	Form constructor for testing #type 'color' elements.			1
FormTestController		class	Drupal\form_test\Controller	core/modules/system/tests/modules/form_test/src/Controller/FormTestController.php	Controller routines for form_test routes.
FormTestControllerObject		class	Drupal\form_test	core/modules/system/tests/modules/form_test/src/FormTestControllerObject.php	Provides a test form object.			1
FormTestDescriptionForm		class	Drupal\form_test\Form	core/modules/system/tests/modules/form_test/src/Form/FormTestDescriptionForm.php	Defines a form for testing form element description display options.			1
FormTestDetailsContainsRequiredTextfieldForm		class	Drupal\form_test\Form	core/modules/system/tests/modules/form_test/src/Form/FormTestDetailsContainsRequiredTextfieldForm.php	Builds a form to test a required textfield within a details element.			1
FormTestDetailsForm		class	Drupal\form_test\Form	core/modules/system/tests/modules/form_test/src/Form/FormTestDetailsForm.php	Builds a simple form to test the #group property on #type 'container'.			1
FormTestDisabledElementsForm		class	Drupal\form_test\Form	core/modules/system/tests/modules/form_test/src/Form/FormTestDisabledElementsForm.php	Builds a form to test disabled elements.		1	1
FormTestEmailForm		class	Drupal\form_test\Form	core/modules/system/tests/modules/form_test/src/Form/FormTestEmailForm.php	Form constructor for testing #type 'email' elements.			1
FormTestEmptySelectForm		class	Drupal\form_test\Form	core/modules/system/tests/modules/form_test/src/Form/FormTestEmptySelectForm.php	Builds a form to test select elements when #options is not an array.			1
FormTestEventSubscriber		class	Drupal\form_test\EventSubscriber	core/modules/system/tests/modules/form_test/src/EventSubscriber/FormTestEventSubscriber.php	Test event subscriber to add new attributes to the request.			2
FormTestFileForm		class	Drupal\form_test\Form	core/modules/system/tests/modules/form_test/src/Form/FormTestFileForm.php	Form constructor for testing #type 'file' elements.		1
FormTestFormStateValuesCleanAdvancedForm		class	Drupal\form_test\Form	core/modules/system/tests/modules/form_test/src/Form/FormTestFormStateValuesCleanAdvancedForm.php	Form builder for \Drupal\Core\Form\FormState::cleanValues() test.			1
FormTestFormStateValuesCleanForm		class	Drupal\form_test\Form	core/modules/system/tests/modules/form_test/src/Form/FormTestFormStateValuesCleanForm.php	Form builder for \Drupal\Core\Form\FormState::cleanValues() test.			1
FormTestGetForm		class	Drupal\form_test\Form	core/modules/system/tests/modules/form_test/src/Form/FormTestGetForm.php	Form to test whether GET forms have a CSRF token.			1

Other projects

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