interface AccountSwitcherInterface in Drupal 9

Defines an interface for a service for safe account switching.

Hierarchy

• interface \Drupal\Core\Session\AccountSwitcherInterface

Related topics

User accounts, permissions, and roles

API for user accounts, access checking, roles, and permissions.

1 file declares its use of AccountSwitcherInterface

Cron.php in core/lib/Drupal/Core/Cron.php

File

core/lib/Drupal/Core/Session/AccountSwitcherInterface.php, line 10

Namespace

Drupal\Core\Session

interface AccountSwitcherInterface {

  /**
   * Safely switches to another account.
   *
   * Each invocation of AccountSwitcherInterface::switchTo() must be
   * matched by a corresponding invocation of
   * AccountSwitcherInterface::switchBack() in the same function.
   *
   * @param \Drupal\Core\Session\AccountInterface $account
   *   The account to switch to.
   *
   * @return $this
   *   $this.
   */
  public function switchTo(AccountInterface $account);

  /**
   * Reverts to a previous account after switching.
   *
   * @return $this
   *   $this.
   *
   * @throws \RuntimeException
   *   When there are no more account switches to revert.
   */
  public function switchBack();

}

Members

Name	Modifiers	Type	Description	Overrides
AccountSwitcherInterface::switchBack	public	function	Reverts to a previous account after switching.	1
AccountSwitcherInterface::switchTo	public	function	Safely switches to another account.	1