aerynl/reg-and-auth

Simple package for registering, activation, authentication and sending password reminders

reg-and-auth

Simple package for registering, activation, authentication and sending password reminders, _(*1)

Installing

• composer require aerynl/reg-and-auth "dev-master"
• php artisan vendor:publish --provider="Aerynl\RegAuth\RegAuthServiceProvider"
• php artisan migrate

2 and 3 will update database fields according to package requirements. It will insert the following fields (if they are not already present): username, activated, activation_code, reset_password_code. Also if activated field is just created, it will set all the current users as activated., _(*2)

How to use

Login

by username and password

$result = Aerynl\RegAuth\RegAuth::login($username, $password, $remember);, _(*3)

$username and $password are required parameters, $remember is not required., _(*4)

This function will check $username and $password for non-emptiness, find user by username or email, check if user is activated and log him in if everything is ok., _(*5)

It will return array('success' => false, 'message' => '...') in case of fail and array('success' => true) in case of success., _(*6)

by id

$result = Aerynl\RegAuth\RegAuth::simpleLoginById($id);, _(*7)

This function will check $id for non-emptiness, find user by id, check if user is activated and log him in if everything is ok., _(*8)

It will return array('success' => false, 'message' => '...') in case of fail and array('success' => true) in case of success., _(*9)

Get User

$user = Aerynl\RegAuth\RegAuth::getUser();, _(*10)

Fetches currently authenticated user, _(*11)

Returns null if there is no user in session., _(*12)

Logout

Aerynl\RegAuth\RegAuth::logout();, _(*13)

Logs out currently authenticated user, _(*14)

Register

$result = Aerynl\RegAuth\RegAuth::register($user_data);, _(*15)

$user_data is array, which must have email, password and password_confirmation. It also may have another fields, which will be stored to users table., _(*16)

This function will do the following: * check $user_data for validity * check if password and password_confirmation match * check if there is no user with the same email or username * register user * generate activation_code, _(*17)

It will return array('success' => false, 'message' => '...') in case of fail and array('success' => true, 'user' => $user) in case of success., _(*18)

Activate

$result = Aerynl\RegAuth\RegAuth::activate($hash);, _(*19)

$hash is a string, containing activation code., _(*20)

This function search for not activated user with activation_code = $hash and activates him., _(*21)

It will return array('success' => false, 'message' => '...') in case of fail and array('success' => true, 'user' => $user) in case of success., _(*22)

Forgot password

$result = Aerynl\RegAuth\RegAuth::generateForgotPassHash($username);, _(*23)

This function will check $username for non-emptiness, find user by username or email and generate reset_password_code., _(*24)

It will return array('success' => false, 'message' => '...') in case of fail and array('success' => true, 'user' => $user) in case of success., _(*25)

Forgot password step 2

$result = Aerynl\RegAuth\RegAuth::processForgotPassHash($hash);, _(*26)

This function search for user with reset_password_code = $hash and generates a new password for him., _(*27)

It will return array('success' => false, 'message' => '...') in case of fail and array('success' => true, 'user' => $user, 'new_pass' => $new_pass) in case of success., _(*28)

Password generator

$pass = Aerynl\RegAuth\RegAuth::generatePass();, _(*29)

Generates simple 6-number password, _(*30)

Change password

$result = Aerynl\RegAuth\RegAuth::changePass($pass_data, $user_id);, _(*31)

$pass_data is array, which must have old_password, new_password and password_confirmation., _(*32)

This function search for user with id = $user_id, checks if $pass_data['old_password'] is correct, checks if $pass_data['new_password'] and $pass_data['password_confirmation'] match and saves new password if everything is ok., _(*33)

It will return array('success' => false, 'message' => '...') in case of fail and array('success' => true) in case of success., _(*34)