mews / captcha
Laravel 5/6/7/8/9/10/11 Captcha Package
Installs: 3 935 312
Dependents: 103
Suggesters: 2
Security: 0
Stars: 2 472
Watchers: 59
Forks: 454
Open Issues: 130
Type:package
Requires
- php: ^7.2|^8.1|^8.2|^8.3
- ext-gd: *
- illuminate/config: ~5|^6|^7|^8|^9|^10|^11
- illuminate/filesystem: ~5|^6|^7|^8|^9|^10|^11
- illuminate/hashing: ~5|^6|^7|^8|^9|^10|^11
- illuminate/session: ~5|^6|^7|^8|^9|^10|^11
- illuminate/support: ~5|^6|^7|^8|^9|^10|^11
- intervention/image: ^3.7
Requires (Dev)
- mockery/mockery: ^1.0
- phpunit/phpunit: ^8.5|^9.5.10|^10.5
- dev-master
- 3.4.4
- 3.4.3
- 3.4.2
- 3.4.1
- 3.4.0
- 3.3.3
- 3.3.2
- 3.3.1
- 3.3.0
- 3.2.10
- v3.2.9
- 3.2.8
- 3.2.7
- 3.2.6
- 3.2.5
- 3.2.4
- 3.2.3
- 3.2.2
- 3.2.1
- 3.2.0
- 3.1.1
- 3.1.0
- 3.0.2
- 3.0.1
- 3.0.0
- 2.3.0
- 2.2.9
- 2.2.8
- 2.2.7
- 2.2.6
- 2.2.5
- 2.2.4
- 2.2.3
- 2.2.2
- 2.2.1
- 2.2.0
- 2.1.8
- 2.1.7
- v2.1.6
- v2.1.5
- v2.1.4
- v2.1.3
- v2.1.2
- v2.1.1
- 2.1.0
- 2.0.3
- 2.0.2
- 2.0.1
- 2.0.0
- 1.0.2
- 1.0.1
- dev-master-l5-l9
- dev-dev
- dev-revert-146-master
- dev-master-l4
This package is auto-updated.
Last update: 2024-12-05 18:03:54 UTC
README
A simple Laravel 5/6 service provider for including the Captcha for Laravel.
for Laravel 4 Captcha for Laravel Laravel 4
for Laravel 5 to 9 Captcha for Laravel Laravel 4
Preview
Installation
The Captcha Service Provider can be installed via Composer by requiring the
mews/captcha
package and setting the minimum-stability
to dev
(required for Laravel 5) in your
project's composer.json
.
{ "require": { "laravel/framework": "5.0.*", "mews/captcha": "~3.0" }, "minimum-stability": "stable" }
or
Require this package with composer:
composer require mews/captcha
Update your packages with composer update
or install with composer install
.
In Windows, you'll need to include the GD2 DLL php_gd2.dll
in php.ini. And you also need include php_fileinfo.dll
and php_mbstring.dll
to fit the requirements of mews/captcha
's dependencies.
Usage
To use the Captcha Service Provider, you must register the provider when bootstrapping your Laravel application. There are essentially two ways to do this.
Find the providers
key in config/app.php
and register the Captcha Service Provider.
'providers' => [ // ... 'Mews\Captcha\CaptchaServiceProvider', ]
for Laravel 5.1+
'providers' => [ // ... Mews\Captcha\CaptchaServiceProvider::class, ]
Find the aliases
key in config/app.php
.
'aliases' => [ // ... 'Captcha' => 'Mews\Captcha\Facades\Captcha', ]
for Laravel 5.1+
'aliases' => [ // ... 'Captcha' => Mews\Captcha\Facades\Captcha::class, ]
For Laravel 11 : you do not need to add the alias, it will be added automatically.
Configuration
Custom settings:
To use your own settings, publish config.
$ php artisan vendor:publish
config/captcha.php
return [ 'default' => [ 'length' => 5, 'width' => 120, 'height' => 36, 'quality' => 90, 'math' => true, //Enable Math Captcha 'expire' => 60, //Captcha expiration ], // ... ];
Disable validation:
To disable the captcha validation use CAPTCHA_DISABLE
environment variable. e.g. .env config:
CAPTCHA_DISABLE=true
Example Usage
Session Mode:
// [your site path]/Http/routes.php Route::any('captcha-test', function() { if (request()->getMethod() == 'POST') { $rules = ['captcha' => 'required|captcha']; $validator = validator()->make(request()->all(), $rules); if ($validator->fails()) { echo '<p style="color: #ff0000;">Incorrect!</p>'; } else { echo '<p style="color: #00ff30;">Matched :)</p>'; } } $form = '<form method="post" action="captcha-test">'; $form .= '<input type="hidden" name="_token" value="' . csrf_token() . '">'; $form .= '<p>' . captcha_img() . '</p>'; $form .= '<p><input type="text" name="captcha"></p>'; $form .= '<p><button type="submit" name="check">Check</button></p>'; $form .= '</form>'; return $form; });
Detailed Example in Laravel way view files
//register.blade.php <img src="{{ captcha_src() }}" alt="captcha"> <div class="mt-2"></div> <input type="text" name="captcha" class="form-control @error('captcha') is-invalid @enderror" placeholder="Please Insert Captch" > @error('captcha') <div class="invalid-feedback">{{ $message }}</div> @enderror
controller files
Validator::make($input, [ 'name' => ['required', 'string', 'max:255'], 'email' => [ 'required', 'string', 'email', 'max:255', Rule::unique(User::class), ], 'password' => $this->passwordRules(), 'captcha' => 'required|captcha' ])->validate();
Stateless Mode:
You get key and img from this url
http://localhost/captcha/api/math
and verify the captcha using this method:
//key is the one that you got from json response // fix validator // $rules = ['captcha' => 'required|captcha_api:'. request('key')]; $rules = ['captcha' => 'required|captcha_api:'. request('key') . ',math']; $validator = validator()->make(request()->all(), $rules); if ($validator->fails()) { return response()->json([ 'message' => 'invalid captcha', ]); } else { //do the job }
Return Image
captcha();
or
Captcha::create();
Return URL
captcha_src();
or
Captcha::src('default');
Return HTML
captcha_img();
or
Captcha::img();
To use different configurations
captcha_img('flat'); Captcha::img('inverse');
etc.
Based on Intervention Image
^_^