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 |
|---|---|---|---|---|---|---|---|---|
| LayoutBuilderEvents | final class | Drupal\layout_builder | core/ |
Defines events for the layout_builder module. | 5 | |||
| LayoutBuilderFieldBlockEntityReferenceCacheTagsTest | class | Drupal\Tests\layout_builder\Functional | core/ |
Tests cache tags on entity reference field blocks in Layout Builder. | ||||
| LayoutBuilderFieldLayoutCompatibilityTest | class | Drupal\Tests\layout_builder\Kernel | core/ |
Ensures that Layout Builder and Field Layout are compatible with each other. | ||||
| LayoutBuilderFormModeTest | class | Drupal\Tests\layout_builder\Functional | core/ |
Tests Layout Builder forms. | ||||
| LayoutBuilderHighlightTrait | trait | Drupal\layout_builder | core/ |
A trait for generating IDs used to highlight active UI elements. | 8 | |||
| LayoutBuilderHtmlEntityFormController | class | Drupal\layout_builder\Controller | core/ |
Overrides the entity form controller service for layout builder operations. | 2 | |||
| LayoutBuilderInstallTest | class | Drupal\Tests\layout_builder\Kernel | core/ |
Ensures that Layout Builder and core EntityViewDisplays are compatible. | ||||
| LayoutBuilderIntegration | class | Drupal\quickedit | core/ |
Helper methods for Layout Builder module integration. | 1 | 3 | ||
| LayoutBuilderIntegrationTest | class | Drupal\Tests\quickedit\FunctionalJavascript | core/ |
@group quickedit @group legacy | ||||
| LayoutBuilderIsActiveCacheContext | class | Drupal\layout_builder\Cache | core/ |
Determines whether Layout Builder is active for a given entity type or not. | 1 | 2 | ||
| LayoutBuilderIsActiveCacheContextTest | class | Drupal\Tests\layout_builder\Unit | core/ |
@coversDefaultClass \Drupal\layout_builder\Cache\LayoutBuilderIsActiveCacheContext[[api-linebreak]] | ||||
| LayoutBuilderLocalTaskDeriver | class | Drupal\layout_builder\Plugin\Derivative | core/ |
Provides local task definitions for the layout builder user interface. | 1 | |||
| LayoutBuilderNestedFormUiTest | class | Drupal\Tests\layout_builder\FunctionalJavascript | core/ |
Tests placing blocks containing forms in theLayout Builder UI. | ||||
| LayoutBuilderOptInTest | class | Drupal\Tests\layout_builder\FunctionalJavascript | core/ |
Tests the ability for opting in and out of Layout Builder. | ||||
| LayoutBuilderOverridesPermissions | class | Drupal\layout_builder | core/ |
Provides dynamic permissions for Layout Builder overrides. | ||||
| LayoutBuilderPrepareLayoutTest | class | Drupal\Tests\layout_builder\Functional | core/ |
Tests the ability to alter a layout builder element while preparing. | ||||
| LayoutBuilderQuickEditTest | class | Drupal\Tests\quickedit\FunctionalJavascript | core/ |
Tests that Layout Builder functions with Quick Edit. | ||||
| LayoutBuilderQuickEditTest | class | Drupal\Tests\quickedit\Functional | core/ |
Tests Layout Builder integration with Quick Edit. | ||||
| LayoutBuilderRoutes | class | Drupal\layout_builder\Routing | core/ |
Provides routes for the Layout Builder UI. | 1 | 2 | ||
| LayoutBuilderRoutesTest | class | Drupal\Tests\layout_builder\Unit | core/ |
@coversDefaultClass \Drupal\layout_builder\Routing\LayoutBuilderRoutes[[api-linebreak]] | ||||
| LayoutBuilderRoutesTrait | trait | Drupal\layout_builder\Routing | core/ |
Provides a trait for building routes for a Layout Builder UI. | 2 | |||
| LayoutBuilderSampleEntityGenerator | class | Drupal\layout_builder\Entity | core/ |
Generates a sample entity for use by the Layout Builder. | 2 | |||
| LayoutBuilderSectionStorageTest | class | Drupal\Tests\layout_builder\Functional | core/ |
Tests the UI aspects of section storage. | ||||
| LayoutBuilderServiceProvider | class | Drupal\layout_builder | core/ |
Sets the layout_builder.get_block_dependency_subscriber service definition. | ||||
| LayoutBuilderSortTrait | trait | Drupal\Tests\layout_builder\FunctionalJavascript | core/ |
LayoutBuilderSortTrait, provides callback for simulated layout change. | ||||
| LayoutBuilderTest | class | Drupal\Tests\layout_builder\FunctionalJavascript | core/ |
Tests the Layout Builder UI. | ||||
| LayoutBuilderTest | class | Drupal\Tests\layout_builder\Functional | core/ |
Tests the Layout Builder UI. | ||||
| LayoutBuilderTestPlugin | class | Drupal\layout_builder_test\Plugin\Layout | core/ |
Plugin annotation @Layout( id = "layout_builder_test_plugin", label = @Translation("Layout Builder Test Plugin"), regions = { "main" = { "label" = @Translation("Main Region") } }, ) | ||||
| LayoutBuilderThemeSuggestionsTest | class | Drupal\Tests\layout_builder\Functional | core/ |
Tests template suggestions. | ||||
| LayoutBuilderToolbarTest | class | Drupal\Tests\layout_builder\FunctionalJavascript | core/ |
Test Layout Builder integration with Toolbar. | ||||
| LayoutBuilderTranslationTest | class | Drupal\Tests\layout_builder\Functional | core/ |
Tests that the Layout Builder works with translated content. | ||||
| LayoutBuilderUiCacheContext | class | Drupal\layout_builder\Cache | core/ |
Determines if an entity is being viewed in the Layout Builder UI. | 2 | |||
| LayoutBuilderUiTest | class | Drupal\Tests\layout_builder\FunctionalJavascript | core/ |
Tests the Layout Builder UI. | ||||
| LayoutBuilderWidget | class | Drupal\layout_builder\Plugin\Field\FieldWidget | core/ |
A widget to display the layout form. | ||||
| LayoutDefault | class | Drupal\Core\Layout | core/ |
Provides a default class for Layout plugins. | 9 | 13 | ||
| LayoutDefaultTest | class | Drupal\Tests\Core\Layout | core/ |
@coversDefaultClass \Drupal\Core\Layout\LayoutDefault[[api-linebreak]] @group Layout | ||||
| LayoutDefinition | class | Drupal\Core\Layout | core/ |
Provides an implementation of a layout definition and its metadata. | 5 | |||
| LayoutDeriver | class | Drupal\Tests\Core\Layout | core/ |
Provides a dynamic layout deriver for the test. | ||||
| LayoutDisplayTest | class | Drupal\Tests\layout_builder\Functional | core/ |
Tests functionality of the entity view display with regard to Layout Builder. | ||||
| LayoutEntityDisplayInterface | interface | Drupal\layout_builder\Entity | core/ |
Provides an interface for entity displays that have layout. | 1 | 8 | ||
| LayoutEntityDisplayNormalizer | class | Drupal\layout_builder\Normalizer | core/ |
Normalizes/denormalizes LayoutEntityDisplay objects into an array structure. | 1 | |||
| LayoutEntityHelperTrait | trait | Drupal\layout_builder | core/ |
Methods to help with entities using the layout builder. | 4 | |||
| LayoutEntityHelperTraitTest | class | Drupal\Tests\layout_builder\Unit | core/ |
@coversDefaultClass \Drupal\layout_builder\LayoutEntityHelperTrait[[api-linebreak]] | ||||
| LayoutEntityHelperTraitTest | class | Drupal\Tests\layout_builder\Kernel | core/ |
@coversDefaultClass \Drupal\layout_builder\LayoutEntityHelperTrait[[api-linebreak]] | ||||
| LayoutInterface | interface | Drupal\Core\Layout | core/ |
Provides an interface for static Layout plugins. | 1 | 7 | ||
| LayoutPluginManager | class | Drupal\Core\Layout | core/ |
Provides a plugin manager for layouts. | 1 | 2 | ||
| LayoutPluginManagerInterface | interface | Drupal\Core\Layout | core/ |
Provides the interface for a plugin manager of layouts. | 1 | 8 | ||
| LayoutPluginManagerTest | class | Drupal\Tests\Core\Layout | core/ |
@coversDefaultClass \Drupal\Core\Layout\LayoutPluginManager[[api-linebreak]] @group Layout | ||||
| LayoutPreviewAccessAllowed | class | Drupal\layout_builder\Access | core/ |
Accessible class to allow access for inline blocks in the Layout Builder. | 2 | |||
| LayoutRebuildConfirmFormBase | abstract class | Drupal\layout_builder\Form | core/ |
Provides a base class for confirmation forms that rebuild the Layout Builder. | 2 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.