agilelab-fr/captcha-bundle

This bundle provides an easy way to integrate CAPTCHA validation into Symfony forms using the AlCaptchaType form field. It enhances security by preventing automated submissions while ensuring seamless user experience.

v1.2.0 2025-03-02 10:59 UTC

Requires

• php: >=7.4
• symfony/config: ^5.4 || ^6.4 || ^7.0
• symfony/dependency-injection: ^5.4 || ^6.4 || ^7.0
• symfony/form: ^5.4 || ^6.4 || ^7.0
• symfony/http-kernel: ^5.4 || ^6.4 || ^7.0
• symfony/validator: ^5.4 || ^6.4 || ^7.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.69
• phpstan/phpstan: ^2.1
• phpunit/phpunit: ^10.0
• symfony/framework-bundle: ^5.4 || ^6.4 || ^7.0

MIT

• Agilelab

README

This bundle provides an easy way to integrate CAPTCHA validation into Symfony forms using the AgilelabFrCaptchaType form field. It enhances security by preventing automated submissions while ensuring a seamless user experience.

Installation

For Symfony Flex Projects

composer require agilelab-fr/captcha-bundle

After installation, you need to uncomment the following line in config/packages/agilelab_fr_captcha.yaml

twig:
   form_themes:
      - '@AgilelabFrCaptcha/form/agilelab_fr_captcha.html.twig'

For Non-Flex Projects

1. Install via Composer:

   composer require agilelab-fr/captcha-bundle
   

2. Manually enable the bundle in config/bundles.php:

   return [
       AgilelabFr\CaptchaBundle\AgilelabFrCaptchaBundle::class => ['all' => true],
   ];

3. Add the configuration manually (see below).

Usage

To add a CAPTCHA field to your form:

use AgilelabFr\CaptchaBundle\Form\AgilelabFrCaptchaType;

$builder->add('captcha', AgilelabFrCaptchaType::class);

Configuration

If you are not using Symfony Flex, manually add these configurations:

1. Configuration File (config/packages/agilelab_fr_captcha.yaml)

captcha_bundle:
    width: 120
    height: 40
    length: 6
    lines: 8
    characters: 'ABCDEFGHJKLMNPQRSTUVWXYZ23456789'
    case_sensitive: true

# Uncomment to render the twig block for captcha
twig:
    form_themes:
        - '@AgilelabFrCaptcha/form/agilelab_fr_captcha.html.twig'

2. Custom Config for each Form

It is also possible to define the Captcha configuration directly in the FormType, in addition to the config/packages/agilelab_fr_captcha.yaml file.

Example usage in a form builder:

->add('captcha', AgilelabFrCaptchaType::class, [
    'label' => 'Captcha',
    'attr' => [
        'width' => 120,
        'height' => 40,
        'lines' => 6,
        'length' => 5,
        'characters' => 'ABCDEFGHJKLMNPQRSTUVWXYZ23456789',
        'case_sensitive' => false,
    ],
])

3. Routing (config/routes/agilelab_fr_captcha.yaml)

agilelab_fr_captcha_bundle.routes:
    resource: '@AgilelabFrCaptchaBundle/config/routes.yaml'

License

This bundle is licensed under the MIT License.