Classes, traits, and interfaces - main - drupal

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

File

core/core.api.php, line 1529

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
WorkspacePublisherTest class Drupal\Tests\workspaces\Kernel core/modules/workspaces/tests/src/Kernel/WorkspacePublisherTest.php Tests workspace publishing.
WorkspacePublishEvent abstract class Drupal\workspaces\Event core/modules/workspaces/src/Event/WorkspacePublishEvent.php Defines the workspace publish event. 2 2
WorkspacePublishException class Drupal\workspaces core/modules/workspaces/src/WorkspacePublishException.php An exception thrown when a workspace can not be published. 2
WorkspacePublishForm class Drupal\workspaces_ui\Form core/modules/workspaces_ui/src/Form/WorkspacePublishForm.php Provides the workspace publishing form. 1 1
WorkspaceQueryParameterNegotiatorTest class Drupal\Tests\workspaces\Kernel core/modules/workspaces/tests/src/Kernel/WorkspaceQueryParameterNegotiatorTest.php Tests the query parameter workspace negotiator.
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 3
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 Tests Drupal\workspaces\EventSubscriber\WorkspaceRequestSubscriber.
WorkspaceResourceTestBase abstract class Drupal\Tests\workspaces\Functional\Rest core/modules/workspaces/tests/src/Functional/Rest/WorkspaceResourceTestBase.php Base class for workspace EntityResource tests. 6
WorkspaceSafeFormInterface interface Drupal\Core\Form core/lib/Drupal/Core/Form/WorkspaceSafeFormInterface.php Defines an interface for forms that are safe to be submitted in a workspace. 25 27
WorkspaceSafeFormTrait trait Drupal\layout_builder\Form core/modules/layout_builder/src/Form/WorkspaceSafeFormTrait.php Provides a trait that marks Layout Builder forms as workspace-safe.
WorkspaceSafeFormTrait trait Drupal\Core\Entity\Form core/lib/Drupal/Core/Entity/Form/WorkspaceSafeFormTrait.php Provides helpers for checking whether objects in forms are workspace-safe. 2
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.
WorkspacesCron class Drupal\workspaces core/modules/workspaces/src/WorkspacesCron.php Decorates the cron service.
WorkspaceSelection class Drupal\workspaces\Plugin\EntityReferenceSelection core/modules/workspaces/src/Plugin/EntityReferenceSelection/WorkspaceSelection.php Provides specific access control for the workspace entity type.
WorkspacesEntityRepository class Drupal\workspaces core/modules/workspaces/src/WorkspacesEntityRepository.php Provides workspace-specific mechanisms for retrieving entities. 2
WorkspacesFileItemTest class Drupal\Tests\workspaces\Kernel core/modules/workspaces/tests/src/Kernel/WorkspacesFileItemTest.php Tests using entity fields of the file field type in a workspace.
WorkspacesHooks class Drupal\workspaces\Hook core/modules/workspaces/src/Hook/WorkspacesHooks.php Hook implementations for workspaces. 1
WorkspacesHtmlEntityFormController class Drupal\workspaces\Controller core/modules/workspaces/src/Controller/WorkspacesHtmlEntityFormController.php Overrides the entity form controller service for workspaces operations. 2
WorkspacesLayoutBuilderIntegrationTest class Drupal\Tests\workspaces\FunctionalJavascript core/modules/workspaces/tests/src/FunctionalJavascript/WorkspacesLayoutBuilderIntegrationTest.php Tests for layout editing in workspaces.
WorkspacesLayoutTempstoreRepository class Drupal\workspaces core/modules/workspaces/src/WorkspacesLayoutTempstoreRepository.php Provides a mechanism for loading workspace-specific layout changes.
WorkspacesLazyBuilder final class Drupal\navigation core/modules/navigation/src/WorkspacesLazyBuilder.php Defines a service for workspaces #lazy_builder callbacks.
WorkspacesMediaLibraryIntegrationTest class Drupal\Tests\workspaces\FunctionalJavascript core/modules/workspaces/tests/src/FunctionalJavascript/WorkspacesMediaLibraryIntegrationTest.php Tests the Media library entity reference widget in a workspace.
WorkspacesMenuTreeStorage class Drupal\workspaces core/modules/workspaces/src/WorkspacesMenuTreeStorage.php Overrides the default menu storage to provide workspace-specific menu links. 2
WorkspacesRequirements class Drupal\workspaces\Install\Requirements core/modules/workspaces/src/Install/Requirements/WorkspacesRequirements.php Install time requirements for the workspaces module.
WorkspacesServiceProvider class Drupal\workspaces core/modules/workspaces/src/WorkspacesServiceProvider.php Defines a service provider for the Workspaces module.
WorkspacesTestHooks class Drupal\workspaces_test\Hook core/modules/workspaces/tests/modules/workspaces_test/src/Hook/WorkspacesTestHooks.php Hook implementations for workspaces_test.
WorkspaceSubscriber class Drupal\content_moderation\EventSubscriber core/modules/content_moderation/src/EventSubscriber/WorkspaceSubscriber.php Checks whether a workspace is publishable, and prevents publishing if needed. 2
WorkspacesUiHooks class Drupal\workspaces_ui\Hook core/modules/workspaces_ui/src/Hook/WorkspacesUiHooks.php Hook implementations for the workspaces_ui module.
WorkspacesUiLazyBuilders final class Drupal\workspaces_ui core/modules/workspaces_ui/src/WorkspacesUiLazyBuilders.php Defines a service for workspaces #lazy_builder callbacks. 2
WorkspacesUninstallTest class Drupal\Tests\workspaces\Functional core/modules/workspaces/tests/src/Functional/WorkspacesUninstallTest.php Tests uninstalling the Workspaces module.
WorkspaceSwitcherBlock class Drupal\workspaces_ui\Plugin\Block core/modules/workspaces_ui/src/Plugin/Block/WorkspaceSwitcherBlock.php Provides a 'Workspace switcher' block.
WorkspaceSwitcherForm class Drupal\workspaces_ui\Form core/modules/workspaces_ui/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.
WorkspaceSwitchEvent class Drupal\workspaces\Event core/modules/workspaces/src/Event/WorkspaceSwitchEvent.php Defines the workspace switch event. 3
WorkspaceSwitchSubscriber class Drupal\workspaces\EventSubscriber core/modules/workspaces/src/EventSubscriber/WorkspaceSwitchSubscriber.php Provides a event subscriber for reacting to workspace activation.
WorkspaceTest class Drupal\Tests\workspaces\Functional core/modules/workspaces/tests/src/Functional/WorkspaceTest.php Test the workspace entity.
WorkspaceTest class Drupal\Tests\jsonapi\Functional core/modules/jsonapi/tests/src/Functional/WorkspaceTest.php JSON:API integration test for the "Workspace" content entity type.
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. 2
WorkspaceToolbarIntegrationTest class Drupal\Tests\workspaces_ui\FunctionalJavascript core/modules/workspaces_ui/tests/src/FunctionalJavascript/WorkspaceToolbarIntegrationTest.php Tests workspace settings stray integration.
WorkspaceTracker class Drupal\workspaces core/modules/workspaces/src/WorkspaceTracker.php Provides a class for CRUD operations on workspace associations. 4 2
WorkspaceTrackerInterface interface Drupal\workspaces core/modules/workspaces/src/WorkspaceTrackerInterface.php Defines an interface for the workspace tracker service. 1 6
WorkspaceTrackerTest class Drupal\Tests\workspaces\Kernel core/modules/workspaces/tests/src/Kernel/WorkspaceTrackerTest.php Tests workspace tracker.
WorkspaceViewBuilder class Drupal\workspaces_ui core/modules/workspaces_ui/src/WorkspaceViewBuilder.php Provides a Workspace view builder. 1
WorkspaceViewsBulkFormTest class Drupal\Tests\workspaces\Functional core/modules/workspaces/tests/src/Functional/WorkspaceViewsBulkFormTest.php Tests the views bulk form in a workspace.
WorkspaceViewsIntegrationTest class Drupal\Tests\workspaces\Kernel core/modules/workspaces/tests/src/Kernel/WorkspaceViewsIntegrationTest.php Tests the views integration for workspaces.
WorkspaceViewTest class Drupal\Tests\workspaces\Functional core/modules/workspaces/tests/src/Functional/WorkspaceViewTest.php Tests permission controls on workspaces.

Other projects


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