pragma-framework / auth-session
Pragma Framework 处理用户会话的模块
v1.0.2
2017-06-26 13:18 UTC
Requires
- php: >=5.5.0
- pragma-framework/core: ^1.0.0
This package is auto-updated.
Last update: 2024-09-21 02:20:16 UTC
README
先决条件
此包使用 PHP password_hash
和 password_verify
函数,需要最低 PHP >= 5.3.7
。
通过使用 ircmaxell/password-compat
composer 包 实现 5.3.7
到 5.5
的 PHP 版本兼容性。
配置
config.php
在 config.php
文件中,存在一个 AUTH_USER_MODEL
常量,这是此包正常工作所必需的。
此常量定义了代表您应用程序用户的模型名称。
示例
define('AUTH_USER_MODEL', 'App\\Models\\User');
您还可以定义用户密码哈希生成成本。系统默认成本为 10。您可以通过将 AUTH_CRYPTO_COST
设置为所需值来覆盖此值
define('AUTH_CRYPTO_COST', 13);
session_start()
如果您想使用此包,请勿忘记在应用程序的 public/index.php
中启动会话。
可用函数
AuthSession::hashgen($pwd)
此方法返回明文参数 $pwd
生成的哈希值。
AuthSession::check_password($pwd, $hash)
此方法比较明文密码 ($pwd
) 和用户的 $hash
。
返回值将是 true
如果密码与哈希匹配,否则为 false
。
AuthSession::register_session($u)
此方法将已识别的用户信息存储到会话中。
AuthSession::signed_in()
此方法返回 true
如果用户已识别,否则返回 false
。
AuthSession::get_signed_user()
此方法返回对应于已登录用户的对象实例。
AuthSession::destroy_session()
此方法从会话中删除用户信息,从而注销用户。