Password class

Class to hold combined password/salt info. Uses Blowfish when possible.

Specially used by FieldtypePassword.

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the Password class also inherits all the methods and properties of: Wire.

Common
Properties

Common

Name	Return	Summary
Password::isBlowfish() Password::isBlowfish() Password::isBlowfish(string $str = '')	`bool`	Returns whether the given string is blowfish hashed
Password::matches() Password::matches(string $pass) Password::matches(string $pass)	`bool`	Does this Password match the given string?
Password::randomAlnum() Password::randomAlnum() Password::randomAlnum(int $length = 0, array $options = [])	`string`	Return cryptographically secure random alphanumeric, alpha or numeric string
Password::randomAlpha() Password::randomAlpha() Password::randomAlpha(int $qty = 1, bool $alphanumeric = false, array $disallow = [])	`string`	Return a pseudo-random alpha or alphanumeric character
Password::randomBase64String() Password::randomBase64String() Password::randomBase64String(int $requiredLength = 22, $options = [])	`string` `array`	Generate a truly random base64 string of a certain length
Password::randomDigits() Password::randomDigits() Password::randomDigits(int $length = 0, array $options = [])	`string`	Return string of random digits
Password::randomLetters() Password::randomLetters() Password::randomLetters(int $length = 0, array $options = [])	`string`	Return string of random letters
Password::randomPass() Password::randomPass() Password::randomPass(array $options = [])	`string`	Generate and return a random password
Password::supportsBlowfish() Password::supportsBlowfish() Password::supportsBlowfish()	`bool`	Returns whether the current system supports Blowfish

Properties

Name	Return	Summary
Password::hash	`string`
Password::pass	`string`
Password::salt	`string`

Additional methods and properties

In addition to the methods and properties above, Password also inherits the methods and properties of these classes:

Wire

API reference based on ProcessWire core version 3.0.251