You are here

Home » API reference » Recovery Password (Email New Password) 8 » RecoveryPassSettingsForm.php

class RecoveryPassSettingsForm in Recovery Password (Email New Password) 8

Configure recovery_pass settings for this site.

Hierarchy

Expanded class hierarchy of RecoveryPassSettingsForm

1 string reference to 'RecoveryPassSettingsForm'
recovery_pass.routing.yml in ./recovery_pass.routing.yml
recovery_pass.routing.yml

File

src/RecoveryPassSettingsForm.php, line 15
Contains \Drupal\recovery_pass\RecoveryPassSettingsForm

Namespace

Drupal\recovery_pass
View source 
class RecoveryPassSettingsForm extends ConfigFormBase {

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'recovery_pass_admin_settings';
  }

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'recovery_pass.settings',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('recovery_pass.settings');
    $form['recovery_pass_help_text'] = array(
      '#type' => 'item',
      '#markup' => t('Edit the e-mail messages sent to users who request a new password. The list of available tokens that can be used in e-mails is provided below. For displaying new password please use <strong>[user_new_password]</strong> placeholder.'),
    );
    $form['recovery_pass_email_subject'] = array(
      '#type' => 'textfield',
      '#title' => t('Subject'),
      '#required' => TRUE,
      '#default_value' => $config
        ->get('email_subject'),
    );
    $form['recovery_pass_email_body'] = array(
      '#type' => 'textarea',
      '#title' => t('Email Body'),
      '#required' => TRUE,
      '#default_value' => $config
        ->get('email_body'),
    );
    if (\Drupal::moduleHandler()
      ->moduleExists("htmlmail")) {

      // Adding description incase HTMLMAIL module exists.
      $form['recovery_pass_email_text']['#description'] = t('Supports HTML Mail provided HTMLMAIL module is enabled.');
    }
    if (\Drupal::moduleHandler()
      ->moduleExists("token")) {
      $form['token_help'] = array(
        '#type' => 'markup',
        '#token_types' => array(
          'user',
        ),
        '#theme' => 'token_tree_link',
      );
    }
    $form['recovery_pass_old_pass_show'] = array(
      '#type' => 'checkbox',
      '#title' => t('Show Warning message to users for trying old password at login form.'),
      '#default_value' => $config
        ->get('old_pass_show'),
    );
    $form['recovery_pass_old_pass_warning'] = array(
      '#type' => 'textarea',
      '#rows' => 2,
      '#title' => t('Old Password Warning Message'),
      '#description' => t('Warning message to be shown, if user after resetting the password uses the old password again.'),
      '#default_value' => $config
        ->get('old_pass_warning'),
    );
    $form['recovery_pass_fpass_redirect'] = array(
      '#type' => 'textfield',
      '#title' => t('Redirect Path after Forgot Password Page'),
      '#maxlength' => 255,
      '#default_value' => $config
        ->get('fpass_redirect'),
      '#description' => t('The path to redirect user, after forgot password form. This can be an internal Drupal path such as %add-node or an external URL such as %drupal. Enter %front to link to the front page.', array(
        '%front' => '<front>',
        '%add-node' => 'node/add',
        '%drupal' => 'http://drupal.org',
      )),
      '#required' => TRUE,
      '#element_validate' => array(
        '_recovery_pass_validate_path',
      ),
    );
    $form['recovery_pass_expiry_period'] = array(
      '#type' => 'textfield',
      '#title' => t('Expiry Period'),
      '#description' => t('Please enter expiry period in weeks. After these many weeks the record for old password warning to be shown to that particular user would be deleted.'),
      '#default_value' => $config
        ->get('expiry_period'),
      '#element_validate' => array(
        '_recovery_pass_validate_integer_positive',
      ),
    );
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('recovery_pass.settings');
    $config
      ->set('email_subject', $form_state
      ->getValue('recovery_pass_email_subject'))
      ->save();
    $config
      ->set('email_body', $form_state
      ->getValue('recovery_pass_email_body'))
      ->save();
    $config
      ->set('old_pass_show', $form_state
      ->getValue('recovery_pass_old_pass_show'))
      ->save();
    $config
      ->set('old_pass_warning', $form_state
      ->getValue('recovery_pass_old_pass_warning'))
      ->save();
    $config
      ->set('fpass_redirect', $form_state
      ->getValue('recovery_pass_fpass_redirect'))
      ->save();
    $config
      ->set('expiry_period', $form_state
      ->getValue('recovery_pass_expiry_period'))
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigFormBase::create public static function Instantiates a new instance of this class. Overrides FormBase::create 13
ConfigFormBase::__construct public function Constructs a \Drupal\system\ConfigFormBase object. 11
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
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::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.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RecoveryPassSettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
RecoveryPassSettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
RecoveryPassSettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
RecoveryPassSettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
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.