# php-verifycode

**Repository Path**: liuxiaojinla/php-verifycode

## Basic Information

- **Project Name**: php-verifycode
- **Description**: 一个用于快速集成短信和邮件验证码功能的 Composer 包，帮助开发者在业务系统中轻松实现验证码的生成、发送和验证。
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-12-09
- **Last Updated**: 2025-12-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# VerifyCode | 验证码

## 介绍

一个用于快速集成短信和邮件验证码功能的 Composer 包，帮助开发者在业务系统中轻松实现验证码的生成、发送和验证。

### 功能简介

- **验证码生成**：支持生成随机数字验证码或自定义验证码。
- **验证码发送**：支持通过短信或邮件发送验证码。
- **验证码验证**：提供简单的验证接口，确保用户输入的验证码与系统生成的验证码一致。
- **灵活配置**：支持多种短信和邮件服务提供商，如阿里云、腾讯云 等。
- **存储支持**：支持将验证码存储在 Redis、数据库或内存中（可选）。


## 安装教程

`composer require xin/verifycode`

## 使用说明

**配置文件 config.php**

```php
<?php
// +----------------------------------------------------------------------
// | 验证码设置
// +----------------------------------------------------------------------

return [
	// 默认配置
	'defaults' => [
		'driver' => 'default'
	],

	// 驱动列表
	'drivers' => [
		// 短信验证码
		'default' => [
			'driver' => 'sms',
			'sms' => 'aliyun',
			'template' => '',
			'table' => 'verify_code'
		]
	]
];
```

实例化管理器

```php
<?php
$verifyCodeManager = new \Xin\VerifyCode\VerifyCodeManager($config);

// 用户ID身份
$identifier = 1;

// 生产验证码
$verifyCodeManager->make($identifier,'login');

// 验证验证码
$verifyCodeManager->verify($identifier,'login');
```