class AccountProxy in Restrict Login or Role Access by IP Address 8.4

When the current user is loaded, remove any roles that are restricted based on IP whitelists. Proxy all other method calls to the original current_user service.

Hierarchy

• class \Drupal\restrict_by_ip\Session\AccountProxy implements AccountProxyInterface

File

src/Session/AccountProxy.php, line 19

Contains \Drupal\restrict_by_ip\Session\AccountProxy.

Namespace

Drupal\restrict_by_ip\Session

class AccountProxy implements AccountProxyInterface {

  /**
   * The original current_user service.
   *
   * @var \Drupal\Core\Session\AccountProxyInterface
   */
  protected $original;
  protected $roleFirewall;
  public function __construct(AccountProxyInterface $original, RoleFirewallInterface $role_firewall) {
    $this->original = $original;
    $this->roleFirewall = $role_firewall;
  }

  /**
   * Return roles for this user, less any that are restricted.
   *
   * @param bool $exclude_locked_roles
   *   (optional) If TRUE, locked roles (anonymous/authenticated) are not returned.
   *
   * @return array
   *   List of role IDs.
   */
  public function getRoles($exclude_locked_roles = FALSE) {
    $roles = $this->original
      ->getRoles($exclude_locked_roles);
    $remove_roles = $this->roleFirewall
      ->rolesToRemove();
    return array_diff($roles, $remove_roles);
  }

  /**
   * {@inheritdoc}
   */
  public function hasPermission($permission) {

    // User #1 has all privileges.
    if ((int) $this
      ->id() === 1) {
      return TRUE;
    }
    return $this
      ->getRoleStorage()
      ->isPermissionInRoles($permission, $this
      ->getRoles());
  }

  /**
   * {@inheritdoc}
   */
  public function setAccount(AccountInterface $account) {
    $this->original
      ->setAccount($account);
  }

  /**
   * {@inheritdoc}
   */
  public function getAccount() {
    return $this->original
      ->getAccount();
  }

  /**
   * {@inheritdoc}
   */
  public function id() {
    return $this->original
      ->id();
  }

  /**
   * {@inheritdoc}
   */
  public function isAuthenticated() {
    return $this->original
      ->isAuthenticated();
  }

  /**
   * {@inheritdoc}
   */
  public function isAnonymous() {
    return $this->original
      ->isAnonymous();
  }

  /**
   * {@inheritdoc}
   */
  public function getPreferredLangcode($fallback_to_default = TRUE) {
    return $this->original
      ->getPreferredLangcode($fallback_to_default);
  }

  /**
   * {@inheritdoc}
   */
  public function getPreferredAdminLangcode($fallback_to_default = TRUE) {
    return $this->original
      ->getPreferredAdminLangcode($fallback_to_default);
  }

  /**
   * {@inheritdoc}
   */
  public function getUsername() {
    return $this->original
      ->getUsername();
  }

  /**
   * {@inheritdoc}
   */
  public function getAccountName() {
    return $this->original
      ->getAccountName();
  }

  /**
   * {@inheritdoc}
   */
  public function getDisplayName() {
    return $this->original
      ->getDisplayName();
  }

  /**
   * {@inheritdoc}
   */
  public function getEmail() {
    return $this->original
      ->getEmail();
  }

  /**
   * {@inheritdoc}
   */
  public function getTimeZone() {
    return $this->original
      ->getTimeZone();
  }

  /**
   * {@inheritdoc}
   */
  public function getLastAccessedTime() {
    return $this->original
      ->getLastAccessedTime();
  }

  /**
   * {@inheritdoc}
   */
  public function setInitialAccountId($account_id) {
    $this->original
      ->setInitialAccountId($account_id);
  }

  /**
   * Returns the role storage object.
   *
   * @return \Drupal\user\RoleStorageInterface
   *   The role storage object.
   */
  protected function getRoleStorage() {
    return \Drupal::entityManager()
      ->getStorage('user_role');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AccountInterface::ANONYMOUS_ROLE		constant	Role ID for anonymous users.
AccountInterface::AUTHENTICATED_ROLE		constant	Role ID for authenticated users.
AccountProxy::$original	protected	property	The original current_user service.
AccountProxy::$roleFirewall	protected	property
AccountProxy::getAccount	public	function	Gets the currently wrapped account. Overrides AccountProxyInterface::getAccount
AccountProxy::getAccountName	public	function	Returns the unaltered login name of this account. Overrides AccountInterface::getAccountName
AccountProxy::getDisplayName	public	function	Returns the display name of this account. Overrides AccountInterface::getDisplayName
AccountProxy::getEmail	public	function	Returns the email address of this account. Overrides AccountInterface::getEmail
AccountProxy::getLastAccessedTime	public	function	The timestamp when the account last accessed the site. Overrides AccountInterface::getLastAccessedTime
AccountProxy::getPreferredAdminLangcode	public	function	Returns the preferred administrative language code of the account. Overrides AccountInterface::getPreferredAdminLangcode
AccountProxy::getPreferredLangcode	public	function	Returns the preferred language code of the account. Overrides AccountInterface::getPreferredLangcode
AccountProxy::getRoles	public	function	Return roles for this user, less any that are restricted. Overrides AccountInterface::getRoles
AccountProxy::getRoleStorage	protected	function	Returns the role storage object.
AccountProxy::getTimeZone	public	function	Returns the timezone of this account. Overrides AccountInterface::getTimeZone
AccountProxy::getUsername	public	function	Returns the unaltered login name of this account. Overrides AccountInterface::getUsername
AccountProxy::hasPermission	public	function	Checks whether a user has a certain permission. Overrides AccountInterface::hasPermission
AccountProxy::id	public	function	Returns the user ID or 0 for anonymous. Overrides AccountInterface::id
AccountProxy::isAnonymous	public	function	Returns TRUE if the account is anonymous. Overrides AccountInterface::isAnonymous
AccountProxy::isAuthenticated	public	function	Returns TRUE if the account is authenticated. Overrides AccountInterface::isAuthenticated
AccountProxy::setAccount	public	function	Sets the currently wrapped account. Overrides AccountProxyInterface::setAccount
AccountProxy::setInitialAccountId	public	function	Sets the id of the initial account. Overrides AccountProxyInterface::setInitialAccountId
AccountProxy::__construct	public	function