class ReferenceAccessControlHandler in Bibliography & Citation 8

Access controller for the Reference entity.

Hierarchy

• class \Drupal\Core\Entity\EntityHandlerBase uses DependencySerializationTrait, StringTranslationTrait
  • class \Drupal\Core\Entity\EntityAccessControlHandler implements EntityAccessControlHandlerInterface
    • class \Drupal\bibcite_entity\ReferenceAccessControlHandler

See also

\Drupal\bibcite_entity\Entity\Reference.

File

modules/bibcite_entity/src/ReferenceAccessControlHandler.php, line 17

Namespace

Drupal\bibcite_entity

class ReferenceAccessControlHandler extends EntityAccessControlHandler {

  /**
   * {@inheritdoc}
   */
  protected function checkAccess(EntityInterface $entity, $operation, AccountInterface $account) {
    $type = $entity
      ->bundle();

    /** @var \Drupal\bibcite_entity\Entity\Reference $entity */
    switch ($operation) {
      case 'view':
        return AccessResult::allowedIf($entity
          ->isPublished() && $account
          ->hasPermission('view bibcite_reference'))
          ->orIf(AccessResult::allowedIf(!$entity
          ->isPublished() && $account
          ->hasPermission('view own unpublished bibcite_reference') && $account
          ->isAuthenticated() && $entity
          ->getOwnerId() == $account
          ->id()))
          ->cachePerPermissions()
          ->cachePerUser()
          ->addCacheableDependency($entity);
      case 'update':
        return AccessResult::allowedIfHasPermission($account, 'edit any bibcite_reference')
          ->orIf(AccessResult::allowedIfHasPermission($account, "edit any {$type} bibcite_reference"))
          ->orIf(AccessResult::allowedIf($entity
          ->getOwnerId() == $account
          ->id() && ($account
          ->hasPermission('edit own bibcite_reference') || $account
          ->hasPermission("edit own {$type} bibcite_reference")))
          ->cachePerPermissions()
          ->cachePerUser());
      case 'delete':
        return AccessResult::allowedIfHasPermission($account, 'delete any bibcite_reference')
          ->orIf(AccessResult::allowedIfHasPermission($account, "delete any {$type} bibcite_reference"))
          ->orIf(AccessResult::allowedIf($entity
          ->getOwnerId() == $account
          ->id() && ($account
          ->hasPermission('delete own bibcite_reference') || $account
          ->hasPermission("delete own {$type} bibcite_reference")))
          ->cachePerPermissions()
          ->cachePerUser());
    }

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

  /**
   * {@inheritdoc}
   */
  protected function checkCreateAccess(AccountInterface $account, array $context, $entity_bundle = NULL) {
    return AccessResult::allowedIfHasPermission($account, 'create bibcite_reference')
      ->orIf(AccessResult::allowedIfHasPermission($account, 'create ' . $entity_bundle . ' bibcite_reference'));
  }

  /**
   * {@inheritdoc}
   */
  protected function checkFieldAccess($operation, FieldDefinitionInterface $field_definition, AccountInterface $account, FieldItemListInterface $items = NULL) {
    $administrative_fields = [
      'uid',
      'status',
      'created',
    ];
    $editing_administative = $operation == 'edit' && in_array($field_definition
      ->getName(), $administrative_fields, TRUE);
    $updating_revision = $operation == 'update' && $field_definition
      ->getName() === 'revision_id';
    if ($editing_administative || $updating_revision) {
      return AccessResult::allowedIfHasPermission($account, 'administer bibcite_reference');
    }
    return parent::checkFieldAccess($operation, $field_definition, $account, $items);
  }

}

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::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.
ReferenceAccessControlHandler::checkAccess	protected	function	Performs access checks. Overrides EntityAccessControlHandler::checkAccess
ReferenceAccessControlHandler::checkCreateAccess	protected	function	Performs create access checks. Overrides EntityAccessControlHandler::checkCreateAccess
ReferenceAccessControlHandler::checkFieldAccess	protected	function	Default field access as determined by this access control handler. Overrides EntityAccessControlHandler::checkFieldAccess
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.