You are here

interface AccountSwitcherInterface in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 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
Contains \Drupal\Core\Cron.

File

core/lib/Drupal/Core/Session/AccountSwitcherInterface.php, line 15
Contains \Drupal\Core\Session\AccountSwitcherInterface.

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 \Drupal\Core\Session\AccountSwitcherInterface
   *   $this.
   */
  public function switchTo(AccountInterface $account);

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

}

Members

Namesort descending 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