summergeorge/no-captcha

适用于Laravel的No CAPTCHA reCAPTCHA。

1.0.0 2018-08-24 17:34 UTC

This package is auto-updated.

Last update: 2024-09-15 18:46:09 UTC


README

StyleCI

recaptcha_anchor 2x

https://packagist.org.cn/packages/summergeorge/no-captcha

对于Laravel 4,请使用v1分支。

安装

composer require summergeorge/no-captcha

Laravel 5

设置

注意 此包支持Laravel 5.5的自动发现功能,因此如果您使用的是Laravel 5.5,请跳过以下 设置 指令。

app/config/app.php 中添加以下内容:

1- 将 ServiceProvider 添加到 providers 数组

Summergeorge\NoCaptcha\NoCaptchaServiceProvider::class,

2- 将类别名添加到 aliases 数组

'NoCaptcha' => Summergeorge\NoCaptcha\Facades\NoCaptcha::class,

3- 发布配置文件

php artisan vendor:publish --provider="Summergeorge\NoCaptcha\NoCaptchaServiceProvider"

配置

.env 文件中添加 NOCAPTCHA_SECRETNOCAPTCHA_SITEKEY

NOCAPTCHA_SECRET=secret-key
NOCAPTCHA_SITEKEY=site-key

(您可以从此处获取它们)

使用方法

初始化 js 源

使用默认选项

 {!! NoCaptcha::renderJs() !!}

使用 语言支持onloadCallback 选项

 {!! NoCaptcha::renderJs('fr', true, 'recaptchaCallback') !!}

显示 reCAPTCHA

默认小部件

{!! NoCaptcha::display() !!}

使用 自定义属性(主题、大小、回调等)

{!! NoCaptcha::display(['data-theme' => 'dark']) !!}

使用 提交按钮的不可见 reCAPTCHA

{!! NoCaptcha::displaySubmit('my-form-id', 'submit now!', ['data-theme' => 'dark']) !!}

请注意,在此方法中需要表单的 id,以便自动生成的回调在验证成功后提交表单。

验证

'g-recaptcha-response' => 'required|captcha' 添加到规则数组

$validate = Validator::make(Input::all(), [
	'g-recaptcha-response' => 'required|captcha'
]);
自定义验证消息

将以下值添加到 validation 语言文件中的 custom 数组

'custom' => [
    'g-recaptcha-response' => [
        'required' => 'Please verify that you are not a robot.',
        'captcha' => 'Captcha error! try again later or contact site admin.',
    ],
],

然后在 Form 中检查验证码错误

@if ($errors->has('g-recaptcha-response'))
    <span class="help-block">
        <strong>{{ $errors->first('g-recaptcha-response') }}</strong>
    </span>
@endif

测试

当使用 Laravel 测试功能时,您需要模拟 captcha 表单元素的响应。

因此,对于涉及 captcha 的任何表单测试,您可以通过模拟外观行为来完成此操作

// prevent validation error on captcha
NoCaptcha::shouldReceive('verifyResponse')
    ->once()
    ->andReturn(true);

// provide hidden input for your 'required' validation
NoCaptcha::shouldReceive('display')
    ->zeroOrMoreTimes()
    ->andReturn('<input type="hidden" name="g-recaptcha-response" value="1" />');

然后您可以根据正常方式测试表单的其余部分。

当使用 HTTP 测试时,您可以将 g-recaptcha-response 添加到请求体中以进行 'required' 验证

// prevent validation error on captcha
NoCaptcha::shouldReceive('verifyResponse')
    ->once()
    ->andReturn(true);

// POST request, with request body including g-recaptcha-response
$response = $this->json('POST', '/register', [
    'g-recaptcha-response' => '1',
    'name' => 'John',
    'email' => 'john@example.com',
    'password' => '123456',
    'password_confirmation' => '123456',
]);

不使用 Laravel

查看以下示例

<?php

require_once "vendor/autoload.php";

$secret  = 'CAPTCHA-SECRET';
$sitekey = 'CAPTCHA-SITEKEY';
$captcha = new \Summergeorge\NoCaptcha\NoCaptcha($secret, $sitekey);

if (! empty($_POST)) {
    var_dump($captcha->verifyResponse($_POST['g-recaptcha-response']));
    exit();
}

?>

<form action="?" method="POST">
    <?php echo $captcha->display(); ?>
    <button type="submit">Submit</button>
</form>

<?php echo $captcha->renderJs(); ?>

贡献

https://github.com/summergeorge/no-captcha/pulls