Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gremo/gremocaptchaformbundle
Symfony bundle that provides CAPTCHA form field and supports multiple adapters
https://github.com/gremo/gremocaptchaformbundle
Last synced: about 2 months ago
JSON representation
Symfony bundle that provides CAPTCHA form field and supports multiple adapters
- Host: GitHub
- URL: https://github.com/gremo/gremocaptchaformbundle
- Owner: gremo
- License: mit
- Created: 2016-02-29T09:02:34.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2021-11-26T12:20:58.000Z (about 3 years ago)
- Last Synced: 2024-10-20T18:10:16.644Z (2 months ago)
- Language: PHP
- Homepage:
- Size: 43.9 KB
- Stars: 2
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GremoCaptchaFormBundle
[](https://packagist.org/packages/gremo/captcha-form-bundle) [](https://packagist.org/packages/gremo/captcha-form-bundle)
Symfony bundle that provides CAPTCHA form field to solve challenge-response tests. Supports multiple adapters as well as
custom ones. Built-in adapter for:
- [Google reCAPTCHA](https://www.google.com/recaptcha)
- [Google reCAPTCHA v3](https://developers.google.com/recaptcha/docs/v3)
- [Gregwar/Captcha](https://github.com/Gregwar/Captcha)
- [Honeypot captcha technique](http://haacked.com/archive/2007/09/11/honeypot-captcha.aspx/)
New contributors are welcome!
## Installation
```bash
composer require gremo/captcha-form-bundle
```
Then enable the bundle:
```php
['all' => true],
];
```
If you are using a previous version of Symfony:
```php
= 2.8 and PHP >= 5.5 use the class name resolution via ::class
use Gremo\CaptchaFormBundle\Form\Type\CaptchaType;
$builder->add('captcha', CaptchaType::class, [
// Pass custom options to override defaults from configuration
]);
// For Symfony >= 2.8 and PHP < 5.5 use the fully-qualified class name as string
$builder->add('captcha', 'Gremo\CaptchaFormBundle\Form\Type\CaptchaType', [
// Pass custom options to override defaults from configuration
]);
// For Symfony < 2.8
$builder->add('captcha', 'gremo_captcha', [
// Pass custom options to override defaults from configuration
]);
```
## Adapters
At least one adapter must be configured.
### Google reCAPTCHA v2 adapter
**Adapter key**: `recaptcha` **Form Type**: `Gremo\CaptchaFormBundle\Form\Type\RecaptchaType`
Add the `google/recaptcha` library to your project:
```bash
composer require google/recaptcha^1
```
Configure the adapter ([options explanation](https://developers.google.com/recaptcha/docs/display#render_param)):
```yml
# ...
adapters:
# ...
recaptcha:
# Mandatory options
key: ~ # string
secret: ~ # string
# Not mandatory options
theme: ~ # string
type: ~ # string
size: ~ # string
tabindex: ~ # integer
callback: ~ # string
expired_callback: ~ # string
```
Finally, add the reCAPTCHA `` tag to your base template:
```html
<script src="https://www.google.com/recaptcha/api.js" async defer>
```
> **Tip**: add the `hl` parameter to the script in order to localize the CAPTCHA, i.e. in Twig `hl={{ app.request.locale }}`.
Example usage:
```php
// For Symfony >= 2.8 and PHP >= 5.5 use the class name resolution via ::class
use Gremo\CaptchaFormBundle\Form\Type\RecaptchaType;
$builder->add('captcha', RecaptchaType::class, [
// Pass custom options to override defaults from configuration
]);
// For Symfony >= 2.8 and PHP < 5.5 use the fully-qualified class name as string
$builder->add('captcha', 'Gremo\CaptchaFormBundle\Form\Type\RecaptchaType', [
// Pass custom options to override defaults from configuration
]);
// For Symfony < 2.8
$builder->add('captcha', 'gremo_captcha_recaptcha', [
// Pass custom options to override defaults from configuration
]);
```
### Google reCAPTCHA v3 adapter
**Adapter key**: `recaptcha_v3` **Form Type**: `Gremo\CaptchaFormBundle\Form\Type\RecaptchaV3Type`
Add the `google/recaptcha` library to your project:
```bash
composer require google/recaptcha^1
```
Configure the adapter ([options explanation](https://developers.google.com/recaptcha/docs/v3#interpreting_the_score)):
```yml
# ...
adapters:
# ...
recaptcha_v3:
# Mandatory options
key: ~ # string
secret: ~ # string
# Not mandatory options
score_threshold: ~ # float
```
There is no need to add any `` tag because the form theme will do it for you.
Example usage:
```php
// For Symfony >= 2.8 and PHP >= 5.5 use the class name resolution via ::class
use Gremo\CaptchaFormBundle\Form\Type\RecaptchaV3Type;
$builder->add('captcha', RecaptchaV3Type::class, [
// For options
]);
// For Symfony >= 2.8 and PHP < 5.5 use the fully-qualified class name as string
$builder->add('captcha', 'Gremo\CaptchaFormBundle\Form\Type\RecaptchaV3Type', [
// For options
]);
// For Symfony < 2.8
$builder->add('captcha', 'gremo_captcha_recaptcha_v3', [
// For options
]);
```
### Gregwar captcha adapter
**Adapter key**: `gregwar_captcha` **Form Type**: `Gremo\CaptchaFormBundle\Form\Type\GregwarCaptchaType`
Add the `gregwar/recaptcha` library to your project:
```bash
composer require gregwar/recaptcha^1
```
Configure the adapter ([options explanation](https://github.com/Gregwar/Captcha)):
```yml
# ...
adapters:
# ...
gregwar_captcha:
# Not mandatory options
storage_key: _gregwar_captcha
width: ~ # integer
height: ~ # integer
quality: ~ # integer
font: ~ # string
distorsion: ~ # boolean
interpolation: ~ # boolean
ignore_all_effects: ~ # boolean
orc: ~ # boolean
```
Example usage:
```php
// For Symfony >= 2.8 and PHP >= 5.5 use the class name resolution via ::class
use Gremo\CaptchaFormBundle\Form\Type\GregwarCaptchaType;
$builder->add('captcha', GregwarCaptchaType::class, [
// Pass custom options to override defaults from configuration
]);
// For Symfony >= 2.8 and PHP < 5.5 use the fully-qualified class name as string
$builder->add('captcha', 'Gremo\CaptchaFormBundle\Form\Type\GregwarCaptchaType', [
// Pass custom options to override defaults from configuration
]);
// For Symfony < 2.8
$builder->add('captcha', 'gremo_captcha_gregwar', [
// Pass custom options to override defaults from configuration
]);
```
### Honeypot adapter
**Adapter key**: `honeypot` **Form Type**: `Gremo\CaptchaFormBundle\Form\Type\HoneypotType`
Configure the adapter:
```yml
# ...
adapters:
# ...
honeypot:
# Mandatory options
type: ~ # string, "text" or "hidden" or their FQCN (Symfony >= 2.8)
```
Example usage:
```php
// For Symfony >= 2.8 and PHP >= 5.5 use the class name resolution via ::class
use Gremo\CaptchaFormBundle\Form\Type\HoneypotType;
$builder->add('captcha', HoneypotType::class, [
// Pass custom options to override defaults from configuration
]);
// For Symfony >= 2.8 and PHP < 5.5 use the fully-qualified class name as string
$builder->add('captcha', 'Gremo\CaptchaFormBundle\Form\Type\HoneypotType', [
// Pass custom options to override defaults from configuration
]);
// For Symfony < 2.8
$builder->add('captcha', 'gremo_captcha_honeypot', [
// Pass custom options to override defaults from configuration
]);
```