class LinkCheckerLinkAccessControlHandler in Link checker 8

Defines the access control handler for the linkchecker link entity type.

View source

class LinkCheckerLinkAccessControlHandler extends EntityAccessControlHandler {

  /**
   * {@inheritdoc}
   */
  protected function checkAccess(EntityInterface $entity, $operation, AccountInterface $account) {

    /** @var \Drupal\linkchecker\LinkCheckerLinkInterface $entity */
    if ($account
      ->hasPermission('administer linkchecker') || $account
      ->hasPermission('edit linkchecker link settings')) {
      return $this
        ->checkParentEntityAccess($entity, $operation, $account);
    }

    // The permission is required.
    return AccessResult::forbidden()
      ->cachePerPermissions();
  }

  /**
   * {@inheritdoc}
   */
  protected function checkFieldAccess($operation, FieldDefinitionInterface $field_definition, AccountInterface $account, FieldItemListInterface $items = NULL) {

    // No user can change read only fields.
    if ($operation == 'edit') {
      switch ($field_definition
        ->getName()) {
        case 'method':
        case 'status':
          return AccessResult::allowedIfHasPermissions($account, [
            'administer linkchecker',
            'edit linkchecker link settings',
          ], 'OR');
        default:
          return AccessResult::forbidden();
      }
    }

    // User not allowed to view URL field if he does not have access to parent
    // entity.
    if ($operation == 'view' && isset($items) && $field_definition
      ->getName() == 'url') {
      return $this
        ->checkParentEntityAccess($items
        ->getEntity(), $operation, $account);
    }
    return parent::checkFieldAccess($operation, $field_definition, $account, $items);
  }

  /**
   * Helper function for access checking.
   */
  protected function checkParentEntityAccess(LinkCheckerLinkInterface $entity, $operation, AccountInterface $account) {
    $parentEntity = $entity
      ->getParentEntity();

    // If parent not exists - forbidden.
    if (!isset($parentEntity)) {
      return AccessResult::forbidden()
        ->cachePerPermissions();
    }

    // If user does not have access to parent entity - forbidden.
    if (!$parentEntity
      ->access($operation, $account)) {
      return AccessResult::forbidden()
        ->addCacheableDependency($parentEntity)
        ->cachePerPermissions();
    }

    // If field where link was stored not exists anymore - forbidden.
    if (!$parentEntity
      ->hasField($entity
      ->getParentEntityFieldName())) {
      return AccessResult::forbidden()
        ->addCacheableDependency($parentEntity)
        ->cachePerPermissions();
    }

    // If user does not have access to field where link is stored - forbidden.
    $parentEntityField = $parentEntity
      ->get($entity
      ->getParentEntityFieldName());
    if (!$parentEntityField
      ->access($operation, $account)) {
      return AccessResult::forbidden()
        ->addCacheableDependency($parentEntity)
        ->cachePerPermissions();
    }

    // Allowed in all other cases.
    return AccessResult::allowed()
      ->addCacheableDependency($parentEntity)
      ->cachePerPermissions();
  }

}

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::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.	5
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.
LinkCheckerLinkAccessControlHandler::checkAccess	protected	function	Performs access checks. Overrides EntityAccessControlHandler::checkAccess
LinkCheckerLinkAccessControlHandler::checkFieldAccess	protected	function	Default field access as determined by this access control handler. Overrides EntityAccessControlHandler::checkFieldAccess
LinkCheckerLinkAccessControlHandler::checkParentEntityAccess	protected	function	Helper function for access checking.
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.

You are here

class LinkCheckerLinkAccessControlHandler in Link checker 8

Hierarchy

See also

File

Namespace

Members

API Navigation