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
LayoutBuilderCompatibilityTestBase		abstract class	Drupal\Tests\layout_builder\Kernel	core/modules/layout_builder/tests/src/Kernel/LayoutBuilderCompatibilityTestBase.php	Tests Layout Builder's compatibility with existing systems.	3	1
LayoutBuilderContentModerationIntegrationTest		class	Drupal\Tests\content_moderation\Functional	core/modules/content_moderation/tests/src/Functional/LayoutBuilderContentModerationIntegrationTest.php	Tests Content Moderation's integration with Layout Builder.
LayoutBuilderContextTrait		trait	Drupal\layout_builder\Context	core/modules/layout_builder/src/Context/LayoutBuilderContextTrait.php	Provides a wrapper around getting contexts from a section storage object.		6
LayoutBuilderController		class	Drupal\layout_builder\Controller	core/modules/layout_builder/src/Controller/LayoutBuilderController.php	Defines a controller to provide the Layout Builder admin UI.
LayoutBuilderDecorationTestHtmlEntityFormController		class	Drupal\layout_builder_decoration_test\Controller	core/modules/layout_builder/tests/modules/layout_builder_decoration_test/src/Controller/LayoutBuilderDecorationTestHtmlEntityFormController.php	Overrides the entity form controller service for layout builder decoration test.			2
LayoutBuilderDefaultValuesTest		class	Drupal\Tests\layout_builder\Functional	core/modules/layout_builder/tests/src/Functional/LayoutBuilderDefaultValuesTest.php	Tests rendering default field values in Layout Builder.
LayoutBuilderDisableForm		class	Drupal\layout_builder\Form	core/modules/layout_builder/src/Form/LayoutBuilderDisableForm.php	Disables Layout Builder for a given default.
LayoutBuilderDisableInteractionsTest		class	Drupal\Tests\layout_builder\FunctionalJavascript	core/modules/layout_builder/tests/src/FunctionalJavascript/LayoutBuilderDisableInteractionsTest.php	Tests the Layout Builder disables interactions of rendered blocks.
LayoutBuilderEnabledInterface		interface	Drupal\layout_builder	core/modules/layout_builder/src/LayoutBuilderEnabledInterface.php	Provides methods for enabling and disabling Layout Builder.	2	1
LayoutBuilderEntityFormTrait		trait	Drupal\layout_builder\Form	core/modules/layout_builder/src/Form/LayoutBuilderEntityFormTrait.php	Provides a trait for common methods used in Layout Builder entity forms.		1
LayoutBuilderEntityViewDisplay		class	Drupal\layout_builder\Entity	core/modules/layout_builder/src/Entity/LayoutBuilderEntityViewDisplay.php	Provides an entity view display entity that has a layout.		37
LayoutBuilderEntityViewDisplayForm		class	Drupal\layout_builder\Form	core/modules/layout_builder/src/Form/LayoutBuilderEntityViewDisplayForm.php	Edit form for the LayoutBuilderEntityViewDisplay entity type.		1
LayoutBuilderEntityViewDisplayJsonAnonTest		class	Drupal\Tests\layout_builder\Functional\Rest	core/modules/layout_builder/tests/src/Functional/Rest/LayoutBuilderEntityViewDisplayJsonAnonTest.php	@group layout_builder @group rest
LayoutBuilderEntityViewDisplayJsonBasicAuthTest		class	Drupal\Tests\layout_builder\Functional\Rest	core/modules/layout_builder/tests/src/Functional/Rest/LayoutBuilderEntityViewDisplayJsonBasicAuthTest.php	@group layout_builder @group rest
LayoutBuilderEntityViewDisplayJsonCookieTest		class	Drupal\Tests\layout_builder\Functional\Rest	core/modules/layout_builder/tests/src/Functional/Rest/LayoutBuilderEntityViewDisplayJsonCookieTest.php	@group layout_builder @group rest
LayoutBuilderEntityViewDisplayResourceTestBase		abstract class	Drupal\Tests\layout_builder\Functional\Rest	core/modules/layout_builder/tests/src/Functional/Rest/LayoutBuilderEntityViewDisplayResourceTestBase.php	Provides a base class for testing LayoutBuilderEntityViewDisplay resources.	6
LayoutBuilderEntityViewDisplayStorage		class	Drupal\layout_builder\Entity	core/modules/layout_builder/src/Entity/LayoutBuilderEntityViewDisplayStorage.php	Provides storage for entity view display entities that have layouts.		1
LayoutBuilderEntityViewDisplayTest		class	Drupal\Tests\layout_builder\Kernel	core/modules/layout_builder/tests/src/Kernel/LayoutBuilderEntityViewDisplayTest.php	@coversDefaultClass \Drupal\layout_builder\Entity\LayoutBuilderEntityViewDisplay[[api-linebreak]]
LayoutBuilderEntityViewDisplayTest		class	Drupal\Tests\layout_builder\Functional\Jsonapi	core/modules/layout_builder/tests/src/Functional/Jsonapi/LayoutBuilderEntityViewDisplayTest.php	JSON:API integration test for the "EntityViewDisplay" config entity type.
LayoutBuilderEntityViewDisplayValidationTest		class	Drupal\Tests\layout_builder\Kernel	core/modules/layout_builder/tests/src/Kernel/LayoutBuilderEntityViewDisplayValidationTest.php	Tests validation of Layout Builder's entity_view_display entities.
LayoutBuilderEntityViewDisplayXmlAnonTest		class	Drupal\Tests\layout_builder\Functional\Rest	core/modules/layout_builder/tests/src/Functional/Rest/LayoutBuilderEntityViewDisplayXmlAnonTest.php	@group layout_builder @group rest
LayoutBuilderEntityViewDisplayXmlBasicAuthTest		class	Drupal\Tests\layout_builder\Functional\Rest	core/modules/layout_builder/tests/src/Functional/Rest/LayoutBuilderEntityViewDisplayXmlBasicAuthTest.php	@group layout_builder @group rest
LayoutBuilderEntityViewDisplayXmlCookieTest		class	Drupal\Tests\layout_builder\Functional\Rest	core/modules/layout_builder/tests/src/Functional/Rest/LayoutBuilderEntityViewDisplayXmlCookieTest.php	@group layout_builder @group rest
LayoutBuilderEvents		final class	Drupal\layout_builder	core/modules/layout_builder/src/LayoutBuilderEvents.php	Defines events for the layout_builder module.		5
LayoutBuilderFieldBlockEntityReferenceCacheTagsTest		class	Drupal\Tests\layout_builder\Functional	core/modules/layout_builder/tests/src/Functional/LayoutBuilderFieldBlockEntityReferenceCacheTagsTest.php	Tests cache tags on entity reference field blocks in Layout Builder.
LayoutBuilderFieldLayoutCompatibilityTest		class	Drupal\Tests\layout_builder\Kernel	core/modules/layout_builder/tests/src/Kernel/LayoutBuilderFieldLayoutCompatibilityTest.php	Ensures that Layout Builder and Field Layout are compatible with each other.
LayoutBuilderFormModeTest		class	Drupal\Tests\layout_builder\Functional	core/modules/layout_builder/tests/src/Functional/LayoutBuilderFormModeTest.php	Tests Layout Builder forms.
LayoutBuilderHighlightTrait		trait	Drupal\layout_builder	core/modules/layout_builder/src/LayoutBuilderHighlightTrait.php	A trait for generating IDs used to highlight active UI elements.		8
LayoutBuilderHtmlEntityFormController		class	Drupal\layout_builder\Controller	core/modules/layout_builder/src/Controller/LayoutBuilderHtmlEntityFormController.php	Overrides the entity form controller service for layout builder operations.			2
LayoutBuilderInstallTest		class	Drupal\Tests\layout_builder\Kernel	core/modules/layout_builder/tests/src/Kernel/LayoutBuilderInstallTest.php	Ensures that Layout Builder and core EntityViewDisplays are compatible.
LayoutBuilderIsActiveCacheContext		class	Drupal\layout_builder\Cache	core/modules/layout_builder/src/Cache/LayoutBuilderIsActiveCacheContext.php	Determines whether Layout Builder is active for a given entity type or not.		1	2
LayoutBuilderIsActiveCacheContextTest		class	Drupal\Tests\layout_builder\Unit	core/modules/layout_builder/tests/src/Unit/LayoutBuilderIsActiveCacheContextTest.php	@coversDefaultClass \Drupal\layout_builder\Cache\LayoutBuilderIsActiveCacheContext[[api-linebreak]]
LayoutBuilderLocalTaskDeriver		class	Drupal\layout_builder\Plugin\Derivative	core/modules/layout_builder/src/Plugin/Derivative/LayoutBuilderLocalTaskDeriver.php	Provides local task definitions for the layout builder user interface.			1
LayoutBuilderLocalTaskTest		class	Drupal\Tests\layout_builder\Functional	core/modules/layout_builder/tests/src/Functional/LayoutBuilderLocalTaskTest.php	Tests Layout Builder local tasks.
LayoutBuilderNestedFormUiTest		class	Drupal\Tests\layout_builder\FunctionalJavascript	core/modules/layout_builder/tests/src/FunctionalJavascript/LayoutBuilderNestedFormUiTest.php	Tests placing blocks containing forms in theLayout Builder UI.
LayoutBuilderOptInTest		class	Drupal\Tests\layout_builder\FunctionalJavascript	core/modules/layout_builder/tests/src/FunctionalJavascript/LayoutBuilderOptInTest.php	Tests the ability for opting in and out of Layout Builder.
LayoutBuilderOverridableInterface		interface	Drupal\layout_builder	core/modules/layout_builder/src/LayoutBuilderOverridableInterface.php	Provides an interface for displays that could be overridable.	2	1
LayoutBuilderOverridesEditingThemeTest		class	Drupal\Tests\layout_builder\Functional	core/modules/layout_builder/tests/src/Functional/LayoutBuilderOverridesEditingThemeTest.php	Tests overrides editing uses the correct theme.
LayoutBuilderOverridesPermissions		class	Drupal\layout_builder	core/modules/layout_builder/src/LayoutBuilderOverridesPermissions.php	Provides dynamic permissions for Layout Builder overrides.
LayoutBuilderOverridesTest		class	Drupal\Tests\layout_builder\Functional	core/modules/layout_builder/tests/src/Functional/LayoutBuilderOverridesTest.php	Tests the Layout Builder UI.
LayoutBuilderPrepareLayoutTest		class	Drupal\Tests\layout_builder\Functional	core/modules/layout_builder/tests/src/Functional/LayoutBuilderPrepareLayoutTest.php	Tests the ability to alter a layout builder element while preparing.
LayoutBuilderRoutes		class	Drupal\layout_builder\Routing	core/modules/layout_builder/src/Routing/LayoutBuilderRoutes.php	Provides routes for the Layout Builder UI.		1	2
LayoutBuilderRoutesTest		class	Drupal\Tests\layout_builder\Unit	core/modules/layout_builder/tests/src/Unit/LayoutBuilderRoutesTest.php	@coversDefaultClass \Drupal\layout_builder\Routing\LayoutBuilderRoutes[[api-linebreak]]
LayoutBuilderRoutesTrait		trait	Drupal\layout_builder\Routing	core/modules/layout_builder/src/Routing/LayoutBuilderRoutesTrait.php	Provides a trait for building routes for a Layout Builder UI.		3
LayoutBuilderSampleEntityGenerator		class	Drupal\layout_builder\Entity	core/modules/layout_builder/src/Entity/LayoutBuilderSampleEntityGenerator.php	Generates a sample entity for use by the Layout Builder.			2
LayoutBuilderSectionStorageTest		class	Drupal\Tests\layout_builder\Functional	core/modules/layout_builder/tests/src/Functional/LayoutBuilderSectionStorageTest.php	Tests the UI aspects of section storage.
LayoutBuilderServiceProvider		class	Drupal\layout_builder	core/modules/layout_builder/src/LayoutBuilderServiceProvider.php	Sets the layout_builder.get_block_dependency_subscriber service definition.
LayoutBuilderSortTrait		trait	Drupal\Tests\layout_builder\FunctionalJavascript	core/modules/layout_builder/tests/src/FunctionalJavascript/LayoutBuilderSortTrait.php	LayoutBuilderSortTrait, provides callback for simulated layout change.		1
LayoutBuilderTest		class	Drupal\Tests\layout_builder\FunctionalJavascript	core/modules/layout_builder/tests/src/FunctionalJavascript/LayoutBuilderTest.php	Tests the Layout Builder UI.
LayoutBuilderTest		class	Drupal\Tests\layout_builder\Functional	core/modules/layout_builder/tests/src/Functional/LayoutBuilderTest.php	Tests the Layout Builder UI.

Other projects

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