Download the PHP package clear01/recaptcha-control without Composer

reCAPTCHA for Nette Framework

Adds the reCAPTCHA control to Nette Framework forms.

• Official documentation
• Online demo
• Nette forum thread (CZE)

Documentation

1. Installation
2. Configuration
3. Usage
4. Requester
5. AJAX
6. Invisible reCAPTCHA
7. Testing

Installation

For easy installation use Composer:

Also don't forget to include the official JavaScript library:

Are you using AJAX? Then you may want to use library asset instead - see more.

Configuration

To be able to use the reCAPTCHA control in your forms just register the DI extension in your config.neon:

Parameters:

Usage

Form

To actually add reCAPTCHA to your form just call

Please note that the validation rule is added automatically so you don't need to call any addRule() at all.

Template

You can then render the control in your Latte template using both macro and n:attr approach:

And there she goes! :-)

Requester

Requester is a layer for sending HTTP requests. It comes handy when your production environment does not meet the default requirements (cURL extension etc.).

You can change the default requester by setting the requester key in configuration. The value can be either a class name or a name of another service (see details below).

1. CurlRequester

   This is the default one since requester value is optional in configuration.

   It uses PHP cURL extension. If you want to set any CURLOPT_* value for the requests you have to create the service aside and pass these options to the constructor:

   As you can see in the example it is possible to use all CURLOPT_* constants as string keys (they are converted internally).

2. SimpleRequester

   Calls file_get_contents() with stream context.

3. GuzzleRequester

   If you're already using the Guzzle HTTP Client in your application, this requester may come handy:

   If you're using multiple clients it is better to define the requester as a service aside:

4. Custom requester

   You can also implement your own requester. Just make sure it implements the ReCaptchaControl\Http\Requester\IRequester interface.

   It basically requires a single public function post(string $url, array $values = []): string method which takes URL, performs a HTTP POST request with given $values and returns body of the response as a string. In case of a failure, ReCaptchaControl\Http\Requester\RequestException should be thrown.

   You can then use it the same way as above:

   or when you have some dependencies:

AJAX

When a snippet containing reCAPTCHA control gets updated, the reCAPTCHA itself needs to be re-rendered.

If you're using the nette.ajax.js, you may want to use the assets/recaptcha.ajax.js script.

You can install it via bower:

IMPORTANT: The explicitely. So please be careful not to loaded by yourself as well.

Invisible reCAPTCHA

You can also use this library for Invisible reCAPTCHA. The backend part stays the same so it only needs proper configuration in the frontend. To see it in action you can visit https://kesspess.cz/recaptcha/invisible and the code in tests.

Tests & CI

Automated tests

This library uses Nette Tester for automated testing and PHPStan for static analysis. For running them yourself simply run

Manual testing

You may have noticed the https://kesspess.cz/recaptcha.

To get it to work on your local machine, do following:

1. copy config/local.neon.template to config/local.neon
2. fill reCAPTCHA keys properly in config/local.neon
3. run composer install
4. run bower install

After that you should be able to run it via your local web server.

The form definitions are in TestPresenter.

Individual example templates are located in presenters/templates directory.