interface AccountSwitcherInterface

Same name and namespace in other branches
  1. 11.x core/lib/Drupal/Core/Session/AccountSwitcherInterface.php \Drupal\Core\Session\AccountSwitcherInterface
  2. 10 core/lib/Drupal/Core/Session/AccountSwitcherInterface.php \Drupal\Core\Session\AccountSwitcherInterface
  3. 9 core/lib/Drupal/Core/Session/AccountSwitcherInterface.php \Drupal\Core\Session\AccountSwitcherInterface

Defines an interface for a service for safe account switching.

Hierarchy

Expanded class hierarchy of AccountSwitcherInterface

All classes that implement AccountSwitcherInterface

Related topics

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
View source
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();

}

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