class MediaAccessControlHandler

Same name in other branches
  1. 9 core/modules/media/src/MediaAccessControlHandler.php \Drupal\media\MediaAccessControlHandler
  2. 10 core/modules/media/src/MediaAccessControlHandler.php \Drupal\media\MediaAccessControlHandler
  3. 11.x core/modules/media/src/MediaAccessControlHandler.php \Drupal\media\MediaAccessControlHandler

Defines an access control handler for media items.

Hierarchy

Expanded class hierarchy of MediaAccessControlHandler

File

core/modules/media/src/MediaAccessControlHandler.php, line 13

Namespace

Drupal\media
View source
class MediaAccessControlHandler extends EntityAccessControlHandler {
    
    /**
     * {@inheritdoc}
     */
    protected function checkAccess(EntityInterface $entity, $operation, AccountInterface $account) {
        if ($account->hasPermission('administer media')) {
            return AccessResult::allowed()->cachePerPermissions();
        }
        $type = $entity->bundle();
        $is_owner = $account->id() && $account->id() === $entity->getOwnerId();
        switch ($operation) {
            case 'view':
                if ($entity->isPublished()) {
                    $access_result = AccessResult::allowedIf($account->hasPermission('view media'))
                        ->cachePerPermissions()
                        ->addCacheableDependency($entity);
                    if (!$access_result->isAllowed()) {
                        $access_result->setReason("The 'view media' permission is required when the media item is published.");
                    }
                }
                elseif ($account->hasPermission('view own unpublished media')) {
                    $access_result = AccessResult::allowedIf($is_owner)->cachePerPermissions()
                        ->cachePerUser()
                        ->addCacheableDependency($entity);
                    if (!$access_result->isAllowed()) {
                        $access_result->setReason("The user must be the owner and the 'view own unpublished media' permission is required when the media item is unpublished.");
                    }
                }
                else {
                    $access_result = AccessResult::neutral()->cachePerPermissions()
                        ->addCacheableDependency($entity)
                        ->setReason("The user must be the owner and the 'view own unpublished media' permission is required when the media item is unpublished.");
                }
                return $access_result;
            case 'update':
                if ($account->hasPermission('edit any ' . $type . ' media')) {
                    return AccessResult::allowed()->cachePerPermissions();
                }
                if ($account->hasPermission('edit own ' . $type . ' media') && $is_owner) {
                    return AccessResult::allowed()->cachePerPermissions()
                        ->cachePerUser()
                        ->addCacheableDependency($entity);
                }
                // @todo Deprecate this permission in
                // https://www.drupal.org/project/drupal/issues/2925459.
                if ($account->hasPermission('update any media')) {
                    return AccessResult::allowed()->cachePerPermissions();
                }
                if ($account->hasPermission('update media') && $is_owner) {
                    return AccessResult::allowed()->cachePerPermissions()
                        ->cachePerUser()
                        ->addCacheableDependency($entity);
                }
                return AccessResult::neutral("The following permissions are required: 'update any media' OR 'update own media' OR '{$type}: edit any media' OR '{$type}: edit own media'.")->cachePerPermissions();
            case 'delete':
                if ($account->hasPermission('delete any ' . $type . ' media')) {
                    return AccessResult::allowed()->cachePerPermissions();
                }
                if ($account->hasPermission('delete own ' . $type . ' media') && $is_owner) {
                    return AccessResult::allowed()->cachePerPermissions()
                        ->cachePerUser()
                        ->addCacheableDependency($entity);
                }
                // @todo Deprecate this permission in
                // https://www.drupal.org/project/drupal/issues/2925459.
                if ($account->hasPermission('delete any media')) {
                    return AccessResult::allowed()->cachePerPermissions();
                }
                if ($account->hasPermission('delete media') && $is_owner) {
                    return AccessResult::allowed()->cachePerPermissions()
                        ->cachePerUser()
                        ->addCacheableDependency($entity);
                }
                return AccessResult::neutral("The following permissions are required: 'delete any media' OR 'delete own media' OR '{$type}: delete any media' OR '{$type}: delete own media'.")->cachePerPermissions();
            default:
                return AccessResult::neutral()->cachePerPermissions();
        }
    }
    
    /**
     * {@inheritdoc}
     */
    protected function checkCreateAccess(AccountInterface $account, array $context, $entity_bundle = NULL) {
        $permissions = [
            'administer media',
            'create media',
            'create ' . $entity_bundle . ' media',
        ];
        return AccessResult::allowedIfHasPermissions($account, $permissions, 'OR');
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
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. 5
EntityAccessControlHandler::access public function Checks access to an operation on a given entity or entity translation. Overrides EntityAccessControlHandlerInterface::access 1
EntityAccessControlHandler::checkFieldAccess protected function Default field access as determined by this access control handler. 4
EntityAccessControlHandler::createAccess public function Checks access to create an entity. Overrides EntityAccessControlHandlerInterface::createAccess 1
EntityAccessControlHandler::fieldAccess public function Checks access to an operation on a given entity field. 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 We grant access to the entity if both of these conditions are met:
EntityAccessControlHandler::resetCache public function Clears all cached access checks. 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. 6
EntityHandlerBase::$moduleHandler protected property The module handler to invoke hooks on. 2
EntityHandlerBase::moduleHandler protected function Gets the module handler. 2
EntityHandlerBase::setModuleHandler public function Sets the module handler for this handler.
MediaAccessControlHandler::checkAccess protected function Performs access checks. Overrides EntityAccessControlHandler::checkAccess
MediaAccessControlHandler::checkCreateAccess protected function Performs create access checks. Overrides EntityAccessControlHandler::checkCreateAccess
StringTranslationTrait::$stringTranslation protected property The string translation service.
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.

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