szmnmichalowski/zf2-nocaptcha

No CAPTCHA reCAPTCHA module for Zend Framework 2

1.0.0 2017-03-25 22:33 UTC

Requires

• php: ^5.6 || ^7.0
• zendframework/zend-captcha: 2.7.1

Requires (Dev)

• zendframework/zend-config: 2.6.0
• zendframework/zend-test: ^2.5

MIT

• Szymon Michałowski

• zend
• zf2
• module
• recaptcha
• captcha

README

NoCaptcha is a Zend Framework 2 module which is integrated with new version of Google reCAPTCHA.
More info about "No CAPTCHA reCAPTCHA"

Installation

You can install this module by cloning this project into your ./vendor/ directory, or using composer, which is more recommended:
1. Add this project into your composer.json

"require": {
    "szmnmichalowski/zf2-nocaptcha": "dev-master"
}

2. Update your dependencies

$ php composer.phar update

3. Add module to your application.config.php

return array(
    'modules' => array(
        'Application',
        'NoCaptcha' // <- Add this line
    )
);

Usage

1. Add to layout.phtml in head section:

<script src="https://www.google.com/recaptcha/api.js" async defer></script>

2. Register your site at https://www.google.com/recaptcha/admin#createsite.
After you register your site you will get:

• Site key
• Secret key

Without this two keys, module won't work correctly

3. Pass these keys to \NoCaptcha\Captcha\ReCaptcha class

Example #1: Basic

        $options = array(
            'site_key' => 'YOUR_SITE_KEY',
            'secret_key' => 'YOUR_SECRET_KEY',
        );
        
        $captcha = new \NoCaptcha\Captcha\ReCaptcha($options);

In your form class:

        ...
        $this->add(array(
            'type'  => 'Zend\Form\Element\Captcha',
            'name' => 'captcha',
            'attributes' => array(
                'id' => 'recaptcha-response',
            ),
            'options' => array(
                'label' => 'Are you a bot?',
                'captcha' => $captcha // <-- Object of NoCaptcha\Captcha\ReCaptcha
            )
        ));
        ...

Last step is to render captcha input in your view:

        <div class="form-group">
            <?php echo $this->formlabel($form->get('captcha')); ?>
            <div>
                <?php echo $this->formCaptcha($form->get('captcha')); ?>
                <div class="error-message">
                    <?php echo $this->formElementErrors($form->get('captcha')); ?>
                </div>
            </div>
        </div>

Example #2: Advanced

        $options = array(
            'site_key' => 'YOUR_SITE_KEY',
            'secret_key' => 'YOUR_SECRET_KEY',
            'theme' => 'dark',
            'type' => 'image',
            'size' => 'normal',
            'messages' => array(
                'errCaptcha' => 'Custom message when google API return false'
            ),
            'service_options' => array(
                'adapter' => 'Zend\Http\Client\Adapter\Curl', // override default HttpClient adapter options
            )
        );

        $captcha = new \NoCaptcha\Captcha\Recaptcha($options);

Or you can use setters

        $captcha->setSiteKey($siteKey);
        $captcha->setSecretKey($secretKey);
        $captcha->setTheme('dark');
        $captcha->setType('image');
        $captcha->setSize('normal');

NoCaptcha uses Zend\Http\Client to verify if captcha is valid. If for some reasons you want to pass additional settings to Client class, you can do this by:

$service = $captcha->getService();
$service->setOptions(array(
  'sslverifypeer' => false
));

reCAPTCHA options

Theme:

• light (default)
• dark

Type:

• image (default)
• audio

Size:

• normal (default)
• compact

More information about options you can find at https://developers.google.com/recaptcha/docs/display