class SwitchController in Masquerade 8.2

Controller for switch and back to masquerade as user.

Hierarchy

class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\masquerade\Controller\SwitchController

Expanded class hierarchy of SwitchController

File

src/Controller/SwitchController.php, line 18

Namespace

Drupal\masquerade\Controller

View source

class SwitchController extends ControllerBase {

  /**
   * The masquerade service.
   *
   * @var \Drupal\masquerade\Masquerade
   */
  protected $masquerade;

  /**
   * The redirect destination helper.
   *
   * @var \Drupal\Core\Routing\RedirectDestinationInterface
   */
  private $destination;

  /**
   * Constructs a new SwitchController object.
   *
   * @param \Drupal\Core\Session\AccountInterface $current_user
   *   The current user.
   * @param \Drupal\masquerade\Masquerade $masquerade
   *   The masquerade service.
   * @param \Drupal\Core\Routing\RedirectDestinationInterface $destination
   *   The redirect destination helper.
   */
  public function __construct(AccountInterface $current_user, Masquerade $masquerade, RedirectDestinationInterface $destination) {
    $this->currentUser = $current_user;
    $this->masquerade = $masquerade;
    $this->destination = $destination;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('current_user'), $container
      ->get('masquerade'), $container
      ->get('redirect.destination'));
  }

  /**
   * Masquerades the current user as a given user.
   *
   * Access to masquerade as the target user account has to checked by
   * all callers via masquerade_target_user_access() already.
   *
   * @param \Drupal\user\UserInterface $user
   *   The user account object to masquerade as.
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request object.
   *
   * @return \Symfony\Component\HttpFoundation\RedirectResponse
   *   Redirect to previous page.
   *
   * @see this::getRedirectResponse()
   */
  public function switchTo(UserInterface $user, Request $request) {

    // Store current user for messages.
    $account = $this->currentUser;
    $error = masquerade_switch_user_validate($user);
    if (empty($error)) {
      if ($this->masquerade
        ->switchTo($user)) {
        $this
          ->messenger()
          ->addStatus($this
          ->t('You are now masquerading as @user.', [
          '@user' => $account
            ->getDisplayName(),
        ]));
      }
    }
    else {
      $this
        ->messenger()
        ->addError($error);
    }
    return $this
      ->getRedirectResponse($request);
  }

  /**
   * Allows a user who is currently masquerading to become a new user.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request object.
   *
   * @return \Symfony\Component\HttpFoundation\RedirectResponse
   *   Redirect response to previous page.
   *
   * @see this::getRedirectResponse()
   */
  public function switchBack(Request $request) {

    // Store current user name for messages.
    $account_name = $this->currentUser
      ->getDisplayName();
    if ($this->masquerade
      ->switchBack()) {
      $this
        ->messenger()
        ->addStatus($this
        ->t('You are no longer masquerading as @user.', [
        '@user' => $account_name,
      ]));
    }
    else {
      $this
        ->messenger()
        ->addError($this
        ->t('Error trying unmasquerading as @user.', [
        '@user' => $account_name,
      ]));
    }
    return $this
      ->getRedirectResponse($request);
  }

  /**
   * Returns redirect response to previous page.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request object.
   *
   * @return \Symfony\Component\HttpFoundation\RedirectResponse
   *   The redirect.
   *
   * @see \Drupal\Core\EventSubscriber\RedirectResponseSubscriber::checkRedirectUrl()
   */
  protected function getRedirectResponse(Request $request) {
    if ($destination_path = $this->destination
      ->get()) {

      // When Drupal is installed in a sub-directory, destination path have to
      // cut off the baseUrl part.
      $destination_path = preg_replace('/^' . preg_quote($request
        ->getBaseUrl(), '/') . '/', '', $destination_path);

      // Try destination first.
      $url = Url::createFromRequest(Request::create($destination_path));
    }
    elseif ($redirect_path = $request->server
      ->get('HTTP_REFERER')) {

      // Parse referer to get route name if any.
      $url = Url::createFromRequest(Request::create($redirect_path));
    }
    else {

      // Fallback to front page if no referrer.
      $url = Url::fromRoute('<front>');
    }

    // Check access for redirected url.
    if (!$url
      ->access($this->currentUser)) {

      // Fallback to front page redirect.
      $url = Url::fromRoute('<front>');
    }
    $url = $url
      ->setAbsolute()
      ->toString();
    if ($destination_path) {

      // Override destination because it will take over response.
      $request->query
        ->set('destination', $url);
      $this->destination
        ->set($url);
    }
    return new RedirectResponse($url);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ControllerBase::$configFactory	protected	property	The configuration factory.
ControllerBase::$currentUser	protected	property	The current user service.	1
ControllerBase::$entityFormBuilder	protected	property	The entity form builder.
ControllerBase::$entityManager	protected	property	The entity manager.
ControllerBase::$entityTypeManager	protected	property	The entity type manager.
ControllerBase::$formBuilder	protected	property	The form builder.	2
ControllerBase::$keyValue	protected	property	The key-value storage.	1
ControllerBase::$languageManager	protected	property	The language manager.	1
ControllerBase::$moduleHandler	protected	property	The module handler.	2
ControllerBase::$stateService	protected	property	The state service.
ControllerBase::cache	protected	function	Returns the requested cache bin.
ControllerBase::config	protected	function	Retrieves a configuration object.
ControllerBase::container	private	function	Returns the service container.
ControllerBase::currentUser	protected	function	Returns the current user.	1
ControllerBase::entityFormBuilder	protected	function	Retrieves the entity form builder.
ControllerBase::entityManager Deprecated	protected	function	Retrieves the entity manager service.
ControllerBase::entityTypeManager	protected	function	Retrieves the entity type manager.
ControllerBase::formBuilder	protected	function	Returns the form builder service.	2
ControllerBase::keyValue	protected	function	Returns a key/value storage collection.	1
ControllerBase::languageManager	protected	function	Returns the language manager service.	1
ControllerBase::moduleHandler	protected	function	Returns the module handler.	2
ControllerBase::redirect	protected	function	Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state	protected	function	Returns the state storage service.
LinkGeneratorTrait::$linkGenerator	protected	property	The link generator.	1
LinkGeneratorTrait::getLinkGenerator Deprecated	protected	function	Returns the link generator.
LinkGeneratorTrait::l Deprecated	protected	function	Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated	public	function	Sets the link generator service.
LoggerChannelTrait::$loggerFactory	protected	property	The logger channel factory service.
LoggerChannelTrait::getLogger	protected	function	Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory	public	function	Injects the logger channel factory.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination	protected	function	Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination	public	function	Sets the redirect destination service.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
SwitchController::$destination	private	property	The redirect destination helper.
SwitchController::$masquerade	protected	property	The masquerade service.
SwitchController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
SwitchController::getRedirectResponse	protected	function	Returns redirect response to previous page.
SwitchController::switchBack	public	function	Allows a user who is currently masquerading to become a new user.
SwitchController::switchTo	public	function	Masquerades the current user as a given user.
SwitchController::__construct	public	function	Constructs a new SwitchController object.
UrlGeneratorTrait::$urlGenerator	protected	property	The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated	protected	function	Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated	public	function	Sets the URL generator service.
UrlGeneratorTrait::url Deprecated	protected	function	Generates a URL or path for a specific route based on the given parameters.

You are here

class SwitchController in Masquerade 8.2

Hierarchy

File

Namespace

Members

API Navigation