Captcha - APIPHP开源框架

>i 本文档的最新修订日期是： > **2024-02-29** # Captcha :: 生成验证码。 # 依赖本模块依赖于PHP拓展 `GD2` 。 # 模块配置配置文件位于 `/config/core/Captcha.php` 。 * **`fontFile`** `(String)` `'/lib/captcha_font.ttf'` ：指定字体文件的路径。 >w 框架没有附带字体文件，需要自行添加，字体格式仅限 `TTF` 。 # create() ## 说明 **Vcode :: create ( <kbd>传参数组</kbd> )** 创建验证码图片。在前端HTML页面能够直接以引用图片的方式使用（即 `<img>` 标签中的 `src` 属性）。此方法 `支持` 中文参数名。此方法 `支持` 参数简写。 ## 参数 * **`word（文字）`** `(String)` `必须` `可简写`：用以指定验证码中的文字。可以通过 `Tool :: random()` 生成验证码文字。 * **`base64（base64）`** `(Bool)` `False`：用以指定是否将生成的验证码图像以Base64格式字符串返回。当值为 `TRUE` 时，本方法会将生成的验证码图像以Base64格式字符串返回。当值为 `FALSE` 时，本方法将会直接以 `image/jpeg` 的方式展示图像。 * **`width（宽度）`** `(Int)` `120`：用以指定验证码图片的宽度（单位为像素）。 * **`height（高度）`** `(Int)` `50`：用以指定验证码图片的高度（单位为像素）。 * **`background（背景颜色）`** `(String)` `#ffffff`：用以指定验证码图片的背景颜色。值为颜色的Hex表达式，例如 `#fa3137` 。 * **`word_color（文字颜色）`** `(String)` `#000000`：用以指定验证码文字的颜色。值为颜色的Hex表达式，例如 `#fa3137` 。 >d 如果背景颜色与文字颜色一致，将会导致验证码无法看清。 * **`noise_color（噪点颜色）`** `(String)` `#ff6600`：用以指定噪点的颜色。值为颜色的Hex表达式，例如 `#fa3137` 。 * **`dot（点）`** `(Int)` `0`：用以指定杂点数量，建议使用默认值。 * **`line（线）`** `(Int)` `0`：用以指定干扰线数量，建议使用默认值。 ## 返回无或 `(String)` 类型。当参数 `base64` 值为 `TRUE` 时，本方法会将生成的验证码图像以Base64格式字符串返回。 >d 当参数 `base64` 值为 `FALSE` 时，使用本方法的文件中不能有其它输出。