Vcode
<br/>
>i 本文档的最新修订日期是:
> **2021-02-16**
# Vcode
## 模块简述
生成验证码。
## 模块配置
配置文件位于 <font color="#c7254e">`/Config/Vcode.php`</font> 。
* **<font color="#ff6600">`FontFile`</font>** <font color="#0099ff">`(String)`</font> <font color="#bbbbbb">`'/Lib/VcodeFont.ttf'`</font> :
指定字体文件的路径。
>w 框架没有附带字体文件,需要自行添加,字体格式仅限 <font color="#c7254e">`TTF`</font> 。
## :: Base()方法
### 语法
**<font color="#0099ff"><font color="#ff6600">Vcode</font> :: <font color="#ff6600">Base</font> ( <kbd>传参数组</kbd> )</font>**
### 说明
生成验证码图片并将验证码文字存储在 <font color="#c7254e">`$_SESSION['Vcode']`</font> 中。在前端HTML页面直接以引用图片的方式使用(即 <font color="#c7254e">`<img>`</font> 标签中的 <font color="#c7254e">`src`</font> 属性)。
此方法 <font color="#c7254e">`支持`</font> 中文参数名。
### 参数
* **<font color="#ff6600">`width(宽度)`</font>** <font color="#0099ff">`(Int)`</font> <font color="#BBBBBB">`120`</font>:
用以指定验证码图片的宽度(单位为像素)。
* **<font color="#ff6600">`height(高度)`</font>** <font color="#0099ff">`(Int)`</font> <font color="#BBBBBB">`50`</font>:
用以指定验证码图片的高度(单位为像素)。
* **<font color="#ff6600">`word(文字)`</font>** <font color="#0099ff">`(String)`</font> <font color="#BBBBBB">`NULL`</font>:
用以指定验证码中的文字。
当值为 <font color="#c7254e">`NULL`</font> 时,将会随机生成5位由数字(0-9)和小写字母(a-z)生成的验证码。
传入的字符串或随机生成的字符串将会存储在 <font color="#c7254e">`$_SESSION['Vcode']`</font> 中,您可以在验证码校验验证码时使用它。
* **<font color="#ff6600">`word_color(文字颜色)`</font>** <font color="#0099ff">`(String)`</font> <font color="#BBBBBB">`#000000`</font>:
用以指定验证码文字的颜色。
值为颜色的Hex表达式,例如 <font color="#c7254e">`#fa3137`</font> 。
* **<font color="#ff6600">`noise_color(噪点颜色)`</font>** <font color="#0099ff">`(String)`</font> <font color="#BBBBBB">`#ff6600`</font>:
用以指定噪点的颜色。
值为颜色的Hex表达式,例如 <font color="#c7254e">`#fa3137`</font> 。
* **<font color="#ff6600">`dot(点)`</font>** <font color="#0099ff">`(Int)`</font> <font color="#BBBBBB">`0`</font>:
用以指定杂点数量,建议使用默认值。
* **<font color="#ff6600">`line(线)`</font>** <font color="#0099ff">`(Int)`</font> <font color="#BBBBBB">`0`</font>:
用以指定干扰线数量,建议使用默认值。
### 返回
<font color="#0099ff">`(String)`</font> 类型。
返回生成的(或传入的)验证码文本。
>d 使用本方法的文件中不能有其它输出。
>w 务必开启PHP的 <font color="#c7254e">`GD`</font> 库。