class WorkspaceAccessControlHandler

Same name in other branches
  1. 9 core/modules/workspaces/src/WorkspaceAccessControlHandler.php \Drupal\workspaces\WorkspaceAccessControlHandler
  2. 8.9.x core/modules/workspaces/src/WorkspaceAccessControlHandler.php \Drupal\workspaces\WorkspaceAccessControlHandler
  3. 10 core/modules/workspaces/src/WorkspaceAccessControlHandler.php \Drupal\workspaces\WorkspaceAccessControlHandler

Defines the access control handler for the workspace entity type.

Hierarchy

Expanded class hierarchy of WorkspaceAccessControlHandler

See also

\Drupal\workspaces\Entity\Workspace

File

core/modules/workspaces/src/WorkspaceAccessControlHandler.php, line 15

Namespace

Drupal\workspaces
View source 
class WorkspaceAccessControlHandler extends EntityAccessControlHandler {
    
    /**
     * {@inheritdoc}
     */
    protected function checkAccess(EntityInterface $entity, $operation, AccountInterface $account) {
        
        /** @var \Drupal\workspaces\WorkspaceInterface $entity */
        if ($operation === 'publish' && $entity->hasParent()) {
            $message = $this->t('Only top-level workspaces can be published.');
            return AccessResult::forbidden((string) $message)->addCacheableDependency($entity);
        }
        if ($account->hasPermission('administer workspaces')) {
            return AccessResult::allowed()->cachePerPermissions();
        }
        // @todo Consider adding explicit "publish any|own workspace" permissions in
        //   https://www.drupal.org/project/drupal/issues/3084260.
        switch ($operation) {
            case 'update':
            case 'publish':
                $permission_operation = 'edit';
                break;
            case 'view all revisions':
                $permission_operation = 'view';
                break;
            default:
                $permission_operation = $operation;
                break;
        }
        // Check if the user has permission to access all workspaces.
        $access_result = AccessResult::allowedIfHasPermission($account, $permission_operation . ' any workspace');
        // Check if it's their own workspace, and they have permission to access
        // their own workspace.
        if ($access_result->isNeutral() && $account->isAuthenticated() && $account->id() === $entity->getOwnerId()) {
            $access_result = AccessResult::allowedIfHasPermission($account, $permission_operation . ' own workspace')->cachePerUser()
                ->addCacheableDependency($entity);
        }
        return $access_result;
    }
    
    /**
     * {@inheritdoc}
     */
    protected function checkCreateAccess(AccountInterface $account, array $context, $entity_bundle = NULL) {
        return AccessResult::allowedIfHasPermissions($account, [
            'administer workspaces',
            'create workspace',
        ], 'OR');
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
EntityAccessControlHandler::$accessCache protected property Stores calculated access check results.
EntityAccessControlHandler::$entityType protected property Information about the entity type.
EntityAccessControlHandler::$entityTypeId protected property The entity type ID of the access control handler instance.
EntityAccessControlHandler::$viewLabelOperation protected property Allows to grant access to just the labels. 7
EntityAccessControlHandler::access public function Overrides EntityAccessControlHandlerInterface::access 1
EntityAccessControlHandler::checkFieldAccess protected function Default field access as determined by this access control handler. 4
EntityAccessControlHandler::createAccess public function Overrides EntityAccessControlHandlerInterface::createAccess 1
EntityAccessControlHandler::fieldAccess public function Overrides EntityAccessControlHandlerInterface::fieldAccess
EntityAccessControlHandler::getCache protected function Tries to retrieve a previously cached access value from the static cache.
EntityAccessControlHandler::prepareUser protected function Loads the current account object, if it does not exist yet.
EntityAccessControlHandler::processAccessHookResults protected function Determines entity access.
EntityAccessControlHandler::resetCache public function Overrides EntityAccessControlHandlerInterface::resetCache
EntityAccessControlHandler::setCache protected function Statically caches whether the given user has access.
EntityAccessControlHandler::__construct public function Constructs an access control handler instance. 8
EntityHandlerBase::$moduleHandler protected property The module handler to invoke hooks on. 5
EntityHandlerBase::moduleHandler protected function Gets the module handler. 5
EntityHandlerBase::setModuleHandler public function Sets the module handler for this handler.
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
WorkspaceAccessControlHandler::checkAccess protected function Performs access checks. Overrides EntityAccessControlHandler::checkAccess
WorkspaceAccessControlHandler::checkCreateAccess protected function Performs create access checks. Overrides EntityAccessControlHandler::checkCreateAccess

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