class PasswordReset in Password Policy 8.3
Provides a form to reset user passwords by role.
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\password_policy\Form\PasswordReset
Expanded class hierarchy of PasswordReset
1 string reference to 'PasswordReset'
File
- src/
Form/ PasswordReset.php, line 16
Namespace
Drupal\password_policy\FormView source
class PasswordReset extends FormBase {
/**
* The role storage.
*
* @var \Drupal\user\RoleStorageInterface
*/
protected $roleStorage;
/**
* The user storage.
*
* @var \Drupal\user\UserStorageInterface
*/
protected $userStorage;
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
/** @var \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager */
$entity_type_manager = $container
->get('entity_type.manager');
return new static($entity_type_manager
->getStorage('user_role'), $entity_type_manager
->getStorage('user'));
}
/**
* Constructs a new PasswordReset form.
*
* @param \Drupal\user\RoleStorageInterface $role_storage
* The role storage.
* @param \Drupal\user\UserStorageInterface $user_storage
* The user storage.
*/
public function __construct(RoleStorageInterface $role_storage, UserStorageInterface $user_storage) {
$this->roleStorage = $role_storage;
$this->userStorage = $user_storage;
}
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'password_policy_reset_form';
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state) {
$options = [];
foreach ($this->roleStorage
->loadMultiple() as $role) {
$options[$role
->id()] = $role
->label();
}
unset($options[AccountInterface::ANONYMOUS_ROLE]);
$form['roles'] = [
'#type' => 'checkboxes',
'#title' => $this
->t('Roles'),
'#description' => $this
->t('Force password reset of selected roles.'),
'#options' => $options,
];
$form['exclude_myself'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Exclude Myself'),
'#description' => $this
->t('Exclude your account if you are included in the roles.'),
'#default_value' => '1',
];
$form['save'] = [
'#type' => 'submit',
'#value' => $this
->t('Save'),
];
return $form;
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
if ($roles = array_filter($form_state
->getValue('roles'))) {
foreach ($roles as $key => $role) {
$roles[$key] = $this->roleStorage
->load($role)
->label();
}
// Authenticated role includes all users so we can ignore all other roles.
$properties = [];
if (!array_key_exists(AccountInterface::AUTHENTICATED_ROLE, $roles)) {
$properties['roles'] = array_keys($roles);
}
$users = $this->userStorage
->loadByProperties($properties);
$exclude_myself = $form_state
->getValue('exclude_myself') == '1';
/** @var \Drupal\user\UserInterface $user */
foreach ($users as $user) {
if ($exclude_myself && $user
->id() === $this
->currentUser()
->id()) {
continue;
}
if ($user
->hasRole(AccountInterface::ANONYMOUS_ROLE)) {
continue;
}
$user
->set('field_password_expiration', '1');
$user
->save();
}
$this
->messenger()
->addMessage($this
->formatPlural(count($roles), 'Reset the %roles role.', 'Reset the %roles roles.', [
'%roles' => implode(', ', array_values($roles)),
]));
}
else {
$this
->messenger()
->addWarning($this
->t('No roles selected.'));
}
$form_state
->setRedirectUrl(new Url('entity.password_policy.collection'));
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
FormBase:: |
protected | property | The config factory. | 1 |
FormBase:: |
protected | property | The request stack. | 1 |
FormBase:: |
protected | property | The route match. | |
FormBase:: |
protected | function | Retrieves a configuration object. | |
FormBase:: |
protected | function | Gets the config factory for this form. | 1 |
FormBase:: |
private | function | Returns the service container. | |
FormBase:: |
protected | function | Gets the current user. | |
FormBase:: |
protected | function | Gets the request object. | |
FormBase:: |
protected | function | Gets the route match. | |
FormBase:: |
protected | function | Gets the logger for a specific channel. | |
FormBase:: |
protected | function |
Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait:: |
|
FormBase:: |
public | function | Resets the configuration factory. | |
FormBase:: |
public | function | Sets the config factory for this form. | |
FormBase:: |
public | function | Sets the request stack object to use. | |
FormBase:: |
public | function |
Form validation handler. Overrides FormInterface:: |
62 |
LinkGeneratorTrait:: |
protected | property | The link generator. | 1 |
LinkGeneratorTrait:: |
protected | function | Returns the link generator. | |
LinkGeneratorTrait:: |
protected | function | Renders a link to a route given a route name and its parameters. | |
LinkGeneratorTrait:: |
public | function | Sets the link generator service. | |
LoggerChannelTrait:: |
protected | property | The logger channel factory service. | |
LoggerChannelTrait:: |
protected | function | Gets the logger for a specific channel. | |
LoggerChannelTrait:: |
public | function | Injects the logger channel factory. | |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PasswordReset:: |
protected | property | The role storage. | |
PasswordReset:: |
protected | property | The user storage. | |
PasswordReset:: |
public | function |
Form constructor. Overrides FormInterface:: |
|
PasswordReset:: |
public static | function |
Instantiates a new instance of this class. Overrides FormBase:: |
|
PasswordReset:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
|
PasswordReset:: |
public | function |
Form submission handler. Overrides FormInterface:: |
|
PasswordReset:: |
public | function | Constructs a new PasswordReset form. | |
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
UrlGeneratorTrait:: |
protected | property | The url generator. | |
UrlGeneratorTrait:: |
protected | function | Returns the URL generator service. | |
UrlGeneratorTrait:: |
public | function | Sets the URL generator service. | |
UrlGeneratorTrait:: |
protected | function | Generates a URL or path for a specific route based on the given parameters. |