function WorkspaceIdNegotiatorInterface::getActiveWorkspaceId

Same name and namespace in other branches
  1. 10 core/modules/workspaces/src/Negotiator/WorkspaceIdNegotiatorInterface.php \Drupal\workspaces\Negotiator\WorkspaceIdNegotiatorInterface::getActiveWorkspaceId()

Performs workspace negotiation.

Parameters

\Symfony\Component\HttpFoundation\Request $request: The HTTP request.

Return value

string|null A valid workspace ID if the negotiation was successful, NULL otherwise.

2 methods override WorkspaceIdNegotiatorInterface::getActiveWorkspaceId()
SessionWorkspaceNegotiator::getActiveWorkspaceId in core/modules/workspaces/src/Negotiator/SessionWorkspaceNegotiator.php
Performs workspace negotiation.
TestWorkspaceNegotiator::getActiveWorkspaceId in core/modules/workspaces/tests/modules/workspace_update_test/src/Negotiator/TestWorkspaceNegotiator.php
Performs workspace negotiation.

File

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

Class

WorkspaceIdNegotiatorInterface
Interface for workspace negotiators that return only the negotiated ID.

Namespace

Drupal\workspaces\Negotiator

Code

public function getActiveWorkspaceId(Request $request) : ?string;

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