WorkspaceRepositoryInterface.php

Same filename in other branches
  1. 9 core/modules/workspaces/src/WorkspaceRepositoryInterface.php
  2. 8.9.x core/modules/workspaces/src/WorkspaceRepositoryInterface.php
  3. 11.x core/modules/workspaces/src/WorkspaceRepositoryInterface.php

Namespace

Drupal\workspaces

File

core/modules/workspaces/src/WorkspaceRepositoryInterface.php

View source
<?php

namespace Drupal\workspaces;


/**
 * Provides an interface for workspace tree lookup operations.
 */
interface WorkspaceRepositoryInterface {
    
    /**
     * Returns an array of workspaces tree item properties, sorted in tree order.
     *
     * @return 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.
     */
    public function loadTree();
    
    /**
     * Returns the descendant IDs of the passed-in workspace, including itself.
     *
     * @param string $workspace_id
     *   A workspace ID.
     *
     * @return string[]
     *   An array of descendant workspace IDs, including the passed-in one.
     */
    public function getDescendantsAndSelf($workspace_id);
    
    /**
     * Resets the cached workspace tree.
     *
     * @return $this
     */
    public function resetCache();

}

Interfaces

Title Deprecated Summary
WorkspaceRepositoryInterface Provides an interface for workspace tree lookup operations.

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