You are here

Classes, traits, and interfaces in Drupal 10

Primary tabs

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

Name	Type	Namespace	Location	Description	Direct uses	Use statements	Strings
WorkspaceBypassTest	class	Drupal\Tests\workspaces\Functional	core/modules/workspaces/tests/src/Functional/WorkspaceBypassTest.php	Tests access bypass permission controls on workspaces.
WorkspaceCacheContext	class	Drupal\workspaces	core/modules/workspaces/src/WorkspaceCacheContext.php	Defines the WorkspaceCacheContext service, for "per workspace" caching.		1	2
WorkspaceCacheContextTest	class	Drupal\Tests\workspaces\Functional	core/modules/workspaces/tests/src/Functional/WorkspaceCacheContextTest.php	Tests the workspace cache context.
WorkspaceConcurrentEditingTest	class	Drupal\Tests\workspaces\Functional	core/modules/workspaces/tests/src/Functional/WorkspaceConcurrentEditingTest.php	Tests concurrent edits in different workspaces.
WorkspaceConflictException	class	Drupal\workspaces	core/modules/workspaces/src/WorkspaceConflictException.php	An exception thrown when two workspaces are in a conflicting content state.
WorkspaceContentModerationIntegrationTest	class	Drupal\Tests\content_moderation\Functional	core/modules/content_moderation/tests/src/Functional/WorkspaceContentModerationIntegrationTest.php	Tests Workspaces together with Content Moderation.
WorkspaceCRUDTest	class	Drupal\Tests\workspaces\Kernel	core/modules/workspaces/tests/src/Kernel/WorkspaceCRUDTest.php	Tests CRUD operations for workspaces.
WorkspaceDeleteForm	class	Drupal\workspaces\Form	core/modules/workspaces/src/Form/WorkspaceDeleteForm.php	Provides a form for deleting a workspace.
WorkspaceForm	class	Drupal\workspaces\Form	core/modules/workspaces/src/Form/WorkspaceForm.php	Form controller for the workspace edit forms.
WorkspaceFormInterface	interface	Drupal\workspaces\Form	core/modules/workspaces/src/Form/WorkspaceFormInterface.php	Defines interface for workspace forms so they can be easily distinguished.	7	1
WorkspaceIntegrationTest	class	Drupal\Tests\workspaces\Kernel	core/modules/workspaces/tests/src/Kernel/WorkspaceIntegrationTest.php	Tests a complete publishing scenario across different workspaces.
WorkspaceInterface	interface	Drupal\workspaces	core/modules/workspaces/src/WorkspaceInterface.php	Defines an interface for the workspace entity type.	1	9
WorkspaceJsonAnonTest	class	Drupal\Tests\workspaces\Functional\EntityResource	core/modules/workspaces/tests/src/Functional/EntityResource/WorkspaceJsonAnonTest.php	Test workspace entities for unauthenticated JSON requests.
WorkspaceJsonBasicAuthTest	class	Drupal\Tests\workspaces\Functional\EntityResource	core/modules/workspaces/tests/src/Functional/EntityResource/WorkspaceJsonBasicAuthTest.php	Test workspace entities for JSON requests via basic auth.
WorkspaceJsonCookieTest	class	Drupal\Tests\workspaces\Functional\EntityResource	core/modules/workspaces/tests/src/Functional/EntityResource/WorkspaceJsonCookieTest.php	Test workspace entities for JSON requests with cookie authentication.
WorkspaceListBuilder	class	Drupal\workspaces	core/modules/workspaces/src/WorkspaceListBuilder.php	Defines a class to build a listing of workspace entities.
WorkspaceManager	class	Drupal\workspaces	core/modules/workspaces/src/WorkspaceManager.php	Provides the workspace manager.			2
WorkspaceManagerInterface	interface	Drupal\workspaces	core/modules/workspaces/src/WorkspaceManagerInterface.php	Provides an interface for managing Workspaces.	1	13
WorkspaceMergeForm	class	Drupal\workspaces\Form	core/modules/workspaces/src/Form/WorkspaceMergeForm.php	Provides a form that merges the contents for a workspace into another one.			1
WorkspaceMerger	class	Drupal\workspaces	core/modules/workspaces/src/WorkspaceMerger.php	Default implementation of the workspace merger.
WorkspaceMergerInterface	interface	Drupal\workspaces	core/modules/workspaces/src/WorkspaceMergerInterface.php	Defines an interface for the workspace merger.	1
WorkspaceMergerTest	class	Drupal\Tests\workspaces\Kernel	core/modules/workspaces/tests/src/Kernel/WorkspaceMergerTest.php	Tests workspace merging.
WorkspaceNegotiatorInterface	interface	Drupal\workspaces\Negotiator	core/modules/workspaces/src/Negotiator/WorkspaceNegotiatorInterface.php	Workspace negotiators provide a way to get the active workspace.	2	1
WorkspaceOperationFactory	class	Drupal\workspaces	core/modules/workspaces/src/WorkspaceOperationFactory.php	Defines a factory class for workspace operations.		2	2
WorkspaceOperationInterface	interface	Drupal\workspaces	core/modules/workspaces/src/WorkspaceOperationInterface.php	Defines an interface for workspace operations.	2
WorkspacePermissionsTest	class	Drupal\Tests\workspaces\Functional	core/modules/workspaces/tests/src/Functional/WorkspacePermissionsTest.php	Tests permission controls on workspaces.
WorkspacePublisher	class	Drupal\workspaces	core/modules/workspaces/src/WorkspacePublisher.php	Default implementation of the workspace publisher.
WorkspacePublisherInterface	interface	Drupal\workspaces	core/modules/workspaces/src/WorkspacePublisherInterface.php	Defines an interface for the workspace publisher.	1
WorkspacePublishForm	class	Drupal\workspaces\Form	core/modules/workspaces/src/Form/WorkspacePublishForm.php	Provides the workspace publishing form.			1
WorkspaceRepository	class	Drupal\workspaces	core/modules/workspaces/src/WorkspaceRepository.php	Provides the default workspace tree lookup operations.			2
WorkspaceRepositoryInterface	interface	Drupal\workspaces	core/modules/workspaces/src/WorkspaceRepositoryInterface.php	Provides an interface for workspace tree lookup operations.	1	2
WorkspaceRequestSubscriber	class	Drupal\workspaces\EventSubscriber	core/modules/workspaces/src/EventSubscriber/WorkspaceRequestSubscriber.php	Provides a event subscriber for setting workspace-specific cache keys.		1	2
WorkspaceRequestSubscriberTest	class	Drupal\Tests\workspaces\Unit	core/modules/workspaces/tests/src/Unit/WorkspaceRequestSubscriberTest.php	@coversDefaultClass \Drupal\workspaces\EventSubscriber\WorkspaceRequestSubscriber
WorkspaceResourceTestBase	abstract class	Drupal\Tests\workspaces\Functional\EntityResource	core/modules/workspaces/tests/src/Functional/EntityResource/WorkspaceResourceTestBase.php	Base class for workspace EntityResource tests.	6
WorkspacesAliasRepository	class	Drupal\workspaces	core/modules/workspaces/src/WorkspacesAliasRepository.php	Provides workspace-specific path alias lookup queries.
WorkspacesContentModerationStateTest	class	Drupal\Tests\content_moderation\Kernel	core/modules/content_moderation/tests/src/Kernel/WorkspacesContentModerationStateTest.php	Tests that Workspaces and Content Moderation work together properly.
WorkspaceSelection	class	Drupal\workspaces\Plugin\EntityReferenceSelection	core/modules/workspaces/src/Plugin/EntityReferenceSelection/WorkspaceSelection.php	Provides specific access control for the workspace entity type.
WorkspacesServiceProvider	class	Drupal\workspaces	core/modules/workspaces/src/WorkspacesServiceProvider.php	Defines a service provider for the Workspaces module.
WorkspacesUninstallTest	class	Drupal\Tests\workspaces\Functional	core/modules/workspaces/tests/src/Functional/WorkspacesUninstallTest.php	Tests uninstalling the Workspaces module.
WorkspaceSwitcherBlock	class	Drupal\workspaces\Plugin\Block	core/modules/workspaces/src/Plugin/Block/WorkspaceSwitcherBlock.php	Provides a 'Workspace switcher' block.
WorkspaceSwitcherForm	class	Drupal\workspaces\Form	core/modules/workspaces/src/Form/WorkspaceSwitcherForm.php	Provides a form that activates a different workspace.		1
WorkspaceSwitcherTest	class	Drupal\Tests\workspaces\Functional	core/modules/workspaces/tests/src/Functional/WorkspaceSwitcherTest.php	Tests workspace switching functionality.
WorkspaceTest	class	Drupal\Tests\workspaces\Functional	core/modules/workspaces/tests/src/Functional/WorkspaceTest.php	Test the workspace entity.
WorkspaceTestTrait	trait	Drupal\Tests\workspaces\Kernel	core/modules/workspaces/tests/src/Kernel/WorkspaceTestTrait.php	A trait with common workspaces testing functionality.		1
WorkspaceTestUtilities	trait	Drupal\Tests\workspaces\Functional	core/modules/workspaces/tests/src/Functional/WorkspaceTestUtilities.php	Utility methods for use in BrowserTestBase tests.		1
WorkspaceToolbarIntegrationTest	class	Drupal\Tests\workspaces\FunctionalJavascript	core/modules/workspaces/tests/src/FunctionalJavascript/WorkspaceToolbarIntegrationTest.php	Tests workspace settings stray integration.
WorkspaceViewBuilder	class	Drupal\workspaces	core/modules/workspaces/src/WorkspaceViewBuilder.php	Provides a Workspace view builder.
WorkspaceViewTest	class	Drupal\Tests\workspaces\Functional	core/modules/workspaces/tests/src/Functional/WorkspaceViewTest.php	Tests permission controls on workspaces.
WorkspaceXmlAnonTest	class	Drupal\Tests\workspaces\Functional\EntityResource	core/modules/workspaces/tests/src/Functional/EntityResource/WorkspaceXmlAnonTest.php	Test workspace entities for unauthenticated XML requests.
WorkspaceXmlBasicAuthTest	class	Drupal\Tests\workspaces\Functional\EntityResource	core/modules/workspaces/tests/src/Functional/EntityResource/WorkspaceXmlBasicAuthTest.php	Test workspace entities for XML requests with cookie authentication.

Pages

Other projects