class UserSwitchController in User Switch 8

Provides route responses for the Example module.

View source

class UserSwitchController extends ControllerBase {
  protected $userSwitch;
  protected $currentUser;
  protected $database;
  protected $messenger;

  /**
   * Constructs a new UserSwitchController object.
   */
  public function __construct(AccountInterface $currentUser, UserSwitch $userSwitch, Connection $database, MessengerInterface $messenger) {
    $this->currentUser = $currentUser;
    $this->userswitch = $userSwitch;
    $this->database = $database;
    $this->messenger = $messenger;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('current_user'), $container
      ->get('userswitch'), $container
      ->get('database'), $container
      ->get('messenger'));
  }

  /**
   * Returns a simple page.
   *
   * @return array
   *   A simple renderable array.
   */
  public function userSwitchList() {
    $_uid = $this->currentUser
      ->id();
    $query = $this->database
      ->select('users_field_data', 'u');
    $query
      ->fields('u', [
      'uid',
      'name',
      'mail',
    ]);

    // For the pagination we need to extend the pagerselectextender and
    // limit in the query.
    $query
      ->condition('uid', $_uid, '!=');
    $pager = $query
      ->extend('Drupal\\Core\\Database\\Query\\PagerSelectExtender')
      ->limit(10);
    $results = $pager
      ->execute()
      ->fetchAll();

    // Initialize an empty array.
    $output = [];
    $header = [
      '#',
      'Name',
      'Mail',
      'Operations',
    ];

    // Next, loop through the $results array.
    foreach ($results as $result) {
      if ($result->uid != 0) {
        $url = Url::fromUri('internal:/admin/people/user/' . $result->uid);
        $_link = Link::fromTextAndUrl($this
          ->t('Click Here'), $url);
        $output[$result->uid] = [
          'userid' => $result->uid,
          'Username' => $result->name,
          'email' => $result->mail,
          'link' => $_link,
        ];
      }
    }
    $element[] = [
      '#theme' => 'table',
      '#header' => $header,
      '#rows' => $output,
    ];
    return $element;
  }

  /**
   * Switch to new user.
   */
  public function switchuser($uid) {
    if ($this->userswitch
      ->switchToOther($uid)) {
      $message = $this
        ->t('You are now @user.', [
        '@user' => $this->currentUser
          ->getDisplayName(),
      ]);
      $this->messenger
        ->addMessage($message);
    }
    $url = Url::fromRoute('entity.user.canonical', [
      'user' => $uid,
    ])
      ->toString();
    $response = new RedirectResponse($url);
    $response
      ->send();
    return new Response();
  }

  /**
   * Switch back to original user.
   */
  public function switchbackuser() {

    // Store current user name for messages.
    $account_name = $this->currentUser
      ->getDisplayName();
    $get_uid = $this->userswitch
      ->getUserId();
    if ($get_uid) {
      if ($this->userswitch
        ->switchUserBack()) {
        $message = $this
          ->t('Switch account as @user.', [
          '@user' => $account_name,
        ]);
        $this->messenger
          ->addMessage($message);
      }
      else {
        $message = $this
          ->t('Error trying as @user.', [
          '@user,' => $account_name,
        ]);
        $this->messenger
          ->addMessage($message, $this->messenger::TYPE_ERROR);
      }
      $url = Url::fromRoute('entity.user.canonical', [
        'user' => $get_uid,
      ])
        ->toString();
    }
    else {
      $url = Url::fromRoute('user.admin_index');
    }
    $response = new RedirectResponse($url);
    $response
      ->send();
    return new Response();
  }

  /**
   * Checks access for this controller.
   */
  public function getUserSwitchPermissions() {
    if ($this->userswitch
      ->isSwitchUser()) {
      return AccessResult::allowed();
    }
    return AccessResult::forbidden();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ControllerBase::$configFactory	protected	property	The configuration factory.
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	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.
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.
UserSwitchController::$currentUser	protected	property	The current user service. Overrides ControllerBase::$currentUser
UserSwitchController::$database	protected	property
UserSwitchController::$messenger	protected	property	The messenger. Overrides MessengerTrait::$messenger
UserSwitchController::$userSwitch	protected	property
UserSwitchController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
UserSwitchController::getUserSwitchPermissions	public	function	Checks access for this controller.
UserSwitchController::switchbackuser	public	function	Switch back to original user.
UserSwitchController::switchuser	public	function	Switch to new user.
UserSwitchController::userSwitchList	public	function	Returns a simple page.
UserSwitchController::__construct	public	function	Constructs a new UserSwitchController object.

You are here

class UserSwitchController in User Switch 8

Hierarchy

File

Namespace

Members

API Navigation