Gitee
\

\LoginAuth

登录验证

Summary

Methods
Properties
Constants
isLogin()
checkUser()
loginPage()
getUserDataByLogin()
checkPassword()
setAuthCookie()
genToken()
checkToken()
No public properties found
LOGIN_ERROR_USER
LOGIN_ERROR_PASSWD
LOGIN_ERROR_AUTHCODE
No protected methods found
No protected properties found
N/A
generateAuthCookie()
emHash()
validateAuthCookie()
No private properties found
N/A

Constants

LOGIN_ERROR_USER

LOGIN_ERROR_USER = -1

LOGIN_ERROR_PASSWD

LOGIN_ERROR_PASSWD = -2

LOGIN_ERROR_AUTHCODE

LOGIN_ERROR_AUTHCODE = -3

Methods

isLogin()

isLogin()

验证用户是否处于登录状态

checkUser()

checkUser(string  $username, string  $password, string  $imgcode, string  $logincode = false)

验证密码/用户

Parameters

string $username
string $password
string $imgcode
string $logincode

loginPage()

loginPage(  $errorCode = NULL)

登录页面

Parameters

$errorCode

getUserDataByLogin()

getUserDataByLogin(string  $userLogin) : boolean|object

通过登录名查询管理员信息

Parameters

string $userLogin

User's username

Returns

boolean|object —

False on failure, User DB row object

checkPassword()

checkPassword(string  $password, string  $hash) : boolean

将明文密码和数据库加密后的密码进行验证

Parameters

string $password

Plaintext user's password
string $hash

Hash of the user's password to check against.

Returns

boolean —

False, if the $password does not match the hashed password

setAuthCookie()

setAuthCookie(  $user_login,   $ispersis = false)

写用于登录验证cookie

Parameters

$user_login
$ispersis

genToken()

genToken()

生成token，防御CSRF攻击

checkToken()

checkToken()

检查token，防御CSRF攻击

generateAuthCookie()

generateAuthCookie(  $user_login, integer  $expiration) : string

生成登录验证cookie

Parameters

$user_login
integer $expiration

Cookie expiration in seconds

Returns

string —

Authentication cookie contents

emHash()

emHash(string  $data) : string

Get hash of given string.

Parameters

string $data

Plain text to hash

Returns

string —

Hash of $data

validateAuthCookie()

validateAuthCookie(string  $cookie = '') : boolean|integer

验证cookie Validates authentication cookie.

Parameters

string $cookie

Optional. If used, will validate contents instead of cookie's

Returns

boolean|integer —

False if invalid cookie, User ID if valid.