milanpol/recaptcha-bundle

Recaptcha wrapper for Symfony

This package's canonical repository appears to be gone and the package has been frozen as a result.

V1.3 2021-06-30 08:04 UTC

Requires

• php: >=7.4
• google/recaptcha: ^1.2
• symfony/form: ^4.4
• symfony/framework-bundle: ^4.4
• symfony/validator: ^4.4
• twig/twig: ^2.0|^3.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.14
• phpmd/phpmd: ^2.8
• sebastian/phpcpd: ^5.0
• sensiolabs/security-checker: ^6.0
• squizlabs/php_codesniffer: ^3.3

proprietary

• Joshwin Zuidema

README

Usage

Extend any form to AbstractRecaptchaType. This requires you to define getExpectedAction(). Return the expected action (for example contact for a contact form).

Next, in the twig template in which your form is being used, include the following:

{% include '@EsitesRecaptcha/recaptcha/recaptcha.html.twig' %}

Finally, install the assets using php bin/console assets:install

Errors

When the recaptcha check fails, an error will be added to the form. To display it, use:

{{ form_errors(form) }}

The message is translatable by defining the following in validators.nl.yml

error:
    recaptcha_failed_to_validate: 'Recaptcha failed!'

Full Configuration

esites_recaptcha:
    enable_recaptcha: true   # default value
    recaptcha_key: google_recaptcha_key   # required, the key from the google recaptcha admin dashboard
    recaptcha_secret: google_recaptcha_secret   # required, the secret key from the google recaptcha admin dashboard
    recaptcha_score: 0.5   # default value, the minimum score a visitor has to score to not be flagged as a bot
    expected_hostname: e-sites.nl   # not required, the expected hostname in the google recaptcha response
    use_client_ip: true   # default value, also sends the clients ip to verify the recaptcha request

Manually renewing a recaptcha

Select the recaptcha element (the hidden input) you wish the renew and call setRecaptcha();

setRecaptcha(document.querySelector('#recaptchaObject'));