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

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
AggregatorRefresh class Drupal\aggregator\Plugin\QueueWorker core/modules/aggregator/src/Plugin/QueueWorker/AggregatorRefresh.php Updates a feed's items.
AggregatorRenderingTest class Drupal\Tests\aggregator\Functional core/modules/aggregator/tests/src/Functional/AggregatorRenderingTest.php Tests display of aggregator items on the page.
AggregatorTestBase abstract class Drupal\Tests\aggregator\Functional core/modules/aggregator/tests/src/Functional/AggregatorTestBase.php Defines a base class for testing the Aggregator module. 15
AggregatorTestRssController class Drupal\aggregator_test\Controller core/modules/aggregator/tests/modules/aggregator_test/src/Controller/AggregatorTestRssController.php Controller for the aggregator_test module.
AggregatorTitleFormatter class Drupal\aggregator\Plugin\Field\FieldFormatter core/modules/aggregator/src/Plugin/Field/FieldFormatter/AggregatorTitleFormatter.php Plugin implementation of the 'aggregator_title' formatter.
AggregatorTitleTest class Drupal\Tests\aggregator\Kernel core/modules/aggregator/tests/src/Kernel/AggregatorTitleTest.php Tests the aggregator_title formatter.
AggregatorXSSFormatter class Drupal\aggregator\Plugin\Field\FieldFormatter core/modules/aggregator/src/Plugin/Field/FieldFormatter/AggregatorXSSFormatter.php Plugin implementation of the 'aggregator_xss' formatter.
Ajax class Drupal\Core\Render\Element core/lib/Drupal/Core/Render/Element/Ajax.php Provides a render element for adding Ajax to a render element.
AjaxBasePageNegotiator class Drupal\Core\Theme core/lib/Drupal/Core/Theme/AjaxBasePageNegotiator.php Defines a theme negotiator that deals with the active theme on ajax requests. 1 2
AjaxBasePageNegotiatorTest class Drupal\Tests\Core\Theme core/tests/Drupal/Tests/Core/Theme/AjaxBasePageNegotiatorTest.php @coversDefaultClass \Drupal\Core\Theme\AjaxBasePageNegotiator @group Theme
AjaxBlockTest class Drupal\Tests\layout_builder\FunctionalJavascript core/modules/layout_builder/tests/src/FunctionalJavascript/AjaxBlockTest.php Ajax blocks tests.
AjaxCallbacksTest class Drupal\FunctionalJavascriptTests\Ajax core/tests/Drupal/FunctionalJavascriptTests/Ajax/AjaxCallbacksTest.php Tests Ajax callbacks on FAPI elements.
AjaxCommandsTest class Drupal\Tests\Core\Ajax core/tests/Drupal/Tests/Core/Ajax/AjaxCommandsTest.php Test coverage for various classes in the \Drupal\Core\Ajax namespace.
AjaxCssForm class Drupal\ckeditor_test\Form core/modules/ckeditor/tests/modules/src/Form/AjaxCssForm.php A form for testing delivery of CSS to CKEditor via AJAX. 1
AjaxCssTest class Drupal\Tests\ckeditor\FunctionalJavascript core/modules/ckeditor/tests/src/FunctionalJavascript/AjaxCssTest.php Tests delivery of CSS to CKEditor via AJAX.
AjaxFileManagedMultipleTest class Drupal\Tests\file\FunctionalJavascript core/modules/file/tests/src/FunctionalJavascript/AjaxFileManagedMultipleTest.php Tests ajax upload to managed files.
AjaxFormBlock class Drupal\ajax_forms_test\Plugin\Block core/modules/system/tests/modules/ajax_forms_test/src/Plugin/Block/AjaxFormBlock.php Provides an AJAX form block.
AjaxFormCacheTest class Drupal\FunctionalJavascriptTests\Ajax core/tests/Drupal/FunctionalJavascriptTests/Ajax/AjaxFormCacheTest.php Tests the usage of form caching for AJAX forms.
AjaxFormHelperTrait trait Drupal\Core\Ajax core/lib/Drupal/Core/Ajax/AjaxFormHelperTrait.php Provides a helper to for submitting an AJAX form. 5
AjaxFormImageButtonTest class Drupal\FunctionalJavascriptTests\Ajax core/tests/Drupal/FunctionalJavascriptTests/Ajax/AjaxFormImageButtonTest.php Tests the Ajax image buttons work with key press events.
AjaxFormPageCacheTest class Drupal\FunctionalJavascriptTests\Ajax core/tests/Drupal/FunctionalJavascriptTests/Ajax/AjaxFormPageCacheTest.php Performs tests on AJAX forms in cached pages.
AjaxFormsTestAjaxElementsForm class Drupal\ajax_forms_test\Form core/modules/system/tests/modules/ajax_forms_test/src/Form/AjaxFormsTestAjaxElementsForm.php Builds a form where each Form API element triggers a simple Ajax callback. 1
AjaxFormsTestCommandsForm class Drupal\ajax_forms_test\Form core/modules/system/tests/modules/ajax_forms_test/src/Form/AjaxFormsTestCommandsForm.php Form constructor for the Ajax Command display form. 1
AjaxFormsTestImageButtonForm class Drupal\ajax_forms_test\Form core/modules/system/tests/modules/ajax_forms_test/src/Form/AjaxFormsTestImageButtonForm.php Form builder: Builds a form that has image button with an ajax callback. 1
AjaxFormsTestLazyLoadForm class Drupal\ajax_forms_test\Form core/modules/system/tests/modules/ajax_forms_test/src/Form/AjaxFormsTestLazyLoadForm.php Form builder: Builds a form that triggers a simple AJAX callback. 1
AjaxFormsTestSimpleForm class Drupal\ajax_forms_test\Form core/modules/system/tests/modules/ajax_forms_test/src/Form/AjaxFormsTestSimpleForm.php Form builder: Builds a form that triggers a simple AJAX callback. 1
AjaxFormsTestValidationForm class Drupal\ajax_forms_test\Form core/modules/system/tests/modules/ajax_forms_test/src/Form/AjaxFormsTestValidationForm.php Form builder: Builds a form that triggers a simple AJAX callback. 1
AjaxHelperTrait trait Drupal\Core\Ajax core/lib/Drupal/Core/Ajax/AjaxHelperTrait.php Provides a helper to determine if the current request is via AJAX. 5
AjaxInGroupTest class Drupal\FunctionalJavascriptTests\Ajax core/tests/Drupal/FunctionalJavascriptTests/Ajax/AjaxInGroupTest.php Tests that form elements in groups work correctly with AJAX.
AjaxPageStateTest class Drupal\Tests\system\Functional\Render core/modules/system/tests/src/Functional/Render/AjaxPageStateTest.php Performs tests for the effects of the ajax_page_state query parameter.
AjaxRenderer class Drupal\Core\Render\MainContent core/lib/Drupal/Core/Render/MainContent/AjaxRenderer.php Default main content renderer for Ajax requests. 1 2
AjaxRendererTest class Drupal\Tests\Core\Controller core/tests/Drupal/Tests/Core/Controller/AjaxRendererTest.php @coversDefaultClass \Drupal\Core\Render\MainContent\AjaxRenderer @group Ajax
AjaxResponse class Drupal\Core\Ajax core/lib/Drupal/Core/Ajax/AjaxResponse.php JSON response object for AJAX requests. 1 45
AjaxResponseAttachmentsProcessor class Drupal\Core\Ajax core/lib/Drupal/Core/Ajax/AjaxResponseAttachmentsProcessor.php Processes attachments of AJAX responses. 2
AjaxResponseSubscriber class Drupal\Core\EventSubscriber core/lib/Drupal/Core/EventSubscriber/AjaxResponseSubscriber.php Response subscriber to handle AJAX responses. 7 2
AjaxResponseTest class Drupal\Tests\Core\Ajax core/tests/Drupal/Tests/Core/Ajax/AjaxResponseTest.php @coversDefaultClass \Drupal\Core\Ajax\AjaxResponse @group Ajax
AjaxTest class Drupal\FunctionalJavascriptTests\Ajax core/tests/Drupal/FunctionalJavascriptTests/Ajax/AjaxTest.php Tests AJAX responses.
AjaxTestCommandReturnPromise class Drupal\ajax_test\Ajax core/modules/system/tests/modules/ajax_test/src/Ajax/AjaxTestCommandReturnPromise.php Test Ajax command. 1
AjaxTestController class Drupal\ajax_test\Controller core/modules/system/tests/modules/ajax_test/src/Controller/AjaxTestController.php Provides content for dialog tests. 3
AjaxTestDialogForm class Drupal\ajax_test\Form core/modules/system/tests/modules/ajax_test/src/Form/AjaxTestDialogForm.php Dummy form for testing DialogRenderer with _form routes.
AjaxTestFocusFirstForm class Drupal\ajax_test\Form core/modules/system/tests/modules/ajax_test/src/Form/AjaxTestFocusFirstForm.php Form for testing AJAX FocusFirstCommand. 1
AjaxTestForm class Drupal\ajax_test\Form core/modules/system/tests/modules/ajax_test/src/Form/AjaxTestForm.php Dummy form for testing DialogRenderer with _form routes. 1
AjaxTestFormPromise class Drupal\ajax_test\Form core/modules/system/tests/modules/ajax_test/src/Form/AjaxTestFormPromise.php Test form for ajax_test_form_promise. 1
AjaxTestImageEffect class Drupal\image_module_test\Plugin\ImageEffect core/modules/image/tests/modules/image_module_test/src/Plugin/ImageEffect/AjaxTestImageEffect.php Provides a test effect using Ajax in the configuration form.
AjaxTestMessageCommandForm class Drupal\ajax_test\Form core/modules/system/tests/modules/ajax_test/src/Form/AjaxTestMessageCommandForm.php Form for testing AJAX MessageCommand. 1
AlertCommand class Drupal\Core\Ajax core/lib/Drupal/Core/Ajax/AlertCommand.php AJAX command for a javascript alert box. 6
AliasingResourceTypeRepository class Drupal\jsonapi_test_field_aliasing\ResourceType core/modules/jsonapi/tests/modules/jsonapi_test_field_aliasing/src/ResourceType/AliasingResourceTypeRepository.php Provides a repository of resource types with field names that can be aliased. 2
AliasManager class Drupal\path_alias core/modules/path_alias/src/AliasManager.php The default alias manager implementation. 3 2
AliasManagerInterface interface Drupal\path_alias core/modules/path_alias/src/AliasManagerInterface.php Find an alias for a path and vice versa. 2 11
AliasManagerTest class Drupal\Tests\path_alias\Unit core/modules/path_alias/tests/src/Unit/AliasManagerTest.php @coversDefaultClass \Drupal\path_alias\AliasManager @group path_alias

Other projects

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