pragma-framework/auth-session

The Pragma Module for handling users sessions in Pragma Framework

Pragma AuthSession

Prerequisites

This package uses PHP password_hash and password_verify functions, requiring minimum PHP >= 5.3.7., _(*1)

Compatibility with PHP versions from 5.3.7 to 5.5 is achieved by using ircmaxell/password-compat composer package., _(*2)

Configuration

config.php

In the config.php file, there is a AUTH_USER_MODEL constant, needed for a proper functioning of this package., _(*3)

This constant defines the model name representing users of your application., _(*4)

Example :, _(*5)

define('AUTH_USER_MODEL', 'App\\Models\\User');

You can also define the user's password hash generation cost. The system default cost is 10. You can overload this by setting AUTH_CRYPTO_COST to the desired value:, _(*6)

define('AUTH_CRYPTO_COST', 13);

session_start()

Do not forget to start session in public/index.phpof your application if you want to use this package., _(*7)

Available functions

AuthSession::hashgen($pwd)

This method returns the generated hash of the clear text $pwd parameter., _(*8)

AuthSession::check_password($pwd, $hash)

This method compares a clear password ($pwd) and the user's $hash., _(*9)

Return value will be true if password matches the hash, false otherwise., _(*10)

AuthSession::register_session($u)

This method stores identified user informations in session., _(*11)

AuthSession::signed_in()

This method returns true if the user is identified, false otherwise., _(*12)

AuthSession::get_signed_user()

This method return the object instance corresponding to the logged in user., _(*13)

AuthSession::destroy_session()

This method remove user informations from session, thus logout the user., _(*14)