interface 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
- User accounts, permissions, and roles
- API for user accounts, access checking, roles, and permissions.
6 files declare their use of AccountSwitcherInterface
- AdminAccountSwitcher.php in core/
lib/ Drupal/ Core/ DefaultContent/ AdminAccountSwitcher.php - Cron.php in core/
lib/ Drupal/ Core/ Cron.php - EntityComment.php in core/
modules/ comment/ src/ Plugin/ migrate/ destination/ EntityComment.php - EntityContentBase.php in core/
modules/ migrate/ src/ Plugin/ migrate/ destination/ EntityContentBase.php - EntityRevision.php in core/
modules/ migrate/ src/ Plugin/ migrate/ destination/ EntityRevision.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 |