class QueryParameterWorkspaceNegotiator

Defines the query parameter workspace negotiator.

Hierarchy

Expanded class hierarchy of QueryParameterWorkspaceNegotiator

1 string reference to 'QueryParameterWorkspaceNegotiator'
workspaces.services.yml in core/modules/workspaces/workspaces.services.yml
core/modules/workspaces/workspaces.services.yml
1 service uses QueryParameterWorkspaceNegotiator
workspaces.negotiator.query_parameter in core/modules/workspaces/workspaces.services.yml
Drupal\workspaces\Negotiator\QueryParameterWorkspaceNegotiator

File

View on git.drupalcode.org

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

Namespace

Drupal\workspaces\Negotiator
View source 
class QueryParameterWorkspaceNegotiator extends SessionWorkspaceNegotiator {
  
  /**
   * {@inheritdoc}
   */
  public function applies(Request $request) {
    return is_string($request->query
      ->get('workspace')) && parent::applies($request);
  }
  
  /**
   * {@inheritdoc}
   */
  public function getActiveWorkspace(Request $request) {
    $workspace_id = $request->query
      ->get('workspace');
    if ($workspace_id && $workspace = $this->workspaceStorage
      ->load($workspace_id)) {
      $this->setActiveWorkspace($workspace);
      return $workspace;
    }
    return NULL;
  }

}

Members

Title Modifiers Object type Summary Overriden Title
QueryParameterWorkspaceNegotiator::applies public function Checks whether the negotiator applies to the current request or not. Overrides SessionWorkspaceNegotiator::applies
QueryParameterWorkspaceNegotiator::getActiveWorkspace public function Gets the negotiated workspace, if any. Overrides SessionWorkspaceNegotiator::getActiveWorkspace
SessionWorkspaceNegotiator::$currentUser protected property The current user.
SessionWorkspaceNegotiator::$session protected property The session.
SessionWorkspaceNegotiator::$workspaceStorage protected property The workspace storage handler.
SessionWorkspaceNegotiator::setActiveWorkspace public function Sets the negotiated workspace. Overrides WorkspaceNegotiatorInterface::setActiveWorkspace
SessionWorkspaceNegotiator::unsetActiveWorkspace public function Unsets the negotiated workspace. Overrides WorkspaceNegotiatorInterface::unsetActiveWorkspace
SessionWorkspaceNegotiator::__construct public function Constructor.

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