interface AccountSwitcherInterface
Same name in other branches
- 9 core/lib/Drupal/Core/Session/AccountSwitcherInterface.php \Drupal\Core\Session\AccountSwitcherInterface
- 8.9.x core/lib/Drupal/Core/Session/AccountSwitcherInterface.php \Drupal\Core\Session\AccountSwitcherInterface
- 10 core/lib/Drupal/Core/Session/AccountSwitcherInterface.php \Drupal\Core\Session\AccountSwitcherInterface
Defines an interface for a service for safe account switching.
Hierarchy
- interface \Drupal\Core\Session\AccountSwitcherInterface
Expanded class hierarchy of AccountSwitcherInterface
All classes that implement AccountSwitcherInterface
Related topics
12 files declare their use of AccountSwitcherInterface
- AccessPolicyProcessorTest.php in core/
tests/ Drupal/ Tests/ Core/ Session/ AccessPolicyProcessorTest.php - AdminAccountSwitcher.php in core/
lib/ Drupal/ Core/ DefaultContent/ AdminAccountSwitcher.php - AdminAccountSwitcherTest.php in core/
tests/ Drupal/ KernelTests/ Core/ DefaultContent/ AdminAccountSwitcherTest.php - Cron.php in core/
lib/ Drupal/ Core/ Cron.php - CronSuspendQueueDelayTest.php in core/
tests/ Drupal/ Tests/ Core/ Cron/ CronSuspendQueueDelayTest.php
File
-
core/
lib/ Drupal/ Core/ Session/ AccountSwitcherInterface.php, line 10
Namespace
Drupal\Core\SessionView 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();
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overrides |
---|---|---|---|---|
AccountSwitcherInterface::switchBack | public | function | Reverts to a previous account after switching. | 2 |
AccountSwitcherInterface::switchTo | public | function | Safely switches to another account. | 2 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.