Updated Drupal to 8.6. This goes with the following updates because it's possible...
[yaffs-website] / web / core / modules / workspaces / src / WorkspaceManagerInterface.php
diff --git a/web/core/modules/workspaces/src/WorkspaceManagerInterface.php b/web/core/modules/workspaces/src/WorkspaceManagerInterface.php
new file mode 100644 (file)
index 0000000..9ce720b
--- /dev/null
@@ -0,0 +1,64 @@
+<?php
+
+namespace Drupal\workspaces;
+
+use Drupal\Core\Entity\EntityTypeInterface;
+
+/**
+ * Provides an interface for managing Workspaces.
+ */
+interface WorkspaceManagerInterface {
+
+  /**
+   * Returns whether an entity type can belong to a workspace or not.
+   *
+   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
+   *   The entity type to check.
+   *
+   * @return bool
+   *   TRUE if the entity type can belong to a workspace, FALSE otherwise.
+   */
+  public function isEntityTypeSupported(EntityTypeInterface $entity_type);
+
+  /**
+   * Returns an array of entity types that can belong to workspaces.
+   *
+   * @return \Drupal\Core\Entity\EntityTypeInterface[]
+   *   The entity types what can belong to workspaces.
+   */
+  public function getSupportedEntityTypes();
+
+  /**
+   * Gets the active workspace.
+   *
+   * @return \Drupal\workspaces\WorkspaceInterface
+   *   The active workspace entity object.
+   */
+  public function getActiveWorkspace();
+
+  /**
+   * Sets the active workspace via the workspace negotiators.
+   *
+   * @param \Drupal\workspaces\WorkspaceInterface $workspace
+   *   The workspace to set as active.
+   *
+   * @return $this
+   *
+   * @throws \Drupal\workspaces\WorkspaceAccessException
+   *   Thrown when the current user doesn't have access to view the workspace.
+   */
+  public function setActiveWorkspace(WorkspaceInterface $workspace);
+
+  /**
+   * Determines whether runtime entity operations should be altered.
+   *
+   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
+   *   The entity type to check.
+   *
+   * @return bool
+   *   TRUE if the entity operations or queries should be altered in the current
+   *   request, FALSE otherwise.
+   */
+  public function shouldAlterOperations(EntityTypeInterface $entity_type);
+
+}