class VocabularyAccessControlHandler in Taxonomy access fix 8.3

Extends access control for Taxonomy Vocabulary entities.

Hierarchy

• class \Drupal\Core\Entity\EntityHandlerBase uses DependencySerializationTrait, StringTranslationTrait
  • class \Drupal\Core\Entity\EntityAccessControlHandler implements EntityAccessControlHandlerInterface
    • class \Drupal\taxonomy\VocabularyAccessControlHandler
      • class \Drupal\taxonomy_access_fix\VocabularyAccessControlHandler implements EntityHandlerInterface

1 file declares its use of VocabularyAccessControlHandler

taxonomy_access_fix.module in ./taxonomy_access_fix.module

Hook implementations by Taxonomy Access Fix module.

File

src/VocabularyAccessControlHandler.php, line 17

Namespace

Drupal\taxonomy_access_fix

class VocabularyAccessControlHandler extends OriginalVocabularyAccessControlHandler implements EntityHandlerInterface {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Constructs a new VocabularyAccessControlHandler instance.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type definition.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   */
  public function __construct(EntityTypeInterface $entity_type, EntityTypeManagerInterface $entity_type_manager) {
    parent::__construct($entity_type);
    $this->entityTypeManager = $entity_type_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
    return new static($entity_type, $container
      ->get('entity_type.manager'));
  }

  /**
   * {@inheritdoc}
   */
  protected function checkAccess(EntityInterface $entity, $operation, AccountInterface $account) {
    if ($operation !== 'reorder_terms') {
      $access_result = parent::checkAccess($entity, $operation, $account);
      if (in_array($operation, [
        'access taxonomy overview',
        'view',
      ])) {
        $taxonomy_term_access_control_handler = $this->entityTypeManager
          ->getAccessControlHandler('taxonomy_term');
        $access_result_operation = AccessResult::allowedIf($taxonomy_term_access_control_handler
          ->createAccess($entity
          ->id(), $account))
          ->orIf(AccessResult::allowedIf($account
          ->hasPermission('delete terms in ' . $entity
          ->id())))
          ->orIf(AccessResult::allowedIf($account
          ->hasPermission('edit terms in ' . $entity
          ->id())))
          ->orIf($this
          ->checkAccess($entity, 'reorder_terms', $account));

        /** @var \Drupal\Core\Access\AccessResult $access_result */
        $access_result = $access_result
          ->andIf($access_result_operation);
        $access_result
          ->cachePerPermissions()
          ->addCacheableDependency($entity);
        if (!$access_result
          ->isAllowed()) {

          /** @var \Drupal\Core\Access\AccessResultReasonInterface $access_result */
          $access_result
            ->setReason("The 'access taxonomy overview' and one of the 'create terms in {$entity->id()}', 'delete terms in {$entity->id()}', 'edit terms in {$entity->id()}', 'reorder terms in {$entity->id()}' permissions OR the 'administer taxonomy' permission are required.");
        }
      }
      return $access_result;
    }
    if ($account
      ->hasPermission('administer taxonomy')) {
      return AccessResult::allowed()
        ->cachePerPermissions();
    }
    $access_result = AccessResult::forbidden();
    if ($operation === 'reorder_terms') {
      $access_result = AccessResult::allowedIfHasPermission($account, "reorder terms in {$entity->id()}")
        ->cachePerPermissions()
        ->addCacheableDependency($entity);
      if (!$access_result
        ->isAllowed()) {

        /** @var \Drupal\Core\Access\AccessResultReasonInterface $access_result */
        $access_result
          ->setReason("The 'reorder terms in {$entity->id()}' OR the 'administer taxonomy' permission is required.");
      }
    }
    return $access_result;
  }

}

Members

Name	Modifiers	Type	Description	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::checkCreateAccess	protected	function	Performs create access checks.	14
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.
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.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
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.
VocabularyAccessControlHandler::$entityTypeManager	protected	property	The entity type manager.
VocabularyAccessControlHandler::checkAccess	protected	function	Performs access checks. Overrides VocabularyAccessControlHandler::checkAccess
VocabularyAccessControlHandler::createInstance	public static	function	Instantiates a new instance of this entity handler. Overrides EntityHandlerInterface::createInstance
VocabularyAccessControlHandler::__construct	public	function	Constructs a new VocabularyAccessControlHandler instance. Overrides EntityAccessControlHandler::__construct