1. interface
  2. Drupal
  3. \
  4. workspaces
  5. \
  6. WorkspaceRepositoryInterface

WorkspaceRepositoryInterface

interface WorkspaceRepositoryInterface (View source)

Provides an interface for workspace tree lookup operations.

Methods

array
loadTree()

Returns an array of workspaces tree item properties, sorted in tree order.

string[]
getDescendantsAndSelf(string $workspace_id)

Returns the descendant IDs of the passed-in workspace, including itself.

$this
resetCache()

Resets the cached workspace tree.

Details

at line 20
array loadTree()

Returns an array of workspaces tree item properties, sorted in tree order.

Return Value

array

An array of workspace tree item properties, keyed by the workspace IDs. The tree item properties are:

  • depth: The depth of the workspace in the tree;
  • ancestors: The ancestor IDs of the workspace;
  • descendants: The descendant IDs of the workspace.

at line 31
string[] getDescendantsAndSelf(string $workspace_id)

Returns the descendant IDs of the passed-in workspace, including itself.

Parameters

string $workspace_id

A workspace ID.

Return Value

string[]

An array of descendant workspace IDs, including the passed-in one.

at line 38
$this resetCache()

Resets the cached workspace tree.

Return Value

$this