interface WorkspaceHandlerInterface

Same name in other branches
  1. 11.x core/modules/workspaces/src/Entity/Handler/WorkspaceHandlerInterface.php \Drupal\workspaces\Entity\Handler\WorkspaceHandlerInterface

Defines workspace operations that need to vary by entity type.

@internal

Hierarchy

Expanded class hierarchy of WorkspaceHandlerInterface

All classes that implement WorkspaceHandlerInterface

File

core/modules/workspaces/src/Entity/Handler/WorkspaceHandlerInterface.php, line 12

Namespace

Drupal\workspaces\Entity\Handler
View source 
interface WorkspaceHandlerInterface {
    
    /**
     * Determines if an entity should be tracked in a workspace.
     *
     * At the general level, workspace support is determined for the entire entity
     * type. If an entity type is supported, there may be further decisions each
     * entity type can make to evaluate if a given entity is appropriate to be
     * tracked in a workspace.
     *
     * @param \Drupal\Core\Entity\EntityInterface $entity
     *   The entity we may be tracking.
     *
     * @return bool
     *   TRUE if this entity should be tracked in a workspace, FALSE otherwise.
     */
    public function isEntitySupported(EntityInterface $entity) : bool;

}

Members

Title Modifiers Object type Summary Overrides
WorkspaceHandlerInterface::isEntitySupported public function Determines if an entity should be tracked in a workspace. 2

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