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
SessionManagerTest class Drupal\Tests\Core\Session core/tests/Drupal/Tests/Core/Session/SessionManagerTest.php Tests Drupal\Core\Session\SessionManager.
SessionTest class Drupal\Tests\system\Functional\Session core/modules/system/tests/src/Functional/Session/SessionTest.php Drupal session handling tests.
SessionTest class Drupal\FunctionalJavascriptTests\Core\Session core/tests/Drupal/FunctionalJavascriptTests/Core/Session/SessionTest.php Tests that sessions don't expire.
SessionTestController class Drupal\session_test\Controller core/modules/system/tests/modules/session_test/src/Controller/SessionTestController.php Controller providing page callbacks for session tests.
SessionTestForm class Drupal\session_test\Form core/modules/system/tests/modules/session_test/src/Form/SessionTestForm.php Form controller for the test config edit forms. 1
SessionTestHooks class Drupal\session_test\Hook core/modules/system/tests/modules/session_test/src/Hook/SessionTestHooks.php Hook implementations for session_test.
SessionTestSubscriber class Drupal\session_test\EventSubscriber core/modules/system/tests/modules/session_test/src/EventSubscriber/SessionTestSubscriber.php Defines a test session subscriber that checks whether the session is empty. 2
SessionTestTrait trait Drupal\Tests core/tests/Drupal/Tests/SessionTestTrait.php Provides methods to generate and get session name in tests. 1
SessionWorkspaceNegotiator class Drupal\workspaces\Negotiator core/modules/workspaces/src/Negotiator/SessionWorkspaceNegotiator.php Defines the session workspace negotiator. 1 2
SetBrowserUrl class Drupal\views\Ajax core/modules/views/src/Ajax/SetBrowserUrl.php AJAX command that sets the browser URL without refreshing the page. 1
SetCustomize class Drupal\shortcut\Form core/modules/shortcut/src/Form/SetCustomize.php Builds the shortcut set customize form. 1
SetDialogOptionCommand class Drupal\Core\Ajax core/lib/Drupal/Core/Ajax/SetDialogOptionCommand.php Defines an AJAX command that sets jQuery UI dialog properties. 1 1
SetDialogTitleCommand class Drupal\Core\Ajax core/lib/Drupal/Core/Ajax/SetDialogTitleCommand.php Defines an AJAX command that sets jQuery UI dialog properties. 1
SetFormCommand class Drupal\views_ui\Ajax core/modules/views_ui/src/Ajax/SetFormCommand.php Provides an AJAX command for setting a form submit URL in modal forms. 1
SetInlineBlockDependency class Drupal\layout_builder\EventSubscriber core/modules/layout_builder/src/EventSubscriber/SetInlineBlockDependency.php An event subscriber that returns an access dependency for inline blocks. 1
SetProperties final class Drupal\Core\Config\Action\Plugin\ConfigAction core/lib/Drupal/Core/Config/Action/Plugin/ConfigAction/SetProperties.php @internal This API is experimental.
SetSubtreesCommand class Drupal\toolbar\Ajax core/modules/toolbar/src/Ajax/SetSubtreesCommand.php Defines an AJAX command that sets the toolbar subtrees. 1
SettableDiscoveryExtensionListTrait trait Drupal\Tests\Core\Extension core/tests/Drupal/Tests/Core/Extension/ThemeExtensionListTest.php Trait that allows extension discovery to be set.
SetterInjection class Drupal\new_dependency_test core/modules/system/tests/modules/new_dependency_test/src/SetterInjection.php Generic service which uses setter injection. 2
Settings final class Drupal\admin core/themes/admin/src/Settings.php Service to handle overridden user settings. 3
Settings final class Drupal\default_admin core/themes/default_admin/src/Settings.php Service to handle overridden user settings. 3
Settings final class Drupal\Core\Site core/lib/Drupal/Core/Site/Settings.php Read only settings that are initialized with the class. 158 2
SettingsAnnotation class Drupal\Tests\Component\Annotation\Doctrine core/tests/Drupal/Tests/Component/Annotation/Doctrine/DocParserTest.php
SettingsCommand class Drupal\Core\Ajax core/lib/Drupal/Core/Ajax/SettingsCommand.php AJAX command for adjusting Drupal's JavaScript settings. 3
SettingsConfigValidationTest class Drupal\Tests\image\Kernel core/modules/image/tests/src/Kernel/SettingsConfigValidationTest.php Tests Settings Config Validation.
SettingsEditor final class Drupal\Core\Site core/lib/Drupal/Core/Site/SettingsEditor.php Generates settings.php files for Drupal installations. 3
SettingsForm class Drupal\media_library\Form core/modules/media_library/src/Form/SettingsForm.php Defines a form for configuring the Media Library module. 1 1
SettingsForm final class Drupal\navigation\Form core/modules/navigation/src/Form/SettingsForm.php Configure Navigation settings for this site. 1
SettingsFormTest class Drupal\Tests\media_library\Functional core/modules/media_library/tests/src/Functional/SettingsFormTest.php Tests the Media Library settings form.
SettingsFormTest class Drupal\Tests\jsonapi\Functional core/modules/jsonapi/tests/src/Functional/SettingsFormTest.php Tests Settings Form.
SettingsRewriteTest class Drupal\KernelTests\Core\Site core/tests/Drupal/KernelTests/Core/Site/SettingsRewriteTest.php Tests the SettingsEditor::rewrite() function.
SettingsTest class Drupal\Tests\Core\Site core/tests/Drupal/Tests/Core/Site/SettingsTest.php Tests Drupal\Core\Site\Settings.
SettingsTest class Drupal\Tests\views_ui\Functional core/modules/views_ui/tests/src/Functional/SettingsTest.php Tests all ui related settings under admin/structure/views/settings.
SettingsTest class Drupal\Tests\migrate_drupal_ui\FunctionalJavascript core/modules/migrate_drupal_ui/tests/src/FunctionalJavascript/SettingsTest.php Tests migrate upgrade credential form with settings in settings.php.
SettingsTrayBlockFormTest class Drupal\Tests\settings_tray\FunctionalJavascript core/modules/settings_tray/tests/src/FunctionalJavascript/SettingsTrayBlockFormTest.php Testing opening and saving block forms in the off-canvas dialog.
SettingsTrayFormAnnotationIsClassBlock class Drupal\settings_tray_test\Plugin\Block core/modules/settings_tray/tests/modules/settings_tray_test/src/Plugin/Block/SettingsTrayFormAnnotationIsClassBlock.php Block that explicitly provides a "settings_tray" form class. 1
SettingsTrayFormAnnotationIsClassBlockForm class Drupal\settings_tray_test\Form core/modules/settings_tray/tests/modules/settings_tray_test/src/Form/SettingsTrayFormAnnotationIsClassBlockForm.php 1
SettingsTrayFormAnnotationIsFalseBlock class Drupal\settings_tray_test\Plugin\Block core/modules/settings_tray/tests/modules/settings_tray_test/src/Plugin/Block/SettingsTrayFormAnnotationIsFalseBlock.php Block that explicitly provides no "settings_tray" form, thus opting out.
SettingsTrayFormAnnotationNoneBlock class Drupal\settings_tray_test\Plugin\Block core/modules/settings_tray/tests/modules/settings_tray_test/src/Plugin/Block/SettingsTrayFormAnnotationNoneBlock.php Block that does nothing explicit for Settings Tray. 1
SettingsTrayHooks class Drupal\settings_tray\Hook core/modules/settings_tray/src/Hook/SettingsTrayHooks.php Hook implementations for settings_tray.
SettingsTrayTest class Drupal\Tests\settings_tray\Functional core/modules/settings_tray/tests/src/Functional/SettingsTrayTest.php Tests opening and saving block forms in the off-canvas dialog.
SettingsTrayTestBase abstract class Drupal\Tests\settings_tray\FunctionalJavascript core/modules/settings_tray/tests/src/FunctionalJavascript/SettingsTrayTestBase.php Base class for Settings Tray tests. 3
SettingsTrayTestCssHooks class Drupal\settings_tray_test_css\Hook core/modules/settings_tray/tests/modules/settings_tray_test_css/src/Hook/SettingsTrayTestCssHooks.php Hook implementations for settings_tray_test_css.
SettingsTrayThemeHooks class Drupal\settings_tray\Hook core/modules/settings_tray/src/Hook/SettingsTrayThemeHooks.php Hook implementations for settings_tray.
SettingSummariesContentTypeTest class Drupal\Tests\node\FunctionalJavascript core/modules/node/tests/src/FunctionalJavascript/SettingSummariesContentTypeTest.php Tests the JavaScript updating of summaries on content type form.
SettingsValidator final class Drupal\package_manager\Validator core/modules/package_manager/src/Validator/SettingsValidator.php Checks that Drupal's settings are valid for Package Manager. 1
SettingsValidatorTest class Drupal\Tests\package_manager\Kernel core/modules/package_manager/tests/src/Kernel/SettingsValidatorTest.php Tests Settings Validator.
ShapeItem class Drupal\entity_test\Plugin\Field\FieldType core/modules/system/tests/modules/entity_test/src/Plugin/Field/FieldType/ShapeItem.php Defines the 'shape' field type. 1
ShapeItemRequired class Drupal\entity_test\Plugin\Field\FieldType core/modules/system/tests/modules/entity_test/src/Plugin/Field/FieldType/ShapeItemRequired.php Defines the 'shape_required' field type.
ShapeItemTest class Drupal\Tests\field\Kernel core/modules/field/tests/src/Kernel/ShapeItemTest.php Tests the new entity API for the shape field type.

Other projects

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