You are here

Home » API reference » YAML Form 8 » YamlFormEntityAccessControlHandler.php

class YamlFormEntityAccessControlHandler in YAML Form 8

Defines the access control handler for the form entity type.

Hierarchy

Expanded class hierarchy of YamlFormEntityAccessControlHandler

See also

\Drupal\yamlform\Entity\YamlForm.

File

src/YamlFormEntityAccessControlHandler.php, line 15

Namespace

Drupal\yamlform
View source 
class YamlFormEntityAccessControlHandler extends EntityAccessControlHandler {

  /**
   * {@inheritdoc}
   */
  protected function checkCreateAccess(AccountInterface $account, array $context, $entity_bundle = NULL) {
    if ($account
      ->hasPermission('create yamlform')) {
      return AccessResult::allowed()
        ->cachePerPermissions();
    }
    else {
      return parent::checkCreateAccess($account, $context, $entity_bundle);
    }
  }

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

    /** @var  \Drupal\yamlform\YamlFormInterface $entity */

    // Check 'view' using 'create' custom form submission access rules.
    // Viewing a form is the same as creating a form submission.
    if ($operation == 'view') {
      return AccessResult::allowed();
    }
    $uid = $entity
      ->getOwnerId();
    $is_owner = $account
      ->isAuthenticated() && $account
      ->id() == $uid;

    // Check if 'update' or 'delete' of 'own' or 'any' form is allowed.
    if ($account
      ->isAuthenticated()) {
      switch ($operation) {
        case 'update':
          if ($account
            ->hasPermission('edit any yamlform') || $account
            ->hasPermission('edit own yamlform') && $is_owner) {
            return AccessResult::allowed()
              ->cachePerPermissions()
              ->cachePerUser()
              ->addCacheableDependency($entity);
          }
          break;
        case 'duplicate':
          if ($entity
            ->isTemplate() || ($account
            ->hasPermission('edit any yamlform') || $account
            ->hasPermission('edit own yamlform') && $is_owner)) {
            return AccessResult::allowed()
              ->cachePerPermissions()
              ->cachePerUser()
              ->addCacheableDependency($entity);
          }
          break;
        case 'delete':
          if ($account
            ->hasPermission('delete any yamlform') || $account
            ->hasPermission('delete own yamlform') && $is_owner) {
            return AccessResult::allowed()
              ->cachePerPermissions()
              ->cachePerUser()
              ->addCacheableDependency($entity);
          }
          break;
      }
    }

    // Check submission_* operation.
    if (strpos($operation, 'submission_') === 0) {

      // Allow users with 'view any yamlform submission' to view all submissions.
      if ($operation == 'submission_view_any' && $account
        ->hasPermission('view any yamlform submission')) {
        return AccessResult::allowed();
      }

      // Completely block access to a template if the user can't create new
      // Forms.
      if ($operation == 'submission_page' && $entity
        ->isTemplate() && !$entity
        ->access('create')) {
        return AccessResult::forbidden()
          ->cachePerPermissions()
          ->cachePerUser()
          ->addCacheableDependency($entity);
      }

      // Check custom form submission access rules.
      if ($this
        ->checkAccess($entity, 'update', $account)
        ->isAllowed() || $entity
        ->checkAccessRules(str_replace('submission_', '', $operation), $account)) {
        return AccessResult::allowed()
          ->cachePerPermissions()
          ->cachePerUser()
          ->addCacheableDependency($entity);
      }
    }
    return parent::checkAccess($entity, $operation, $account);
  }

}

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
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::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.
YamlFormEntityAccessControlHandler::checkAccess public function Performs access checks. Overrides EntityAccessControlHandler::checkAccess
YamlFormEntityAccessControlHandler::checkCreateAccess protected function Performs create access checks. Overrides EntityAccessControlHandler::checkCreateAccess