class SwitchUserForm
Same name in other branches
- 8.x-1.x src/Form/SwitchUserForm.php \Drupal\devel\Form\SwitchUserForm
- 4.x src/Form/SwitchUserForm.php \Drupal\devel\Form\SwitchUserForm
Define a form to allow the user to switch and become another user.
Hierarchy
- class \Drupal\Core\Form\FormBase implements \Drupal\Core\Form\FormInterface, \Drupal\Core\DependencyInjection\ContainerInjectionInterface uses \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Logger\LoggerChannelTrait, \Drupal\Core\Messenger\MessengerTrait, \Drupal\Core\Routing\RedirectDestinationTrait, \Drupal\Core\StringTranslation\StringTranslationTrait
- class \Drupal\devel\Form\SwitchUserForm extends \Drupal\Core\Form\FormBase
Expanded class hierarchy of SwitchUserForm
1 file declares its use of SwitchUserForm
- SwitchUserBlock.php in src/
Plugin/ Block/ SwitchUserBlock.php
File
-
src/
Form/ SwitchUserForm.php, line 15
Namespace
Drupal\devel\FormView source
class SwitchUserForm extends FormBase {
/**
* The csrf token generator.
*/
protected CsrfTokenGenerator $csrfToken;
/**
* The user storage.
*/
protected UserStorageInterface $userStorage;
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) : static {
$instance = parent::create($container);
$instance->csrfToken = $container->get('csrf_token');
$instance->userStorage = $container->get('entity_type.manager')
->getStorage('user');
$instance->stringTranslation = $container->get('string_translation');
return $instance;
}
/**
* {@inheritdoc}
*/
public function getFormId() : string {
return 'devel_switchuser_form';
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state) : array {
$form['autocomplete'] = [
'#type' => 'container',
'#attributes' => [
'class' => [
'container-inline',
],
],
];
$form['autocomplete']['userid'] = [
'#type' => 'entity_autocomplete',
'#title' => $this->t('Username'),
'#placeholder' => $this->t('Enter username'),
'#target_type' => 'user',
'#selection_settings' => [
'include_anonymous' => FALSE,
],
'#process_default_value' => FALSE,
'#title_display' => 'invisible',
'#required' => TRUE,
'#size' => '28',
];
$form['autocomplete']['actions'] = [
'#type' => 'actions',
];
$form['autocomplete']['actions']['submit'] = [
'#type' => 'submit',
'#value' => $this->t('Switch'),
];
return $form;
}
/**
* {@inheritdoc}
*/
public function validateForm(array &$form, FormStateInterface $form_state) : void {
$userId = $form_state->getValue('userid');
if ($userId === NULL) {
$form_state->setErrorByName('userid', $this->t('Username not found'));
return;
}
/** @var \Drupal\user\UserInterface|null $account */
$account = $this->userStorage
->load($userId);
if ($account === NULL) {
$form_state->setErrorByName('userid', $this->t('Username not found'));
}
else {
$form_state->setValue('username', $account->getAccountName());
}
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) : void {
// We cannot rely on automatic token creation, since the csrf seed changes
// after the redirect and the generated token is not more valid.
// @todo find another way to do this.
$url = Url::fromRoute('devel.switch', [
'name' => $form_state->getValue('username'),
]);
$url->setOption('query', [
'token' => $this->csrfToken
->get($url->getInternalPath()),
]);
$form_state->setRedirectUrl($url);
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
DependencySerializationTrait::$_entityStorages | protected | property | |||
DependencySerializationTrait::$_serviceIds | protected | property | |||
DependencySerializationTrait::__sleep | public | function | 1 | ||
DependencySerializationTrait::__wakeup | public | function | 2 | ||
FormBase::$configFactory | protected | property | The config factory. | 3 | |
FormBase::$requestStack | protected | property | The request stack. | 1 | |
FormBase::$routeMatch | protected | property | The route match. | ||
FormBase::config | protected | function | Retrieves a configuration object. | ||
FormBase::configFactory | protected | function | Gets the config factory for this form. | 3 | |
FormBase::container | private | function | Returns the service container. | ||
FormBase::currentUser | protected | function | Gets the current user. | 2 | |
FormBase::getRequest | protected | function | Gets the request object. | ||
FormBase::getRouteMatch | protected | function | Gets the route match. | ||
FormBase::logger | protected | function | Gets the logger for a specific channel. | ||
FormBase::redirect | protected | function | Returns a redirect response object for the specified route. | ||
FormBase::resetConfigFactory | public | function | Resets the configuration factory. | ||
FormBase::setConfigFactory | public | function | Sets the config factory for this form. | ||
FormBase::setRequestStack | public | function | Sets the request stack object to use. | ||
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. | 16 | |
MessengerTrait::messenger | public | function | Gets the messenger. | 16 | |
MessengerTrait::setMessenger | public | function | Sets the messenger. | ||
RedirectDestinationTrait::$redirectDestination | protected | property | The redirect destination service. | 2 | |
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. | 3 | |
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. | ||
SwitchUserForm::$csrfToken | protected | property | The csrf token generator. | ||
SwitchUserForm::$userStorage | protected | property | The user storage. | ||
SwitchUserForm::buildForm | public | function | Form constructor. | Overrides FormInterface::buildForm | |
SwitchUserForm::create | public static | function | Instantiates a new instance of this class. | Overrides FormBase::create | |
SwitchUserForm::getFormId | public | function | Returns a unique string identifying the form. | Overrides FormInterface::getFormId | |
SwitchUserForm::submitForm | public | function | Form submission handler. | Overrides FormInterface::submitForm | |
SwitchUserForm::validateForm | public | function | Form validation handler. | Overrides FormBase::validateForm |