function EntityAccessControlHandler::createAccess

Same name and namespace in other branches
  1. 11.x core/lib/Drupal/Core/Entity/EntityAccessControlHandler.php \Drupal\Core\Entity\EntityAccessControlHandler::createAccess()
  2. 10 core/lib/Drupal/Core/Entity/EntityAccessControlHandler.php \Drupal\Core\Entity\EntityAccessControlHandler::createAccess()
  3. 8.9.x core/lib/Drupal/Core/Entity/EntityAccessControlHandler.php \Drupal\Core\Entity\EntityAccessControlHandler::createAccess()

File

core/lib/Drupal/Core/Entity/EntityAccessControlHandler.php, line 230

Class

EntityAccessControlHandler
Defines a default implementation for entity access control handler.

Namespace

Drupal\Core\Entity

Code

public function createAccess($entity_bundle = NULL, AccountInterface $account = NULL, array $context = [], $return_as_object = FALSE) {
  $account = $this->prepareUser($account);
  $context += [
    'entity_type_id' => $this->entityTypeId,
    'langcode' => LanguageInterface::LANGCODE_DEFAULT,
  ];
  $cid = $entity_bundle ? 'create:' . $entity_bundle : 'create';
  if (($access = $this->getCache($cid, 'create', $context['langcode'], $account)) !== NULL) {
    // Cache hit, no work necessary.
    return $return_as_object ? $access : $access->isAllowed();
  }
  // Invoke hook_entity_create_access() and hook_ENTITY_TYPE_create_access().
  // Hook results take precedence over overridden implementations of
  // EntityAccessControlHandler::checkCreateAccess(). Entities that have
  // checks that need to be done before the hook is invoked should do so by
  // overriding this method.
  // We grant access to the entity if both of these conditions are met:
  // - No modules say to deny access.
  // - At least one module says to grant access.
  $access = array_merge($this->moduleHandler()
    ->invokeAll('entity_create_access', [
    $account,
    $context,
    $entity_bundle,
  ]), $this->moduleHandler()
    ->invokeAll($this->entityTypeId . '_create_access', [
    $account,
    $context,
    $entity_bundle,
  ]));
  $return = $this->processAccessHookResults($access);
  // Also execute the default access check except when the access result is
  // already forbidden, as in that case, it can not be anything else.
  if (!$return->isForbidden()) {
    $return = $return->orIf($this->checkCreateAccess($account, $context, $entity_bundle));
  }
  $result = $this->setCache($return, $cid, 'create', $context['langcode'], $account);
  return $return_as_object ? $result : $result->isAllowed();
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.