You are here

Home » API reference » Mass Password Change 8 » MassPasswordChangeConfirm.php

class MassPasswordChangeConfirm in Mass Password Change 8

Provides a confirmation form for mass password change action.

Hierarchy

Expanded class hierarchy of MassPasswordChangeConfirm

1 string reference to 'MassPasswordChangeConfirm'
mass_password_change.routing.yml in ./mass_password_change.routing.yml
mass_password_change.routing.yml

File

src/Form/MassPasswordChangeConfirm.php, line 15

Namespace

Drupal\mass_password_change\Form
View source 
class MassPasswordChangeConfirm extends ConfirmFormBase {

  /**
   * The temp store factory.
   *
   * @var \Drupal\Core\TempStore\PrivateTempStoreFactory
   */
  protected $tempStoreFactory;

  /**
   * The user storage.
   *
   * @var \Drupal\user\UserStorageInterface
   */
  protected $userStorage;

  /**
   * Constructs a new MassPasswordChangeConfirm.
   *
   * @param \Drupal\Core\TempStore\PrivateTempStoreFactory $temp_store_factory
   *   The temp store factory.
   * @param \Drupal\user\UserStorageInterface $userStorage
   *   The user storage.
   */
  public function __construct(PrivateTempStoreFactory $temp_store_factory, UserStorageInterface $userStorage) {
    $this->tempStoreFactory = $temp_store_factory;
    $this->userStorage = $userStorage;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('tempstore.private'), $container
      ->get('entity_type.manager')
      ->getStorage('user'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'mass_password_change.password_change_confirm';
  }

  /**
   * {@inheritdoc}
   */
  public function getQuestion() {
    return $this
      ->t('Are you sure you want to change password these user accounts?');
  }

  /**
   * {@inheritdoc}
   */
  public function getCancelUrl() {
    return new Url('entity.user.collection');
  }

  /**
   * {@inheritdoc}
   */
  public function getConfirmText() {
    return $this
      ->t('Change password');
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {

    // Retrieve the accounts to be canceled from the temp store.

    /* @var \Drupal\user\Entity\User[] $accounts */
    $accounts = $this->tempStoreFactory
      ->get('mass_password_change')
      ->get('password_change');
    if (!$accounts) {
      return $this
        ->redirect('entity.user.collection');
    }
    $list = [];
    foreach ($accounts as $account) {
      $uid = $account
        ->id();
      $list[$uid] = $account
        ->getAccountName();
      $form['accounts'][$uid] = [
        '#type' => 'hidden',
        '#value' => $uid,
      ];
    }
    $form['accounts']['#tree'] = TRUE;
    $form['account']['names'] = [
      '#theme' => 'item_list',
      '#items' => $list,
    ];
    $form['password_wrapper'] = [
      '#type' => 'fieldset',
    ];
    $form['password_wrapper']['password'] = [
      '#type' => 'password_confirm',
      '#size' => 25,
      '#description' => $this
        ->t('To change the current user password, enter the new password in both fields.'),
    ];
    $form = parent::buildForm($form, $form_state);
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {

    // Clear out the accounts from the temp store.
    $this->tempStoreFactory
      ->get('mass_password_change')
      ->delete('password_change');
    if ($form_state
      ->getValue('confirm')) {
      $password = $form_state
        ->getValue('password');
      foreach ($form_state
        ->getValue('accounts') as $uid) {

        /* @var \Drupal\user\Entity\User $account */
        $account = $this->userStorage
          ->load($uid);
        $account
          ->setPassword($password);
        $account
          ->save();
      }
    }
    $form_state
      ->setRedirect('entity.user.collection');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfirmFormBase::getCancelText public function Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface::getCancelText 1
ConfirmFormBase::getDescription public function Returns additional text to display as a description. Overrides ConfirmFormInterface::getDescription 11
ConfirmFormBase::getFormName public function Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface::getFormName
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 1
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. 1
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user.
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. Overrides UrlGeneratorTrait::redirect
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.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 62
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.
MassPasswordChangeConfirm::$tempStoreFactory protected property The temp store factory.
MassPasswordChangeConfirm::$userStorage protected property The user storage.
MassPasswordChangeConfirm::buildForm public function Form constructor. Overrides ConfirmFormBase::buildForm
MassPasswordChangeConfirm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
MassPasswordChangeConfirm::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
MassPasswordChangeConfirm::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
MassPasswordChangeConfirm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
MassPasswordChangeConfirm::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
MassPasswordChangeConfirm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
MassPasswordChangeConfirm::__construct public function Constructs a new MassPasswordChangeConfirm.
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.
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.