interface AccountSwitcherInterface

Same name in other branches
  1. 8.9.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. 11.x 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

8 files declare their use of AccountSwitcherInterface
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
EntityContentBaseTest.php in core/modules/migrate/tests/src/Unit/Plugin/migrate/destination/EntityContentBaseTest.php
Contains \Drupal\Tests\migrate\Unit\Plugin\migrate\destination\EntityContentBaseTest.
EntityRevision.php in core/modules/migrate/src/Plugin/migrate/destination/EntityRevision.php

... See full list

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

}

Members

Title Sort descending Modifiers Object type Summary Overrides
AccountSwitcherInterface::switchBack public function Reverts to a previous account after switching. 1
AccountSwitcherInterface::switchTo public function Safely switches to another account. 1

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