Classes, traits, and interfaces - 10.3.x - 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 1518

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
WorkspacePublishForm class Drupal\workspaces\Form core/modules/workspaces/src/Form/WorkspacePublishForm.php Provides the workspace publishing form. 1 1
WorkspacePublishFormTest class Drupal\Tests\workspaces\Kernel core/modules/workspaces/tests/src/Kernel/WorkspacePublishFormTest.php @coversDefaultClass \Drupal\workspaces\Form\WorkspacePublishForm[[api-linebreak]] @group workspaces
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 1
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[[api-linebreak]]
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. 13 15
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
WorkspacesAliasManager class Drupal\workspaces core/modules/workspaces/src/WorkspacesAliasManager.php Decorates the path_alias.manager service for workspace-specific caching.
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.
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.
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.
WorkspacesLazyBuilders final class Drupal\workspaces core/modules/workspaces/src/WorkspacesLazyBuilders.php Defines a service for workspaces #lazy_builder callbacks. 2
WorkspacesMenuTreeStorage class Drupal\workspaces core/modules/workspaces/src/WorkspacesMenuTreeStorage.php Overrides the default menu storage to provide workspace-specific menu links. 2
WorkspacesServiceProvider class Drupal\workspaces core/modules/workspaces/src/WorkspacesServiceProvider.php Defines a service provider for the Workspaces module.
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
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.
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\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.
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.
WorkspaceXmlAnonTest class Drupal\Tests\workspaces\Functional\Rest core/modules/workspaces/tests/src/Functional/Rest/WorkspaceXmlAnonTest.php Test workspace entities for unauthenticated XML requests.
WorkspaceXmlBasicAuthTest class Drupal\Tests\workspaces\Functional\Rest core/modules/workspaces/tests/src/Functional/Rest/WorkspaceXmlBasicAuthTest.php Test workspace entities for XML requests with cookie authentication.
WorkspaceXmlCookieTest class Drupal\Tests\workspaces\Functional\Rest core/modules/workspaces/tests/src/Functional/Rest/WorkspaceXmlCookieTest.php Test workspace entities for XML requests.
WriteSafeSessionHandler class Drupal\Core\Session core/lib/Drupal/Core/Session/WriteSafeSessionHandler.php Wraps the session handler to prevent writes when not necessary or allowed. 1 2
WriteSafeSessionHandlerInterface interface Drupal\Core\Session core/lib/Drupal/Core/Session/WriteSafeSessionHandlerInterface.php Provides an interface for session handlers where writing can be disabled. 1
WriteSafeSessionHandlerTest class Drupal\Tests\Core\Session core/tests/Drupal/Tests/Core/Session/WriteSafeSessionHandlerTest.php Tests \Drupal\Core\Session\WriteSafeSessionHandler.
XdebugRequestTrait trait Drupal\Tests core/tests/Drupal/Tests/XdebugRequestTrait.php 1
XdebugRequestTraitTest class Drupal\Tests\Core\Test core/tests/Drupal/Tests/Core/Test/XdebugRequestTraitTest.php Provides tests for the Xdebug request trait.
XmlEncoder class Drupal\serialization\Encoder core/modules/serialization/src/Encoder/XmlEncoder.php Adds XML support for serializer. 2 2
XmlEncoderTest class Drupal\Tests\serialization\Unit\Encoder core/modules/serialization/tests/src/Unit/Encoder/XmlEncoderTest.php @coversDefaultClass \Drupal\serialization\Encoder\XmlEncoder[[api-linebreak]] @group serialization
XmlEntityNormalizationQuirksTrait trait Drupal\Tests\rest\Functional\EntityResource core/modules/rest/tests/src/Functional/EntityResource/XmlEntityNormalizationQuirksTrait.php Trait for EntityResourceTestBase subclasses testing $format='xml'. 144
XmlNormalizationQuirksTrait trait Drupal\Tests\rest\Functional core/modules/rest/tests/src/Functional/XmlNormalizationQuirksTrait.php Trait for ResourceTestBase subclasses testing $format='xml'. 1
Xss class Drupal\Component\Utility core/lib/Drupal/Component/Utility/Xss.php Provides helper to filter for cross-site scripting. 1 51
XssTest class Drupal\Tests\Component\Utility core/tests/Drupal/Tests/Component/Utility/XssTest.php XSS Filtering tests.
XssTest class Drupal\Tests\views_ui\Functional core/modules/views_ui/tests/src/Functional/XssTest.php Tests the Xss vulnerability.

Other projects


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