newscoop/recaptcha-bundle

This bundle provides easy reCAPTCHA form field integration, this is a fork of https://github.com/excelwebzone/EWZRecaptchaBundle

EWZRecaptchaBundle

This bundle provides easy reCAPTCHA form field for Symfony., _(*1)

A bridge for the Silex framework has been implemented too : Jump to documentation., _(*2)

Installation

Step 1: Use composer and enable Bundle

To install EWZRecaptchaBundle with Composer just add the following to your composer.json file:, _(*3)

// composer.json
{
    // ...
    "require": {
        // ...
        "excelwebzone/recaptcha-bundle": "dev-master"
    }
}

NOTE: Please replace dev-master in the snippet above with the latest stable branch, for example 2.0.*., _(*4)

Then, you can install the new dependencies by running Composer's update command from the directory where your composer.json file is located:, _(*5)

$ php composer.phar update

Now, Composer will automatically download all required files, and install them for you. All that is left to do is to update your AppKernel.php file, and register the new bundle:, _(*6)

add('recaptcha', 'ewz_recaptcha');
    // ...
}
```

You can pass extra options to reCAPTCHA with the "attr > options" option:

``` php
add('recaptcha', 'ewz_recaptcha', array(
        'attr' => array(
            'options' => array(
                'theme' => 'clean'
            )
        )
    ));
    // ...
}
```

To validate the field use:

``` php
false``` then the annotation will not work. You have to also set ```constraints```:

``` php
add('recaptcha', 'ewz_recaptcha', array(
        'attr'          => array(
            'options' => array(
                'theme' => 'clean'
            )
        ),
        'mapped' => false,
        'constraints'   => array(
            new True()
        )
    ));
    // ...
```


The form template resource is now auto registered via an extension of the container.
However, you can always implement your own custom form widget.

**PHP**:

``` php
setTheme($form, array('EWZRecaptchaBundle:Form')) ?>

widget($form['recaptcha'], array(
    'attr' => array(
        'options' => array(
            'theme' => 'clean',
        ),
    ),
)) ?>

Twig:, _(*7)

``` jinja {% form_theme form 'EWZRecaptchaBundle:Form:ewz_recaptcha_widget.html.twig' %}, <sub>(*8)</sub>

{{ form_widget(form.recaptcha, { 'attr': { 'options' : { 'theme' : 'clean', }, } }) }}, <sub>(*9)</sub>

If you are not using a form, you can still implement the reCAPTCHA field
using JavaScript:

**PHP**:

``` php
<div id="recaptcha-container"></div>
<script type="text/javascript">
    $(document).ready(function() {
        $.getScript("<?php echo \EWZ\Bundle\RecaptchaBundle\Form\Type\RecaptchaType::RECAPTCHA_API_JS_SERVER ?>", function() {
            Recaptcha.create("<?php echo $form['recaptcha']->get('public_key') ?>", "recaptcha-container", {
                theme: "clean",
            });
        });
    };
</script>

Twig:, <sub>(*10)</sub>

``` jinja , <sub>(*11)</sub>

## Customization

If you want to use a custom theme, put your chunk of code before setting the theme:

``` jinja



   

   
Incorrect please try again

   Enter the words above:
   Enter the numbers you hear:

   

   
Get another CAPTCHA
   
Get an audio CAPTCHA
   
Get an image CAPTCHA

   
Help
 



{% form_theme form 'EWZRecaptchaBundle:Form:ewz_recaptcha_widget.html.twig' %}

{{ form_widget(form.recaptcha, { 'attr': {
    'options' : {
        'theme' : 'custom',
    },
} }) }}

Further reading: Customizing the Look and Feel of reCAPTCHA, <sub>(*12)</sub>