You are here

Home » API reference » Entity Construction Kit (ECK) 8 » EckEntityAccessControlHandler.php

class EckEntityAccessControlHandler in Entity Construction Kit (ECK) 8

Access controller for the EckEntity entity.

Hierarchy

Expanded class hierarchy of EckEntityAccessControlHandler

See also

\Drupal\eck\Entity\EckEntity.

File

src/EckEntityAccessControlHandler.php, line 17

Namespace

Drupal\eck
View source 
class EckEntityAccessControlHandler extends EntityAccessControlHandler {

  /**
   * Determines if the given account is allowed to bypass access control.
   *
   * @param \Drupal\Core\Session\AccountInterface|null $account
   *   The account.
   *
   * @return bool
   *   Can the user bypass the access check?
   */
  private function canBypassAccessCheck(AccountInterface $account = NULL) {
    $account = $this
      ->prepareUser($account);
    return $account
      ->hasPermission('bypass eck entity access');
  }

  /**
   * Generates an AccessResult.
   *
   * @param bool $return_as_object
   *   Should a bool or AccessResult object be returned?
   *
   * @return \Drupal\Core\Access\AccessResult|bool
   *   The created access result.
   */
  private function getBypassAccessResult($return_as_object) {
    $result = AccessResult::allowed()
      ->cachePerPermissions();
    return $return_as_object ? $result : $result
      ->isAllowed();
  }

  /**
   * {@inheritdoc}
   */
  public function access(EntityInterface $entity, $operation, AccountInterface $account = NULL, $return_as_object = FALSE) {
    if ($this
      ->canBypassAccessCheck($account)) {
      return $this
        ->getBypassAccessResult($return_as_object);
    }
    else {
      return parent::access($entity, $operation, $account, $return_as_object);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function createAccess($entity_bundle = NULL, AccountInterface $account = NULL, array $context = [], $return_as_object = FALSE) {
    if ($this
      ->canBypassAccessCheck($account)) {
      return $this
        ->getBypassAccessResult($return_as_object);
    }
    else {
      return parent::createAccess($entity_bundle, $account, $context, $return_as_object);
    }
  }

  /**
   * {@inheritdoc}
   */
  protected function checkAccess(EntityInterface $entity, $operation, AccountInterface $account) {
    $operation = $operation == 'update' ? 'edit' : $operation;
    $permissions[] = $operation . ' any ' . $entity
      ->getEntityTypeId() . ' entities';
    if ($entity
      ->getOwnerId() == $account
      ->id()) {
      $permissions[] = $operation . ' own ' . $entity
        ->getEntityTypeId() . ' entities';
    }
    $default_entity_access = AccessResult::allowedIfHasPermissions($account, $permissions, 'OR');

    // Unpublished entities require at least one of the default permissions:
    // 'views own' or 'view any' and 'view unpublished'.
    if ($operation == 'view' && !$entity
      ->isPublished()) {
      return AccessResult::allowedIf($default_entity_access && $account
        ->hasPermission('view unpublished eck entities'));
    }
    return $default_entity_access;
  }

  /**
   * {@inheritdoc}
   */
  protected function checkCreateAccess(AccountInterface $account, array $context, $entity_bundle = NULL) {
    $permissions = [
      'create ' . $this->entityTypeId . ' entities',
    ];
    if (!empty($entity_bundle)) {
      $permissions[] = 'create ' . $this->entityTypeId . ' entities of bundle ' . $entity_bundle;
    }
    return AccessResult::allowedIfHasPermissions($account, $permissions, 'OR')
      ->cachePerPermissions();
  }

}

Members

Namesort descending 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
EckEntityAccessControlHandler::access public function Checks access to an operation on a given entity or entity translation. Overrides EntityAccessControlHandler::access
EckEntityAccessControlHandler::canBypassAccessCheck private function Determines if the given account is allowed to bypass access control.
EckEntityAccessControlHandler::checkAccess protected function Performs access checks. Overrides EntityAccessControlHandler::checkAccess
EckEntityAccessControlHandler::checkCreateAccess protected function Performs create access checks. Overrides EntityAccessControlHandler::checkCreateAccess
EckEntityAccessControlHandler::createAccess public function Checks access to create an entity. Overrides EntityAccessControlHandler::createAccess
EckEntityAccessControlHandler::getBypassAccessResult private function Generates an AccessResult.
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::checkFieldAccess protected function Default field access as determined by this access control handler. 4
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.
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.