Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thinhbuzz/laravel-google-captcha
Google captcha for Laravel 5, Laravel 6, Laravel 7, Laravel 8, Laravel 9 and Laravel 10, support multiple captcha on page
https://github.com/thinhbuzz/laravel-google-captcha
google-captcha laravel laravel-captcha
Last synced: about 12 hours ago
JSON representation
Google captcha for Laravel 5, Laravel 6, Laravel 7, Laravel 8, Laravel 9 and Laravel 10, support multiple captcha on page
- Host: GitHub
- URL: https://github.com/thinhbuzz/laravel-google-captcha
- Owner: thinhbuzz
- License: mit
- Created: 2015-08-04T19:33:39.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-02-29T14:43:49.000Z (10 months ago)
- Last Synced: 2024-12-15T16:04:00.067Z (8 days ago)
- Topics: google-captcha, laravel, laravel-captcha
- Language: PHP
- Homepage:
- Size: 60.5 KB
- Stars: 204
- Watchers: 8
- Forks: 32
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Google captcha for Laravel
> Support multiple captcha on page
> Inspired by [anhskohbo/no-captcha](https://github.com/anhskohbo/no-captcha) and base on [google captcha sdk](https://github.com/google/recaptcha).
## Features
- [x] Support Laravel 5/6/7/8/9/10/11
- [x] Multiple captcha on page
- [x] Reset captcha
- [x] Auto discover service provider
- [x] Custom request method
- [x] Using difference key
- [x] Dynamic options on runtime
## Installation
Add the following line to the `require` section of `composer.json`:
```json
{
"require": {
"buzz/laravel-google-captcha": "2.*"
}
}
```
OR
Require this package with composer:
```
composer require buzz/laravel-google-captcha
```
Update your packages with ```composer update``` or install with ```composer install```.
## Setup
> Has support auto discover for Laravel >=5.5
Add ServiceProvider to the `providers` array in `config/app.php`.
```
'Buzz\LaravelGoogleCaptcha\CaptchaServiceProvider',
```
## Publish Config
```
php artisan vendor:publish --provider="Buzz\LaravelGoogleCaptcha\CaptchaServiceProvider"
```
### Custom ReCaptcha request (minimum version 2.1.7)
Edit ``request_method`` in the ``config/captcha.php`` config
file ``config/captcha.php``
```php
env('CAPTCHA_SECRET', 'default_secret'),
'sitekey' => env('CAPTCHA_SITEKEY', 'default_sitekey'),
/**
* @var string|null Default ``null``.
* Custom with function name (example customRequestCaptcha) or class@method (example \App\CustomRequestCaptcha@custom).
* Function must be return instance, read more in repo ``https://github.com/thinhbuzz/laravel-google-captcha-examples``
*/
'request_method' => null,
'options' => [
'multiple' => false,
'lang' => app()->getLocale(),
],
'attributes' => [
'theme' => 'light'
],
];
```
file ``app/helpers.php``
```php
Get examples in [examples repo](https://github.com/thinhbuzz/laravel-google-captcha-examples)
### Display reCAPTCHA
```php
{!! app('captcha')->display($attributes) !!}
```
OR use Facade: add `'Captcha' => '\Buzz\LaravelGoogleCaptcha\CaptchaFacade',` to the `aliases` array in `config/app.php` and in template use:
```php
{!! Captcha::display($attributes) !!}
```
OR use Form
```php
{!! Form::captcha($attributes) !!}
```
With custom language support:
```php
{!! app('captcha')->display($attributes = [], $options = ['lang'=> 'vi']) !!}
```
With
```php
// element attributes
$attributes = [
'data-theme' => 'dark',
'data-type' => 'audio',
];
```
```php
// package options
$options = [
'data-theme' => 'dark',
'data-type' => 'audio',
];
```
More information on [google recaptcha document](https://developers.google.com/recaptcha/docs/display)
> Please help me write readme for this content
### Validation
Add `'g-recaptcha-response' => 'required|captcha'` to rules array.
```php
use Validator;
use Illuminate\Support\Facades\Input;
$validate = Validator::make(Input::all(), [
'g-recaptcha-response' => 'required|captcha'
]);
```
### Testing
When using the Laravel Testing functionality, you will need to mock out the response for the captcha form element.
For any form tests involving the captcha, you can then mock the facade behaviour:
```php
// Prevent validation error on captcha
CaptchaFacade::shouldReceive('verify')
->andReturn(true);
// Provide hidden input for your 'required' validation
CaptchaFacade::shouldReceive('display')
->andReturn('');
// Add these when testing multiple captchas on a single page
CaptchaFacade::shouldReceive('displayJs');
CaptchaFacade::shouldReceive('displayMultiple');
CaptchaFacade::shouldReceive('multiple');
```
## Contribute
https://github.com/thinhbuzz/laravel-google-captcha/pulls