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: about 1 month 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 (about 9 years ago)
• Default Branch: master
• Last Pushed: 2023-10-18T18:26:16.000Z (about 1 year ago)
• Last Synced: 2024-10-02T21:03:42.872Z (2 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

        
[![Build Status](https://img.shields.io/github/actions/workflow/status/ctlabvn/Recaptcha/ci.yml)](https://github.com/ctlabvn/Recaptcha/actions?query=workflow%3ACI+branch%3Amaster)

[![Latest Stable Version](https://poser.pugx.org/crabstudio/recaptcha/v/stable)](https://packagist.org/packages/crabstudio/recaptcha)

[![Total Downloads](https://poser.pugx.org/crabstudio/recaptcha/downloads)](https://packagist.org/packages/crabstudio/recaptcha)

[![License](https://poser.pugx.org/crabstudio/recaptcha/license)](https://packagist.org/packages/crabstudio/recaptcha)

# 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:

```

composer require crabstudio/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:

```

$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' => 'vi',      // default en

    'size' => 'normal'  // normal/compact

]);

```

Override default configure from app config file:

```

file: config/app.php

    /**

     * Recaptcha configuration.

     *

     */

    'Recaptcha' => [

        'enable' => true,

        'sitekey' => 'your_site_key',

        'secret' => 'your_secret',

        'type' => 'image',

        'theme' => 'light',

        'lang' => 'es',

        'size' => 'normal'

    ]

```

Override default configure from recaptcha config file:

```

file: config/recaptcha.php

 [

        'enable' => true,

        'sitekey' => 'your_site_key',

        'secret' => 'your_secret',

        'type' => 'image',

        'theme' => 'light',

        'lang' => 'es',

        'size' => 'normal'

    ]

];

```

Load recaptcha config file:

```

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 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'));

        }

    }

```

Done