class UserPasswordResetForm

Same name in other branches
  1. 9 core/modules/user/src/Form/UserPasswordResetForm.php \Drupal\user\Form\UserPasswordResetForm
  2. 10 core/modules/user/src/Form/UserPasswordResetForm.php \Drupal\user\Form\UserPasswordResetForm
  3. 11.x core/modules/user/src/Form/UserPasswordResetForm.php \Drupal\user\Form\UserPasswordResetForm

Form controller for the user password forms.

Users followed the link in the email, now they can enter a new password.

@internal

Hierarchy

Expanded class hierarchy of UserPasswordResetForm

1 file declares its use of UserPasswordResetForm
UserController.php in core/modules/user/src/Controller/UserController.php

File

core/modules/user/src/Form/UserPasswordResetForm.php, line 17

Namespace

Drupal\user\Form
View source
class UserPasswordResetForm extends FormBase {
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'user_pass_reset';
    }
    
    /**
     * {@inheritdoc}
     *
     * @param array $form
     *   An associative array containing the structure of the form.
     * @param \Drupal\Core\Form\FormStateInterface $form_state
     *   The current state of the form.
     * @param \Drupal\Core\Session\AccountInterface $user
     *   User requesting reset.
     * @param string $expiration_date
     *   Formatted expiration date for the login link, or NULL if the link does
     *   not expire.
     * @param int $timestamp
     *   The current timestamp.
     * @param string $hash
     *   Login link hash.
     */
    public function buildForm(array $form, FormStateInterface $form_state, AccountInterface $user = NULL, $expiration_date = NULL, $timestamp = NULL, $hash = NULL) {
        if ($expiration_date) {
            $form['message'] = [
                '#markup' => $this->t('<p>This is a one-time login for %user_name and will expire on %expiration_date.</p><p>Click on this button to log in to the site and change your password.</p>', [
                    '%user_name' => $user->getAccountName(),
                    '%expiration_date' => $expiration_date,
                ]),
            ];
            $form['#title'] = $this->t('Reset password');
        }
        else {
            // No expiration for first time login.
            $form['message'] = [
                '#markup' => $this->t('<p>This is a one-time login for %user_name.</p><p>Click on this button to log in to the site and change your password.</p>', [
                    '%user_name' => $user->getAccountName(),
                ]),
            ];
            $form['#title'] = $this->t('Set password');
        }
        $form['help'] = [
            '#markup' => '<p>' . $this->t('This login can be used only once.') . '</p>',
        ];
        $form['actions'] = [
            '#type' => 'actions',
        ];
        $form['actions']['submit'] = [
            '#type' => 'submit',
            '#value' => $this->t('Log in'),
        ];
        $form['#action'] = Url::fromRoute('user.reset.login', [
            'uid' => $user->id(),
            'timestamp' => $timestamp,
            'hash' => $hash,
        ])
            ->toString();
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        // This form works by submitting the hash and timestamp to the user.reset
        // route with a 'login' action.
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
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. 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::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 105
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 73
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. 17
MessengerTrait::messenger public function Gets the messenger. 17
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a &#039;destination&#039; 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.
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.
UserPasswordResetForm::buildForm public function Overrides FormInterface::buildForm
UserPasswordResetForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
UserPasswordResetForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.