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 |
|---|---|---|---|---|---|---|---|---|
| WorkspaceAccessControlHandler | class | Drupal\workspaces | core/ |
Defines the access control handler for the workspace entity type. | ||||
| WorkspaceAccessException | class | Drupal\workspaces | core/ |
Exception thrown when trying to switch to an inaccessible workspace. | 1 | 3 | ||
| WorkspaceAccessTest | class | Drupal\Tests\workspaces\Kernel | core/ |
Tests access on workspaces. | ||||
| WorkspaceActivateForm | class | Drupal\workspaces\Form | core/ |
Handle activation of a workspace on administrative pages. | ||||
| WorkspaceAssociation | class | Drupal\workspaces | core/ |
Provides a class for CRUD operations on workspace associations. | 2 | |||
| WorkspaceAssociationDeprecationTest | class | Drupal\Tests\workspaces\Kernel | core/ |
@coversDefaultClass \Drupal\workspaces\WorkspaceAssociation[[api-linebreak]] @group legacy | ||||
| WorkspaceAssociationInterface | interface | Drupal\workspaces | core/ |
Defines an interface for the workspace_association service. | 1 | 3 | ||
| WorkspaceAssociationTest | class | Drupal\Tests\workspaces\Kernel | core/ |
Tests workspace associations. | ||||
| WorkspaceBypassTest | class | Drupal\Tests\workspaces\Functional | core/ |
Tests access bypass permission controls on workspaces. | ||||
| WorkspaceCacheContext | class | Drupal\workspaces | core/ |
Defines the WorkspaceCacheContext service, for "per workspace" caching. | 1 | 2 | ||
| WorkspaceCacheContextTest | class | Drupal\Tests\workspaces\Functional | core/ |
Tests the workspace cache context. | ||||
| WorkspaceConcurrentEditingTest | class | Drupal\Tests\workspaces\Functional | core/ |
Tests concurrent edits in different workspaces. | ||||
| WorkspaceConflictException | class | Drupal\workspaces | core/ |
An exception thrown when two workspaces are in a conflicting content state. | ||||
| WorkspaceContentModerationIntegrationTest | class | Drupal\Tests\content_moderation\Functional | core/ |
Tests Workspaces together with Content Moderation. | ||||
| WorkspaceContentTranslationTest | class | Drupal\Tests\workspaces\Kernel | core/ |
Tests entity translations with workspaces. | ||||
| WorkspaceCRUDTest | class | Drupal\Tests\workspaces\Kernel | core/ |
Tests CRUD operations for workspaces. | ||||
| WorkspaceDeleteForm | class | Drupal\workspaces\Form | core/ |
Provides a form for deleting a workspace. | ||||
| WorkspaceDynamicSafeFormInterface | interface | Drupal\Core\Form | core/ |
Defines an interface for forms that can be workspace-safe. | 10 | 12 | ||
| WorkspaceEntityDeleteTest | class | Drupal\Tests\workspaces\Kernel | core/ |
Tests entity deletions with workspaces. | ||||
| WorkspaceEntityDeleteTest | class | Drupal\Tests\workspaces\Functional | core/ |
Tests entity deletions with workspaces. | ||||
| WorkspaceForm | class | Drupal\workspaces\Form | core/ |
Form controller for the workspace edit forms. | ||||
| WorkspaceFormInterface | in drupal:10.3.0 and is removed from drupal:11.0.0. Use \Drupal\Core\Form\WorkspaceSafeFormInterface or \Drupal\Core\Form\WorkspaceDynamicSafeFormInterface instead. |
interface | Drupal\workspaces\Form | core/ |
Defines interface for workspace forms so they can be easily distinguished. | |||
| WorkspaceHandlerInterface | interface | Drupal\workspaces\Entity\Handler | core/ |
Defines workspace operations that need to vary by entity type. | 2 | |||
| WorkspaceIdNegotiatorInterface | interface | Drupal\workspaces\Negotiator | core/ |
Interface for workspace negotiators that return only the negotiated ID. | 2 | 1 | ||
| WorkspaceInformation | class | Drupal\workspaces | core/ |
General service for workspace support information. | 2 | |||
| WorkspaceInformationInterface | interface | Drupal\workspaces | core/ |
Provides an interface for workspace-support information. | 1 | 6 | ||
| WorkspaceInformationTest | class | Drupal\Tests\workspaces\Kernel | core/ |
Tests the workspace information service. | ||||
| WorkspaceIntegrationTest | class | Drupal\Tests\workspaces\Kernel | core/ |
Tests a complete publishing scenario across different workspaces. | ||||
| WorkspaceInterface | interface | Drupal\workspaces | core/ |
Defines an interface for the workspace entity type. | 1 | 9 | ||
| WorkspaceJsonAnonTest | class | Drupal\Tests\workspaces\Functional\Rest | core/ |
Test workspace entities for unauthenticated JSON requests. | ||||
| WorkspaceJsonBasicAuthTest | class | Drupal\Tests\workspaces\Functional\Rest | core/ |
Test workspace entities for JSON requests via basic auth. | ||||
| WorkspaceJsonCookieTest | class | Drupal\Tests\workspaces\Functional\Rest | core/ |
Test workspace entities for JSON requests with cookie authentication. | ||||
| WorkspaceListBuilder | class | Drupal\workspaces | core/ |
Defines a class to build a listing of workspace entities. | ||||
| WorkspaceManager | class | Drupal\workspaces | core/ |
Provides the workspace manager. | 2 | |||
| WorkspaceManagerInterface | interface | Drupal\workspaces | core/ |
Provides an interface for managing Workspaces. | 1 | 13 | ||
| WorkspaceMenuLinkContentIntegrationTest | class | Drupal\Tests\workspaces\Functional | core/ |
Tests workspace integration for custom menu links. | ||||
| WorkspaceMergeForm | class | Drupal\workspaces\Form | core/ |
Provides a form that merges the contents for a workspace into another one. | 1 | |||
| WorkspaceMerger | class | Drupal\workspaces | core/ |
Default implementation of the workspace merger. | ||||
| WorkspaceMergerInterface | interface | Drupal\workspaces | core/ |
Defines an interface for the workspace merger. | 1 | |||
| WorkspaceMergerTest | class | Drupal\Tests\workspaces\Kernel | core/ |
Tests workspace merging. | ||||
| WorkspaceNegotiatorInterface | interface | Drupal\workspaces\Negotiator | core/ |
Workspace negotiators provide a way to get the active workspace. | 2 | 1 | ||
| WorkspaceOperationFactory | class | Drupal\workspaces | core/ |
Defines a factory class for workspace operations. | 3 | 2 | ||
| WorkspaceOperationInterface | interface | Drupal\workspaces | core/ |
Defines an interface for workspace operations. | 2 | |||
| WorkspacePermissionsTest | class | Drupal\Tests\workspaces\Functional | core/ |
Tests permission controls on workspaces. | ||||
| WorkspacePostPublishEvent | class | Drupal\workspaces\Event | core/ |
Defines the post-publish event class. | 2 | |||
| WorkspacePrePublishEvent | class | Drupal\workspaces\Event | core/ |
Defines the pre-publish event class. | 2 | |||
| WorkspacePublisher | class | Drupal\workspaces | core/ |
Default implementation of the workspace publisher. | ||||
| WorkspacePublisherInterface | interface | Drupal\workspaces | core/ |
Defines an interface for the workspace publisher. | 1 | 1 | ||
| WorkspacePublishEvent | abstract class | Drupal\workspaces\Event | core/ |
Defines the workspace publish event. | 2 | 2 | ||
| WorkspacePublishException | class | Drupal\workspaces | core/ |
An exception thrown when a workspace can not be published. | 2 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.