README

安装

使用 composer

{
    ...
    "require": {
        "gregwar/captcha": "1.*"
    }
}

用法

您可以使用 CaptchaBuilder 创建验证码

<?php

use Gregwar\Captcha\CaptchaBuilder;

$builder = new CaptchaBuilder;
$builder->build();

然后将其保存到文件中

<?php

$builder->save('out.jpg');

或直接输出

<?php

header('Content-type: image/jpeg');
$builder->output();

或直接在HTML页面中内联

<img src="<?php echo $builder->inline(); ?>" />

您将能够获取代码并与用户输入进行比较

<?php

// Example: storing the phrase in the session to test for the user 
// input later
$_SESSION['phrase'] = $builder->getPhrase();

您可以比较短语与用户输入

if($builder->testPhrase($userInput)) {
    // instructions if user phrase is good
}
else {
    // user phrase is wrong
}

API

您可以使用以下函数

• __construct($phrase = null)，使用给定的短语构建构建器，如果短语为null，则将生成一个随机短语
• getPhrase()，允许您获取短语内容
• setDistortion($distortion)，启用或禁用扭曲，在 build() 之前调用
• isOCRReadable()，如果可以使用 ocrad 软件读取OCR，则返回 true，您需要启用 shell_exec，安装 imagemagick 和 ocrad
• buildAgainstOCR($width = 150, $height = 40, $font = null)，构建代码直到无法使用 ocrad 读取
• build($width = 150, $height = 40, $font = null)，使用给定的 $width、$height 和 $font 构建代码。默认情况下，将使用库中的随机字体
• save($filename, $quality = 80)，将验证码保存为jpeg文件到 $filename，给定质量
• get($quality = 80)，返回jpeg数据
• output($quality = 80)，直接将jpeg代码输出到浏览器
• setBackgroundColor($r, $g, $b)，设置背景颜色以强制设置（这将禁用许多效果，不建议使用）
• setBackgroundImages(array($imagepath1, $imagePath2))，设置用于验证码背景的自定义背景图像。建议在传递自定义背景图像时禁用图像效果（ignore_all_effects）。将从传递的列表中随机选择一个图像，必须传递图像文件的完整路径。
• setInterpolation($interpolate)，启用或禁用插值（默认启用），禁用它将更快，但图像将看起来更糟糕
• setIgnoreAllEffects($ignoreAllEffects)，禁用验证码图像上的所有效果。在传递自定义背景图像作为验证码时建议使用。
• testPhrase($phrase)，如果给定的短语良好，则返回 true
• setMaxBehindLines($lines)，设置代码后面的最大行数
• setMaxFrontLines($lines)，设置代码前面的最大行数

如果您想更改字符数，可以直接使用额外的参数调用短语构建器

use Gregwar\Captcha\CaptchaBuilder;
use Gregwar\Captcha\PhraseBuilder;

// Will build phrases of 3 characters
$phraseBuilder = new PhraseBuilder(4)

// Will build phrases of 5 characters, only digits
$phraseBuilder = new PhraseBuilder(5, '0123456789');

// Pass it as first argument of CaptchaBuilder, passing it the phrase
// builder
$captcha = new CaptchaBuilder(null, $phraseBuilder);

您也可以直接将想要的短语传递给构建器

// Building a Captcha with the "hello" phrase
$captcha = new CaptchaBuilder('hello');

完整示例

如果您想查看示例，可以查看 demo/form.php，它使用 demo/session.php 来渲染验证码并在提交后进行检查

Symfony Bundle

您可以查看以下存储库以享受使用此验证码生成器的Symfony 2捆绑包：https://github.com/Gregwar/CaptchaBundle

Yii2 扩展

您可以使用以下扩展与Yii2框架集成：https://github.com/juliardi/yii2-captcha

许可证

本库采用MIT许可证，请查看LICENSE文件