YwxAppThink/ywxapp/library/Sms.php

<?php
/*
 * @Author: YwxApp <ywx@ywxapp.cn>
 * @Date: 2026-08-06 22:05:48
 * @LastEditors: YwxApp <ywx@ywxapp.cn>
 * @LastEditTime: 2026-08-19 22:12:47
 * @Description: 
 * @FilePath: \ywxapp_dev\ywxapp\library\Sms.php
 * @CustomString: Copyright (c) 2026 YwxApp
 */
// +----------------------------------------------------------------------
// | YwxApp [ WE CAN DO IT JUST THINK ]
// +----------------------------------------------------------------------
// | Copyright (c) 2026-2036 http://ywxapp.cn All rights reserved.
// +----------------------------------------------------------------------
// | Author: ywxapp<admin@ywxapp.cn>
// +----------------------------------------------------------------------
namespace ywxapp\library;

use ywxapp\utils\Random;
use think\facade\Event; 
use ywxapp\model\CommonSms as SmsModel; 

/**
 * 短信验证码类
 */
class Sms  
{

    /**
     * 验证码有效时长
     * @var int
     */
    protected static $expire = 120;

    /**
     * 最大允许检测的次数
     * @var int
     */
    protected static $maxCheckNums = 10;

    /**
     * 归一化入参为字符串，过滤数组等非法类型，避免 PDO 参数绑定报错
     *
     * @param mixed $value
     * @return string
     */
    protected static function normalize($value): string
    {
        return is_scalar($value) ? (string) $value : '';
    }

    /**
     * 获取最后一次手机发送的数据
     *
     * @param   int    $mobile 手机号
     * @param   string $event  事件
     * @return  Sms
     */
    public static function get($mobile, $event = 'default')
    {
        $mobile = static::normalize($mobile);
        $event  = static::normalize($event);
        $sms = SmsModel::where(['mobile' => $mobile, 'event' => $event]) ->order('id', 'DESC') ->find();
        Event::trigger('SmsGet', $sms, true);
        return $sms ?: null;    
    }

    /**
     * 发送验证码
     *
     * @param   int    $mobile 手机号
     * @param   int    $code   验证码,为空时将自动生成4位数字
     * @param   string $event  事件
     * @return  boolean
     */
    public static function send($mobile, $code = null, $event = 'default')
    {   
        $mobile = static::normalize($mobile);
        $event  = static::normalize($event);

        $code   = is_null($code) ? Random::numeric(6) : $code;
        $time   = time();
        $ip     = request()->ip();
        $sms    = SmsModel::create(['event' => $event, 'mobile' => $mobile, 'code' => $code, 'ip' => $ip, 'create_at' => $time]);
        $result = Event::trigger('SmsSend', $sms, true);
        if (! $result) {
            $sms->delete();
            return false;
        }
        return true;
    }

    /**
     * 发送通知
     *
     * @param   mixed  $mobile   手机号,多个以,分隔
     * @param   string $msg      消息内容
     * @param   string $template 消息模板
     * @return  boolean
     */
    public static function notice($mobile, $msg = '', $template = null)
    {
        $params = [
            'mobile'   => $mobile,
            'msg'      => $msg,
            'template' => $template,
        ];
        $result = Event::trigger('SmsNotice', $params, true);
        return (bool) $result;
    }

    /**
     * 校验验证码
     *
     * @param   int    $mobile 手机号
     * @param   int    $code   验证码
     * @param   string $event  事件
     * @return  boolean
     */
    public static function check($mobile, $code, $event = 'default')
    {
        $mobile = static::normalize($mobile);
        $event  = static::normalize($event);
        $time = time() - self::$expire;
        $sms  = SmsModel::where(['mobile' => $mobile, 'event' => $event]) ->order('id', 'DESC') ->find();
        if ($sms) {
            if ($sms['create_at'] > $time && $sms['times'] <= self::$maxCheckNums) {
                $correct = $code == $sms['code'];
                if (! $correct) {
                    $sms->times = $sms->times + 1;
                    $sms->save();
                    return false;
                } else {
                    $result = Event::trigger('SmsCheck', $sms, true);
                    return $result;
                }
            } else {
                // 过期则清空该手机验证码
                self::flush($mobile, $event);
                return false;
            }
        } else {
            return false;
        }
    }

    /**
     * 清空指定手机号验证码
     *
     * @param   int    $mobile 手机号
     * @param   string $event  事件
     * @return  boolean
     */
    public static function flush($mobile, $event = 'default')
    {
        $mobile = static::normalize($mobile);
        $event  = static::normalize($event);
        SmsModel::where(['mobile' => $mobile, 'event' => $event])
            ->delete();
        Event::trigger('SmsFlush');
        return true;
    }
}