DefaultPasswordGenerator.php

Same filename and directory in other branches
  1. 9 core/lib/Drupal/Core/Password/DefaultPasswordGenerator.php
  2. 10 core/lib/Drupal/Core/Password/DefaultPasswordGenerator.php

Namespace

Drupal\Core\Password

File

core/lib/Drupal/Core/Password/DefaultPasswordGenerator.php

View source
<?php

namespace Drupal\Core\Password;

// cspell:ignore abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ23456789'

/**
 * Provides a default password generator.
 */
class DefaultPasswordGenerator implements PasswordGeneratorInterface {
  
  /**
   * The allowed characters for the password.
   *
   * Note that the number 0 and the letter 'O' have been removed to avoid
   * confusion between the two. The same is true of 'I', 1, and 'l'.
   *
   * @var string
   */
  protected $allowedChars = 'abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ23456789';
  
  /**
   * Generates a password.
   *
   * @param int $length
   *   (optional) The length of the password.
   *
   * @return string
   *   The password.
   */
  public function generate(int $length = 10) : string {
    // The maximum integer we want from random_int().
    $max = strlen($this->allowedChars) - 1;
    $pass = '';
    for ($i = 0; $i < $length; $i++) {
      $pass .= $this->allowedChars[random_int(0, $max)];
    }
    return $pass;
  }

}

Classes

Title Deprecated Summary
DefaultPasswordGenerator Provides a default password generator.

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