public function AutoUsernameSettingsForm::buildForm in Automatic User Names 8

Form constructor.

Parameters

array $form: An associative array containing the structure of the form.

\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form.

Return value

array The form structure.

Overrides ConfigFormBase::buildForm

File

src/Form/AutoUsernameSettingsForm.php, line 101

Class

AutoUsernameSettingsForm

Class AutoUsernameSettingsForm.

Namespace

Drupal\auto_username\Form

Code

public function buildForm(array $form, FormStateInterface $form_state) {
  $config = $this
    ->config('auto_username.settings');
  $form = [];
  $form['aun_general_settings'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('General settings'),
    '#open' => TRUE,
  ];
  $form['aun_general_settings']['aun_pattern'] = [
    '#type' => 'textarea',
    '#title' => $this
      ->t('Pattern for username'),
    '#description' => $this
      ->t('Enter the pattern for usernames.  You may use any of the tokens listed below.'),
    '#default_value' => $config
      ->get('aun_pattern'),
  ];
  $form['aun_general_settings']['token_help'] = [
    '#title' => $this
      ->t('Replacement patterns'),
    '#type' => 'details',
    '#open' => TRUE,
    '#description' => $this
      ->t('Note that fields that are not present in the user registration form will get replaced with an empty string when the account is created.  That is rarely desirable.'),
  ];
  $form['aun_general_settings']['token_help']['help'] = [
    '#theme' => 'token_tree_link',
    '#token_types' => [
      'user',
    ],
    '#global_types' => NULL,
  ];

  // Other module configuration.
  $form['aun_other_settings'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('Other settings'),
    '#open' => TRUE,
    '#collapsed' => FALSE,
  ];
  if ($this->account
    ->hasPermission('use PHP for username patterns')) {
    $form['aun_other_settings']['aun_php'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Evaluate PHP in pattern.'),
      '#description' => $this
        ->t('If this box is checked, the pattern will be executed as PHP code after token substitution has taken place.  You must surround the PHP code in <?php and ?> tags.  Token replacement will take place before PHP code execution.  Note that $account is available and can be used by your code.'),
      '#default_value' => $config
        ->get('aun_php'),
    ];
  }
  $form['aun_other_settings']['aun_update_on_edit'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Update on user edit'),
    '#description' => $this
      ->t("If this box is checked, the username will be reset any time the user's profile is updated.  That can help to enforce a username format, but may result in a user's login name changing unexpectedly.  It is best used in conjunction with an alternative login mechanism, such as OpenID or an e-mail address."),
    '#default_value' => $config
      ->get('aun_update_on_edit'),
  ];
  $form['aun_other_settings']['aun_separator'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Separator'),
    '#size' => 1,
    '#maxlength' => 1,
    '#default_value' => $config
      ->get('aun_separator'),
    '#description' => $this
      ->t('Character used to separate words in titles. This will replace any spaces and punctuation characters.'),
  ];
  $form['aun_other_settings']['aun_case'] = [
    '#type' => 'radios',
    '#title' => $this
      ->t('Character case'),
    '#default_value' => $config
      ->get('aun_case'),
    '#options' => [
      AUN_CASE_LEAVE_ASIS => $this
        ->t('Leave case the same as source token values.'),
      AUN_CASE_LOWER => $this
        ->t('Change to lower case'),
    ],
  ];
  $max_length = $this
    ->autoUsernameGetSchemaNameMaxlength();
  $form['aun_other_settings']['aun_max_length'] = [
    '#type' => 'number',
    '#title' => $this
      ->t('Maximum alias length'),
    '#size' => 3,
    '#default_value' => $config
      ->get('aun_max_length'),
    '#min' => 1,
    '#max' => $max_length,
    '#description' => $this
      ->t('Maximum length of aliases to generate. @max is the maximum possible length.', [
      '@max' => $max_length,
    ]),
  ];
  $form['aun_other_settings']['aun_max_component_length'] = [
    '#type' => 'number',
    '#title' => $this
      ->t('Maximum component length'),
    '#size' => 3,
    '#default_value' => $config
      ->get('aun_max_component_length'),
    '#min' => 1,
    '#max' => $max_length,
    '#description' => $this
      ->t('Maximum text length of any component in the username (e.g., [user:mail]). @max is the maximum possible length.', [
      '@max' => $max_length,
    ]),
  ];
  $form['aun_other_settings']['aun_transliterate'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Transliterate prior to creating username'),
    '#default_value' => $config
      ->get('aun_transliterate') && $this->moduleHandler
      ->moduleExists('transliteration'),
    '#description' => $this
      ->t('When a pattern includes certain characters (such as those with accents) should auto_username attempt to transliterate them into the ASCII-96 alphabet? Transliteration is handled by the Transliteration module.'),
    '#access' => $this->moduleHandler
      ->moduleExists('transliteration'),
  ];
  $form['aun_other_settings']['aun_reduce_ascii'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Reduce strings to letters and numbers'),
    '#default_value' => $config
      ->get('aun_reduce_ascii'),
    '#description' => $this
      ->t('Filters the new username to only letters and numbers found in the ASCII-96 set.'),
  ];
  $form['aun_other_settings']['aun_replace_whitespace'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Replace whitespace with separator.'),
    '#default_value' => $config
      ->get('aun_replace_whitespace'),
    '#description' => $this
      ->t('Replace all whitespace in tokens with the separator character specified below.  Note that this will affect the tokens themselves, not the pattern specified above.  To avoid spaces entirely, ensure that the pattern above contains no spaces.'),
  ];
  $form['aun_other_settings']['aun_ignore_words'] = [
    '#type' => 'textarea',
    '#title' => $this
      ->t('Strings to Remove'),
    '#default_value' => $config
      ->get('aun_ignore_words'),
    '#description' => $this
      ->t('Words to strip out of the username, separated by commas. Do not use this to remove punctuation.'),
    '#wysiwyg' => FALSE,
  ];
  $form['punctuation'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('Punctuation'),
    '#open' => TRUE,
  ];
  $punctuation = $this
    ->autoUsernamePunctuationChars();
  foreach ($punctuation as $name => $details) {
    $details['default'] = AUN_PUNCTUATION_REMOVE;
    if ($details['value'] == $config
      ->get('aun_separator')) {
      $details['default'] = AUN_PUNCTUATION_REPLACE;
    }
    $form['punctuation']['aun_punctuation_' . $name] = [
      '#type' => 'select',
      '#title' => $details['name'] . ' (<code>' . Html::escape($details['value']) . '</code>)',
      '#default_value' => $config
        ->get('aun_punctuation_' . $name, $details['default']),
      '#options' => [
        AUN_PUNCTUATION_REMOVE => $this
          ->t('Remove'),
        AUN_PUNCTUATION_REPLACE => $this
          ->t('Replace by separator'),
        AUN_PUNCTUATION_DO_NOTHING => $this
          ->t('No action (do not replace)'),
      ],
    ];
  }
  return parent::buildForm($form, $form_state);
}