mewebstudio/captcha
PHPCaptcha for Laravel 5+
composer require mewebstudio/captchaCaptcha for Laravel 10/11/12
A simple Laravel 5/6/7/8/9/10/11/12 service provider for including the Captcha for Laravel.
for Laravel 4 Captcha for Laravel Laravel 4
for Laravel 5 to 12 Captcha for Laravel Laravel 5 and Newer versions
Preview
- Captcha for Laravel 5/6/7/8/9/10/11/12
- Return Image
- Return URL
- Return HTML
- To use different configurations
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,
]
For Laravel 11+ you can add the provider to bootstrap\providers.php.
return [
// ...
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 --provider="Mews\Captcha\CaptchaServiceProvider"
config/captcha.php
return [
'default' => [
'length' => 5,
'width' => 120,
'height' => 36,
'quality' => 90,
'math' => true, //Enable Math Captcha
'expire' => 60, //Captcha expiration
],
// ...
];
Images
To use your own custom images for a background, set 'bgImage' to true and change the 'bgsDirectory' setting to your directory you want the image(s) to be used.
If you just want to change the background color, then set 'bgImage' to false and the 'bgColor' will be applied.
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
^_^