You are here

Home » API reference » RedHen CRM 8 » ContactAccessControlHandler.php

class ContactAccessControlHandler in RedHen CRM 8

Access controller for the Contact entity.

Hierarchy

Expanded class hierarchy of ContactAccessControlHandler

See also

\Drupal\redhen_contact\Entity\Contact.

File

modules/redhen_contact/src/ContactAccessControlHandler.php, line 15

Namespace

Drupal\redhen_contact
View source 
class ContactAccessControlHandler extends EntityAccessControlHandler {

  /**
   * {@inheritdoc}
   */
  protected $viewLabelOperation = TRUE;

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

    /** @var \Drupal\redhen_contact\ContactInterface $entity */

    // Get Contact bundle.
    $entity_bundle = $entity
      ->getType();

    // Check if Contact being accessed is user's own.
    $own = $entity
      ->getOwnerId() == $account
      ->id();
    switch ($operation) {

      // @todo split out view label into its own permission.
      case 'view label':
      case 'view':

        // If Contact is active, check "view own" and/or "view active"
        // permissions to determine access.
        if ($entity
          ->isActive()) {

          // If Contact is user's own, either "view active" or "view own"
          // permission is sufficient to grant access.
          if ($own) {
            $view_access = AccessResult::allowedIfHasPermissions($account, [
              'view active contact entities',
              'view active ' . $entity_bundle . ' contact',
              'view own ' . $entity_bundle . ' contact',
            ], 'OR');
          }
          else {
            $view_access = AccessResult::allowedIfHasPermissions($account, [
              'view active contact entities',
              'view active ' . $entity_bundle . ' contact',
            ], 'OR');
          }
        }
        else {
          $view_access = AccessResult::allowedIfHasPermissions($account, [
            'view inactive contact entities',
            'view inactive ' . $entity_bundle . ' contact',
          ], 'OR');
        }
        return $view_access;
      case 'update':

        // If Contact is active, check "edit own" and/or "edit active"
        // permissions to determine access.
        if ($entity
          ->isActive()) {

          // If Contact is user's own, either "edit any" or "edit own"
          // permission is sufficient to grant access.
          if ($own) {
            $edit_access = AccessResult::allowedIfHasPermissions($account, [
              'edit contact entities',
              'edit any ' . $entity_bundle . ' contact',
              'edit own ' . $entity_bundle . ' contact',
            ], 'OR');
          }
        }

        // If Contact is inactive or not user's own, user needs "edit any"
        // permission to have access.
        if (!isset($edit_access)) {
          $edit_access = AccessResult::allowedIfHasPermissions($account, [
            'edit contact entities',
            'edit any ' . $entity_bundle . ' contact',
          ], 'OR');
        }
        return $edit_access;
      case 'delete':

        // If Contact is active, check "delete own" and/or "delete active"
        // permissions to determine access.
        if ($entity
          ->isActive()) {

          // If Contact is user's own, either "delete any" or "delete own"
          // permission is sufficient to grant access.
          if ($own) {
            $delete_access = AccessResult::allowedIfHasPermissions($account, [
              'delete contact entities',
              'delete any ' . $entity_bundle . ' contact',
              'delete own ' . $entity_bundle . ' contact',
            ], 'OR');
          }
        }

        // If Contact is inactive or not user's own, user needs "delete any"
        // permission to have access.
        if (!isset($delete_access)) {
          $delete_access = AccessResult::allowedIfHasPermissions($account, [
            'delete contact entities',
            'delete any ' . $entity_bundle . ' contact',
          ], 'OR');
        }
        return $delete_access;
    }

    // Unknown operation, no opinion.
    return AccessResult::neutral();
  }

  /**
   * {@inheritdoc}
   */
  protected function checkCreateAccess(AccountInterface $account, array $context, $entity_bundle = NULL) {

    // If there is only one redhen_contact bundle, set $entity_bundle to it
    // since ContactAddController::add returns the add form for the solitary
    // bundle instead of a bundle select form if there is only one.
    if (!$entity_bundle) {
      $types = \Drupal::entityTypeManager()
        ->getStorage('redhen_contact_type')
        ->loadMultiple();
      if ($types && count($types) == 1) {
        $entity_bundle = array_keys($types)[0];
      }
    }
    return AccessResult::allowedIfHasPermissions($account, [
      'add contact entities',
      'add ' . $entity_bundle . ' contact',
    ], 'OR');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ContactAccessControlHandler::$viewLabelOperation protected property Allows to grant access to just the labels. Overrides EntityAccessControlHandler::$viewLabelOperation
ContactAccessControlHandler::checkAccess protected function Performs access checks. Overrides EntityAccessControlHandler::checkAccess
ContactAccessControlHandler::checkCreateAccess protected function Performs create access checks. Overrides EntityAccessControlHandler::checkCreateAccess
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::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. 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.