1. class
  2. Core
  3. \
  4. Services
  5. \
  6. AuthService

AuthService

class AuthService

Supports authentication operations.

Methods

static string
confirm(Input $request)

Gets value of password confirm field. Assumes field value is "confirm".

static Users|false|null
currentUser()

Checks if a user is logged in.

static string
hashPassword(string $password)

Hashes a plain text password using PHP's password_hash() with the default algorithm.

static Login
login(Input $request, Login $loginModel, string $username, bool $mailer = false)

Attempts to log a user in. If successful, resets login attempts and creates a session. Otherwise, tracks failed attempts and optionally triggers an email notification.

static Login
loginAttempts(Users $user, Login $loginModel, bool $mailer = false)

Tests for login attempts and sets session messages when there is a failed attempt or when account is locked.

static void
loginUser(Users $loginUser, bool $rememberMe = false)

Creates a session when the user logs in. A new record is added to the user_sessions table and a cookie is created if remember me is selected.

static Users|null
loginUserFromCookie()

Logs in user from cookie.

static void
logout()

Logs out the currently logged-in user by clearing the session and deleting any active cookies.

static bool
logoutUser(Users $user)

Perform logout operation on current logged in user. The record for the current logged in user is removed from the user_session table and the corresponding cookie is deleted.

static void
passwordReset(Input $request, Users $user)

Handles the complete flow of resetting a user’s password, including setting the confirmation field and updating the record.

static Uploads|null
profileImageUpload(Users $user)

Processes a profile image upload and returns an Uploads object.

Details

at line 27
static string confirm(Input $request)

Gets value of password confirm field. Assumes field value is "confirm".

Parameters

Input $request

The request.

Return Value

string

The value of the confirm field.

at line 37
static Users|false|null currentUser()

Checks if a user is logged in.

Return Value

Users|false|null

An object containing information about current logged in user from users table.

at line 51
static string hashPassword(string $password)

Hashes a plain text password using PHP's password_hash() with the default algorithm.

Parameters

string $password

Original password submitted on a registration or update password form.

Return Value

string

The hashed version of the password.

at line 67
static Login login(Input $request, Login $loginModel, string $username, bool $mailer = false)

Attempts to log a user in. If successful, resets login attempts and creates a session. Otherwise, tracks failed attempts and optionally triggers an email notification.

Parameters

Input $request

The request for the login.
Login $loginModel

The login model.
string $username

The user to be logged in.
bool $mailer

Sends account deactivated E-mail when user surpasses max number of login attempts before account is locked.

Return Value

Login

Model that handles logins.

at line 107
static Login loginAttempts(Users $user, Login $loginModel, bool $mailer = false)

Tests for login attempts and sets session messages when there is a failed attempt or when account is locked.

Parameters

Users $user

The user whose login attempts we are tracking.
Login $loginModel

The model that will be responsible for displaying messages.
bool $mailer

Sends account deactivated E-mail when user surpasses max number of login attempts before account is locked.

Return Value

Login

$loginModel The Login model after login in attempt test and session messages are assigned.

at line 136
static void loginUser(Users $loginUser, bool $rememberMe = false)

Creates a session when the user logs in. A new record is added to the user_sessions table and a cookie is created if remember me is selected.

Parameters

Users $loginUser

The user to be logged in.
bool $rememberMe

Value obtained from remember me checkbox found in login form. Default value is false.

Return Value

void

at line 171
static Users|null loginUserFromCookie()

Logs in user from cookie.

Return Value

Users|null

The user associated with previous session.

at line 189
static void logout()

Logs out the currently logged-in user by clearing the session and deleting any active cookies.

Return Value

void

at line 204
static bool logoutUser(Users $user)

Perform logout operation on current logged in user. The record for the current logged in user is removed from the user_session table and the corresponding cookie is deleted.

Parameters

Users $user

The user to be logged out.

Return Value

bool

Returns true if operation is successful.

at line 226
static void passwordReset(Input $request, Users $user)

Handles the complete flow of resetting a user’s password, including setting the confirmation field and updating the record.

Parameters

Input $request

The request for the password reset action.
Users $user

The user whose password we will reset.

Return Value

void

at line 250
static Uploads|null profileImageUpload(Users $user)

Processes a profile image upload and returns an Uploads object.

Assumes the input name is profileImage.

Parameters

Users $user

The user who uploaded a profile image.

Return Value

Uploads|null

The uploads object if it's created or null.