• Главная
• Phpauth
• Auth

PHP Класс Phpauth\Auth

Показать файл Открыть проект

Открытые свойства

Свойство	Тип	Описание
$config
$lang

Защищенные свойства (Protected)

Свойство	Тип	Описание
$dbh

Открытые методы

Метод	Описание
__construct ( PDO $dbh, $config, $language = "en_GB" )	Initiates database connection
activate ( string $key ) : array	Activates a user's account
changeEmail ( integer $uid, string $email, string $password, string $captcha = NULL ) : array	Changes a user's email
changePassword ( integer $uid, string $currpass, string $newpass, string $repeatnewpass, string $captcha = NULL ) : array	Changes a user's password
checkSession ( string $hash ) : boolean	Function to check if a session is valid
comparePasswords ( integer $userid, string $password_for_check ) : boolean	Compare user's password with given password
deleteUser ( integer $uid, string $password, string $captcha = NULL ) : array	Allows a user to delete their account
getHash ( string $password ) : string	Hashes provided password with Bcrypt
getRandomKey ( integer $length = 20 ) : string	Returns a random string of a specified length
getRequest ( string $key, string $type ) : array	Returns request data if key is valid
getSessionHash ( ) : string	Returns current session hash
getSessionUID ( string $hash ) : integer	Retrieves the UID associated with a given session hash
getUID ( string $email ) : array	Gets UID for a given email address and returns an array
getUser ( integer $uid ) : array	Gets public user data for a given UID and returns an array, password is not returned
isBlocked ( ) : string	Informs if a user is locked out
isEmailTaken ( string $email ) : boolean	Checks if an email is already in use
isLogged ( ) : boolean	Returns is user logged in
login ( string $email, string $password, integer $remember, string $captcha = NULL ) : array	Logs a user in
logout ( string $hash ) : boolean	Logs out the session, identified by hash
register ( string $email, string $password, string $repeatpassword, array $params = [], string $captcha = NULL, boolean $sendmail = NULL ) : array	Creates a new user, adds them to database
requestReset ( string $email, $sendmail = NULL ) : array	Creates a reset key for an email address and sends email
resendActivation ( string $email, $sendmail = NULL ) : array	Recreates activation email for a given email and sends
resetPass ( string $key, string $password, string $repeatpassword, string $captcha = NULL ) : array	Allows a user to reset their password after requesting a reset key.

Защищенные методы

Метод	Описание
addAttempt ( ) : boolean	Adds an attempt to database
addRequest ( integer $uid, string $email, string $type, boolean &$sendmail ) : boolean	Creates an activation entry and sends email to user
addSession ( integer $uid, boolean $remember ) : array	Creates a session for a specified user id
addUser ( string $email, string $password, array $params = [], &$sendmail ) : integer	Adds a new user to database
checkCaptcha ( string $captcha ) : boolean	Verifies a captcha code
deleteAttempts ( string $ip, boolean $all = false ) : boolean	Deletes all attempts for a given IP from database
deleteExistingSessions ( integer $uid ) : boolean	Removes all existing sessions for a given UID
deleteRequest ( integer $id ) : boolean	Deletes request from database
deleteSession ( string $hash ) : boolean	Removes a session based on hash
getBaseUser ( integer $uid ) : array	Gets basic user data for a given UID and returns an array
getIp ( ) : string	Returns IP address
validateEmail ( string $email ) : array	Verifies that an email is valid
validatePassword ( string $password ) : array	Verifies that a password is valid and respects security requirements

Описание методов

Описание свойств