1. class
  2. Automad
  3. \
  4. UI
  5. \
  6. Utils
  7. \
  8. Session

Session

class Session (View source)

The Session model class provides all methods related to a user session.

Methods

static 
clearResetTokenHash()

Clears the reset token hash

static string
getResetTokenHash(string $username)

Return the reset token hash for a given user.

static string
getUsername()

Return the currently logged in user.

static bool
login(string $nameOrEmail, string $password)

Verify login information based on $_POST.

static bool
logout()

Log out user.

static 
setResetTokenHash(string $username, string $tokenHash)

Set the reset token hash for a given user.

Details

at line 54
static clearResetTokenHash()

Clears the reset token hash

at line 64
static string getResetTokenHash(string $username)

Return the reset token hash for a given user.

Parameters

string $username

Return Value

string the token hash

at line 79
static string getUsername()

Return the currently logged in user.

Return Value

string Username

at line 94
static bool login(string $nameOrEmail, string $password)

Verify login information based on $_POST.

Parameters

string $nameOrEmail
string $password

Return Value

bool false on error

at line 121
static bool logout()

Log out user.

Return Value

bool true on success

at line 138
static setResetTokenHash(string $username, string $tokenHash)

Set the reset token hash for a given user.

Parameters

string $username
string $tokenHash