mirko-pagliai/cakephp-recaptcha-mailhide

A CakePHP plugin that allows you to hide email addresses using reCAPTCHA

reCAPTCHA Mailhide

, _(*1)

reCAPTCHA Mailhide is a CakePHP plugin that allows you to hide email addresses using reCAPTCHA. It works by using the crabstudio/Recaptcha plugin, which must first be loaded and configured correctly., _(*2)

Did you like this plugin? Its development requires a lot of time for me. Please consider the possibility of making a donation: even a coffee is enough! Thank you., _(*3)

, _(*4)

Installation

You can install the plugin via composer:, _(*5)

$ composer require --prefer-dist mirko-pagliai/cakephp-recaptcha-mailhide

Then you have to load the plugin. For more information on how to load the plugin, please refer to the Cookbook., _(*6)

Simply, you can execute the shell command to enable the plugin:, _(*7)

bin/cake plugin load RecaptchaMailhide

This would update your application's bootstrap method., _(*8)

Then you also need to set up a key to encrypt/decrypt email addresses:, _(*9)

Configure::write('RecaptchaMailhide.encryptKey', 'thisIsAKeyForEncrypt12345678901234567890');

Installation on older CakePHP and PHP versions

Recent packages and the master branch require at least CakePHP 4.0 and PHP 7.2. Instead, the cakephp3 branch requires at least PHP 5.6., _(*10)

In this case, you can install the package as well:, _(*11)

$ composer require --prefer-dist mirko-pagliai/cakephp-recaptcha-mailhide:dev-cakephp3

Note that the cakephp3 branch will no longer be updated as of May 7, 2021, except for security patches, and it matches the 1.4.7 version., _(*12)

Configuration

First, you have to load the Recaptcha component provided by the crabstudio/Recaptcha plugin, as described here. The component must be loaded inside the initialize() method of your AppController class., _(*13)

For more information on how to load the component, please refer to the Cookbook., _(*14)

Then, you have to load the Mailhide helper:, _(*15)

$this->loadHelper('RecaptchaMailhide.Mailhide');

For more information on how to load the helper, please refer to the Cookbook., _(*16)

Usage

You can now use the link() method provided by the Mailhide helper in your template files. Example:, _(*17)

echo $this->Mailhide->link('My mail', 'myname@mymail.com');

This will create a link. By clicking on the link, a popup will open and it will contain the reCAPTCHA control. If the check was filled in correctly, the clear email will be shown., _(*18)

You can also use the email address as the title of the link. Example:, _(*19)

echo $this->Mailhide->link('myname@mymail.com', 'myname@mymail.com');

In this case, the email will be obfuscated (myn***@mymail.com) to be shown as the title of the link., _(*20)

The third parameter of the method can be used for link options. Example:, _(*21)

echo $this->Mailhide->link('My mail', 'myname@mymail.com', ['class' => 'my-custom-class']);

Versioning

For transparency and insight into our release cycle and to maintain backward compatibility, reCAPTCHA Mailhide will be maintained under the Semantic Versioning guidelines., _(*22)