WorkspaceIdNegotiatorInterface.php

Same filename in other branches
  1. 10 core/modules/workspaces/src/Negotiator/WorkspaceIdNegotiatorInterface.php

Namespace

Drupal\workspaces\Negotiator

File

core/modules/workspaces/src/Negotiator/WorkspaceIdNegotiatorInterface.php

View source
<?php

namespace Drupal\workspaces\Negotiator;

use Symfony\Component\HttpFoundation\Request;

/**
 * Interface for workspace negotiators that return only the negotiated ID.
 */
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;

}

Interfaces

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

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