multiversion-8.x-1.0-beta34/src/Workspace/WorkspaceManagerInterface.php

<?php

namespace Drupal\multiversion\Workspace;

use Drupal\multiversion\Entity\WorkspaceInterface;

interface WorkspaceManagerInterface {

  /**
   * @param \Drupal\multiversion\Workspace\WorkspaceNegotiatorInterface $negotiator
   * @param int $priority
   */
  public function addNegotiator(WorkspaceNegotiatorInterface $negotiator, $priority);

  /**
   * @param string $workspace_id
   */
  public function load($workspace_id);

  /**
   * @param array|null $workspace_ids
   */
  public function loadMultiple(array $workspace_ids = NULL);

  /**
   * @param string $machine_name
   */
  public function loadByMachineName($machine_name);

  /**
   * Fetches the currently active workspace entity.
   *
   * @return \Drupal\multiversion\Entity\WorkspaceInterface
   *   The active workspace entity.
   */
  public function getActiveWorkspace();

  /**
   * Fetches the currently active workspace ID.
   *
   * @return int
   *   The active workspace ID.
   */
  public function getActiveWorkspaceId();

  /**
   * Sets the active workspace for the site/session.
   *
   * @param \Drupal\multiversion\Entity\WorkspaceInterface $workspace
   *   The workspace to set as active.
   *
   * @return \Drupal\multiversion\Workspace\WorkspaceManagerInterface
   *
   * @throws WorkspaceAccessException
   */
  public function setActiveWorkspace(WorkspaceInterface $workspace);

}