You are here

TermAccessControlHandler.php in Drupal 10

Namespace

Drupal\taxonomy

File

core/modules/taxonomy/src/TermAccessControlHandler.php
View source
<?php

namespace Drupal\taxonomy;

use Drupal\Core\Access\AccessResult;
use Drupal\Core\Entity\EntityAccessControlHandler;
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Session\AccountInterface;

/**
 * Defines the access control handler for the taxonomy term entity type.
 *
 * @see \Drupal\taxonomy\Entity\Term
 */
class TermAccessControlHandler extends EntityAccessControlHandler {

  /**
   * {@inheritdoc}
   */
  protected function checkAccess(EntityInterface $entity, $operation, AccountInterface $account) {
    if ($account
      ->hasPermission('administer taxonomy')) {
      return AccessResult::allowed()
        ->cachePerPermissions();
    }
    switch ($operation) {
      case 'view':
        $access_result = AccessResult::allowedIf($account
          ->hasPermission('access content') && $entity
          ->isPublished())
          ->cachePerPermissions()
          ->addCacheableDependency($entity);
        if (!$access_result
          ->isAllowed()) {
          $access_result
            ->setReason("The 'access content' permission is required and the taxonomy term must be published.");
        }
        return $access_result;
      case 'update':
        if ($account
          ->hasPermission("edit terms in {$entity->bundle()}")) {
          return AccessResult::allowed()
            ->cachePerPermissions();
        }
        return AccessResult::neutral()
          ->setReason("The following permissions are required: 'edit terms in {$entity->bundle()}' OR 'administer taxonomy'.");
      case 'delete':
        if ($account
          ->hasPermission("delete terms in {$entity->bundle()}")) {
          return AccessResult::allowed()
            ->cachePerPermissions();
        }
        return AccessResult::neutral()
          ->setReason("The following permissions are required: 'delete terms in {$entity->bundle()}' OR 'administer taxonomy'.");
      default:

        // No opinion.
        return AccessResult::neutral()
          ->cachePerPermissions();
    }
  }

  /**
   * {@inheritdoc}
   */
  protected function checkCreateAccess(AccountInterface $account, array $context, $entity_bundle = NULL) {
    return AccessResult::allowedIfHasPermissions($account, [
      "create terms in {$entity_bundle}",
      'administer taxonomy',
    ], 'OR');
  }

}

Classes

Namesort descending Description
TermAccessControlHandler Defines the access control handler for the taxonomy term entity type.