mhhex/sms-verify-code

V1.0.0 2024-10-30 14:39 UTC

Requires

• topthink/framework: ^6.0|^8.0

Apache-2.0

• mhhex

README

适用于 thinkphp >= 6.0.0 的短信验证码生成、缓存、验证类库

主要特性

• 支持 7 种验证码类型
• 基于 ThinkPHP 缓存
• 灵活的配置机制

安装

composer require mhhex/sms-verify-code

使用文档

声明

use mhhex\SmsVerifyCode;

生成验证码验证一

// 生成验证码并缓存
// 默认生成 6 位数字验证码，默认获取前端输入的手机号字段名为 mobile
$code = (new SmsVerifyCode())->create();

// 验证短信验证码
// 默认获取前端输入的手机号字段名为 mobile，验证码字段名为 code
$smsVerifyCode = new SmsVerifyCode();
if(! $smsVerifyCode->check()){
    // 验证失败，获取失败信息
    $msg = $smsVerifyCode->getErrorMsg();
}

生成验证码验证二

// 手动传入号码示例
$code = (new SmsVerifyCode())->mobile('18888888888')->create();

// 手动传入号码和验证码进行验证示例
$smsVerifyCode = new SmsVerifyCode();
$smsVerifyCode->mobile('18888888888')->code('123456')->check();

验证场景

// 生成登录（login）场景的验证码并缓存
$code = (new SmsVerifyCode())->scene('login')->create();

// 验证登录（login）场景短信验证码
$smsVerifyCode = new SmsVerifyCode();
if(! $smsVerifyCode->scene('login')->check()){
    // 验证失败，获取失败信息
    $msg = $smsVerifyCode->getErrorMsg();
}

验证码类型

// 生成数字与大写字母混合型验证码并缓存
$code = (new SmsVerifyCode(['type'=>5]))->create();

动态配置

$config = ['type'=>1,'length'=>4];
$smsVerifyCode = new SmsVerifyCode($config);

版权信息

sms-verify-code遵循Apache2开源协议发布，并提供免费使用。