interface WorkspaceIdNegotiatorInterface

Same name in other branches
  1. 11.x core/modules/workspaces/src/Negotiator/WorkspaceIdNegotiatorInterface.php \Drupal\workspaces\Negotiator\WorkspaceIdNegotiatorInterface

Interface for workspace negotiators that return only the negotiated ID.

Hierarchy

Expanded class hierarchy of WorkspaceIdNegotiatorInterface

All classes that implement WorkspaceIdNegotiatorInterface

1 file declares its use of WorkspaceIdNegotiatorInterface
TestWorkspaceNegotiator.php in core/modules/workspaces/tests/modules/workspace_update_test/src/Negotiator/TestWorkspaceNegotiator.php

File

core/modules/workspaces/src/Negotiator/WorkspaceIdNegotiatorInterface.php, line 10

Namespace

Drupal\workspaces\Negotiator
View source 
interface WorkspaceIdNegotiatorInterface {
    
    /**
     * Performs workspace negotiation.
     *
     * @param \Symfony\Component\HttpFoundation\Request $request
     *   The HTTP request.
     *
     * @return string|null
     *   A valid workspace ID if the negotiation was successful, NULL otherwise.
     */
    public function getActiveWorkspaceId(Request $request) : ?string;

}

Members

Title Modifiers Object type Summary Overrides
WorkspaceIdNegotiatorInterface::getActiveWorkspaceId public function Performs workspace negotiation. 2

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