1. class
  2. Automad
  3. \
  4. Types
  5. \
  6. User

User

class User (View source)

The User type is a custom data type that stores all data that is related to a user.

Properties

$email The user's email.
$name The username.
private $passwordHash The encrypted password.

Methods

__construct(string $name, string $password, string $email = '')

The constructor.

array
__serialize()

Serialize object.

__unserialize(array $properties)

Unserialize object.

string
getPasswordHash()

Get a hashed version of a user password.

setPasswordHash(string $password)

Store a hashed version of a given clear text password.

bool
verifyPassword(string $password)

Verify if a password matches its saved hashed version.

string
hash(string $password)

Create hash from password to store in accounts.txt.

Details

at line 71
__construct(string $name, string $password, string $email = '')

The constructor.

Parameters

string $name
string $password
string $email

at line 82
array __serialize()

Serialize object.

Return Value

array the associative array of properties

at line 95
__unserialize(array $properties)

Unserialize object.

Parameters

array $properties

at line 108
string getPasswordHash()

Get a hashed version of a user password.

Return Value

string the hashed password

at line 117
setPasswordHash(string $password)

Store a hashed version of a given clear text password.

Parameters

string $password

at line 127
bool verifyPassword(string $password)

Verify if a password matches its saved hashed version.

Parameters

string $password

Return Value

bool true if the password is verified

at line 139
private string hash(string $password)

Create hash from password to store in accounts.txt.

Parameters

string $password

Return Value

string Hashed/salted password