giginc / cakephp3-recaptcha
Recaptcha for CakePHP 3
Installs: 3 121
Dependents: 0
Suggesters: 0
Security: 0
Stars: 1
Watchers: 3
Forks: 0
Open Issues: 0
Type:cakephp-plugin
Requires
- php: >=5.6
- composer-plugin-api: ^1.0 || ^2.0
- cakephp/cakephp: ~3.0
Requires (Dev)
- cakephp/cakephp-codesniffer: ^4.0
- phpunit/phpunit: ^6.0
- squizlabs/php_codesniffer: ^3.5
This package is auto-updated.
Last update: 2024-05-14 12:49:06 UTC
README
Installation
You can install this plugin into your CakePHP application using composer.
The recommended way to install composer packages is:
composer require giginc/cakephp3-recaptcha
followed by the command:
composer update
Load plugin
From command line:
bin/cake plugin load Recaptcha
Load Component and Configure
Override default configure from loadComponent:
Recaptcha version2
$this->loadComponent('Recaptcha.Recaptcha', [
'enable' => true, // true/false
'version' => 2,
'sitekey' => 'your_site_key', //if you don't have, get one: https://www.google.com/recaptcha/intro/index.html
'secret' => 'your_secret',
'type' => 'image', // image/audio
'theme' => 'light', // light/dark
'lang' => 'vi', // default en
'size' => 'normal' // normal/compact
]);
Recaptcha version3
$this->loadComponent('Recaptcha.Recaptcha', [
'enable' => true, // true/false
'version' => 3,
'sitekey' => 'your_site_key', //if you don't have, get one: https://www.google.com/recaptcha/intro/index.html
'secret' => 'your_secret',
'scoreThreshold' => 0.5, // score threshold (default 0.5)
]);
Override default configure from app config file:
file: config/app.php
Recaptcha version2
/**
* Recaptcha configuration.
*
*/
'Recaptcha' => [
'enable' => true,
'version' => 2,
'sitekey' => 'your_site_key',
'secret' => 'your_secret',
'type' => 'image',
'theme' => 'light',
'lang' => 'es',
'size' => 'normal'
]
Recaptcha version3
/**
* Recaptcha configuration.
*
*/
'Recaptcha' => [
'enable' => true,
'version' => 3,
'sitekey' => 'your_site_key',
'secret' => 'your_secret',
]
Override default configure from recaptcha config file:
file: config/recaptcha.php
<?php
return [
/**
* Recaptcha configuration.
*
*/
'Recaptcha' => [
'enable' => true,
'version' => 3,
'sitekey' => 'your_site_key',
'secret' => 'your_secret',
]
];
Load recaptcha config file:
file: config/bootstrap.php
Configure::load('recaptcha', 'default', true);
Config preference:
- loadComponent config options
- recaptcha config file
- app config file
Usage
Display recaptcha in your view:
<?= $this->Form->create() ?>
<?= $this->Form->control('email') ?>
<?= $this->Recaptcha->display() ?> // Display recaptcha box in your view, if configure has enable = false, nothing will be displayed
<?= $this->Form->button() ?>
<?= $this->Form->end() ?>
Verify in your controller function
public function forgotPassword()
{
if ($this->request->is('post')) {
if ($this->Recaptcha->verify()) { // if configure enable = false, it will always return true
//do something here
}
$this->Flash->error(__('Please pass Google Recaptcha first'));
}
}