https://github.com/ctlabvn/Recaptcha
CakePHP: Easy to integrate Google Recaptcha v2 to your project.
https://github.com/ctlabvn/Recaptcha
cakephp composer recaptcha
Last synced: 3 months ago
JSON representation
CakePHP: Easy to integrate Google Recaptcha v2 to your project.
- Host: GitHub
- URL: https://github.com/ctlabvn/Recaptcha
- Owner: ctlabvn
- License: mit
- Created: 2015-12-07T16:37:26.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-10-18T18:26:16.000Z (over 1 year ago)
- Last Synced: 2024-10-02T21:03:42.872Z (10 months ago)
- Topics: cakephp, composer, recaptcha
- Language: PHP
- Homepage:
- Size: 96.7 KB
- Stars: 21
- Watchers: 4
- Forks: 18
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-cakephp - Recaptcha plugin - Simple, lightweight Google Recaptcha v2. (Security)
README
[](https://github.com/ctlabvn/Recaptcha/actions/workflows/ci.yml?query=branch%3Amaster)
[](https://packagist.org/packages/crabstudio/recaptcha)
[](https://packagist.org/packages/crabstudio/recaptcha)
[](https://github.com/ctlabvn/Recaptcha/blob/master/LICENSE)
# Integrate Google Recaptcha v2 to your CakePHP project
## Installation
You can install this plugin into your CakePHP application using [composer](http://getcomposer.org).
The recommended way to install composer packages is:
```bash
composer require crabstudio/recaptcha
```
## Load plugin
From command line:
```bash
bin/cake plugin load Recaptcha
```
## Load Component and Configure
Override default configure from loadComponent:
```php
$this->loadComponent('Recaptcha.Recaptcha', [
'enable' => true, // true/false
'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' => 'en', // default 'en'
'size' => 'normal' // normal/compact
'callback' => null, // `callback` data attribute for the recaptcha div, default `null`
'scriptBlock' => true // Value for `block` option for HtmlHelper::script() call
]);
```
Override default config from app config file:
```php
// file: config/app.php
/**
* Recaptcha configuration.
*/
'Recaptcha' => [
'sitekey' => 'your_site_key',
'secret' => 'your_secret',
'type' => 'image',
'theme' => 'light',
'lang' => 'es',
'size' => 'normal'
]
```
Override default configure from recaptcha config file:
```php
// file: config/recaptcha.php
return [
/**
* Recaptcha configuration.
*
*/
'Recaptcha' => [
'enable' => true,
'sitekey' => 'your_site_key',
'secret' => 'your_secret',
'type' => 'image',
'theme' => 'light',
'lang' => 'es',
'size' => 'normal'
]
];
```
Load recaptcha config file:
```php
// file: config/bootstrap.php
Configure::load('recaptcha', 'default', true);
```
Config preference:
1. loadComponent config options
2. recaptcha config file
3. app config file
## Usage
Display recaptcha in your template:
```php
= $this->Form->create() ?>
= $this->Form->control('email') ?>
// Display recaptcha box in your template, if configure has enable = false, nothing will be displayed
= $this->Recaptcha->display() ?>
= $this->Form->button() ?>
= $this->Form->end() ?>
```
Verify in your controller function
```php
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'));
}
}
```
Done.