Project based on laravel-reCAPTCHA development.
composer require rubensrocha/h-captcha
In app/config/app.php
add the following :
1- The ServiceProvider to the providers array :
Rubensrocha\HCaptcha\HCaptchaServiceProvider::class,
2- The class alias to the aliases array :
'HCaptcha' => Rubensrocha\HCaptcha\Facades\HCaptcha::class,
3- Publish the config file
php artisan vendor:publish --provider="Rubensrocha\HCaptcha\HCaptchaServiceProvider"
Add HCAPTCHA_SECRET
and HCAPTCHA_SITEKEY
in .env file :
HCAPTCHA_SECRET=secret-key
HCAPTCHA_SITEKEY=site-key
(You can obtain them from here)
With default options :
{!! HCaptcha::renderJs() !!}
With language support or onloadCallback option :
{!! HCaptcha::renderJs('fr', true, 'recaptchaCallback') !!}
Default widget :
{!! HCaptcha::display() !!}
With custom attributes (theme, size, callback ...) :
{!! HCaptcha::display(['data-theme' => 'dark']) !!}
Invisible reCAPTCHA using a submit button:
{!! HCaptcha::displaySubmit('my-form-id', 'submit now!', ['data-theme' => 'dark']) !!}
Notice that the id of the form is required in this method to let the autogenerated callback submit the form on a successful captcha verification.
Add 'h-captcha-response' => 'required|captcha'
to rules array :
$validate = Validator::make(Input::all(), [
'h-captcha-response' => 'required|HCaptcha'
]);
Add the following values to the custom
array in the validation
language file :
'custom' => [
'h-captcha-response' => [
'required' => 'Please verify that you are not a robot.',
'captcha' => 'Captcha error! try again later or contact site admin.',
],
],
Then check for captcha errors in the Form
:
@if ($errors->has('h-captcha-response'))
<span class="help-block">
<strong>{{ $errors->first('h-captcha-response') }}</strong>
</span>
@endif
When using the Laravel Testing functionality, you will need to mock out the response for the captcha form element.
So for any form tests involving the captcha, you can do this by mocking the facade behavior:
// prevent validation error on captcha
HCaptcha::shouldReceive('verifyResponse')
->once()
->andReturn(true);
// provide hidden input for your 'required' validation
HCaptcha::shouldReceive('display')
->zeroOrMoreTimes()
->andReturn('<input type="hidden" name="h-captcha-response" value="1" />');
You can then test the remainder of your form as normal.
When using HTTP tests you can add the h-captcha-response
to the request body for the 'required' validation:
// prevent validation error on captcha
HCaptcha::shouldReceive('verifyResponse')
->once()
->andReturn(true);
// POST request, with request body including g-recaptcha-response
$response = $this->json('POST', '/register', [
'h-captcha-response' => '1',
'name' => 'John',
'email' => '[email protected]',
'password' => '123456',
'password_confirmation' => '123456',
]);
Checkout example below:
<?php
require_once "vendor/autoload.php";
$secret = 'CAPTCHA-SECRET';
$sitekey = 'CAPTCHA-SITEKEY';
$captcha = new \Rubensrocha\HCaptcha\HCaptcha($secret, $sitekey);
if (! empty($_POST)) {
var_dump($captcha->verifyResponse($_POST['h-captcha-response']));
exit();
}
?>
<form action="?" method="POST">
<?php echo $captcha->display(); ?>
<button type="submit">Submit</button>
</form>
<?php echo $captcha->renderJs(); ?>