class EmailConfirmationAccessControlHandler in Email confirmer 8

Access controller for the email confirmation entity.

Hierarchy

• class \Drupal\Core\Entity\EntityHandlerBase uses DependencySerializationTrait, StringTranslationTrait
  • class \Drupal\Core\Entity\EntityAccessControlHandler implements EntityAccessControlHandlerInterface
    • class \Drupal\email_confirmer\EmailConfirmationAccessControlHandler implements EntityHandlerInterface

See also

\Drupal\email_confirmer\Entity\EmailConfirmation.

File

src/EmailConfirmationAccessControlHandler.php, line 20

Namespace

Drupal\email_confirmer

class EmailConfirmationAccessControlHandler extends EntityAccessControlHandler implements EntityHandlerInterface {

  /**
   * The email confirmer config.
   *
   * @var \Drupal\Core\Config\ImmutableConfig
   */
  protected $confirmerConfig;

  /**
   * The request stack.
   *
   * @var \Symfony\Component\HttpFoundation\RequestStack
   */
  protected $requestStack;

  /**
   * Creates a new EmailConfirmationAccessControlHandler.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type definition.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory.
   * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack
   *   The request stack.
   */
  public function __construct(EntityTypeInterface $entity_type, ConfigFactoryInterface $config_factory, RequestStack $request_stack) {
    parent::__construct($entity_type);
    $this->confirmerConfig = $config_factory
      ->get('email_confirmer.settings');
    $this->requestStack = $request_stack;
  }

  /**
   * {@inheritdoc}
   */
  public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
    return new static($entity_type, $container
      ->get('config.factory'), $container
      ->get('request_stack'));
  }

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

    /** @var \Drupal\email_confirmer\EmailConfirmationInterface $entity */
    if ($account
      ->hasPermission('administer email confirmations')) {
      return AccessResult::allowed()
        ->cachePerPermissions();
    }

    // IP access restriction.
    if ($this->confirmerConfig
      ->get('restrict_same_ip') && !$entity
      ->get('ip')
      ->isEmpty() && $entity
      ->get('ip')
      ->getString() != $this->requestStack
      ->getCurrentRequest()
      ->getClientIp()) {
      return AccessResult::forbidden()
        ->addCacheContexts([
        'ip',
      ])
        ->addCacheTags($entity
        ->getCacheTags());
    }

    // Private confirmation access restriction.
    if ($entity
      ->isPrivate() && !in_array($entity
      ->get('uid')->target_id, [
      0,
      $account
        ->id(),
    ])) {
      return AccessResult::forbidden()
        ->cachePerUser()
        ->addCacheTags($entity
        ->getCacheTags());
    }
    return AccessResult::allowedIfHasPermission($account, 'access email confirmation')
      ->cachePerPermissions()
      ->addCacheTags($entity
      ->getCacheTags());
  }

  /**
   * {@inheritdoc}
   */
  protected function checkCreateAccess(AccountInterface $account, array $context, $entity_bundle = NULL) {
    return AccessResult::allowedIfHasPermission($account, 'access email confirmation')
      ->cachePerPermissions();
  }

}

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
EmailConfirmationAccessControlHandler::$confirmerConfig	protected	property	The email confirmer config.
EmailConfirmationAccessControlHandler::$requestStack	protected	property	The request stack.
EmailConfirmationAccessControlHandler::checkAccess	protected	function	Performs access checks. Overrides EntityAccessControlHandler::checkAccess
EmailConfirmationAccessControlHandler::checkCreateAccess	protected	function	Performs create access checks. Overrides EntityAccessControlHandler::checkCreateAccess
EmailConfirmationAccessControlHandler::createInstance	public static	function	Instantiates a new instance of this entity handler. Overrides EntityHandlerInterface::createInstance
EmailConfirmationAccessControlHandler::__construct	public	function	Creates a new EmailConfirmationAccessControlHandler. Overrides EntityAccessControlHandler::__construct
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.
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.