Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/saeven/zf2-circlical-recaptcha
ZF3/ZF2 Implementation of Google's newest RECAPTCHA. Plug and play.
https://github.com/saeven/zf2-circlical-recaptcha
Last synced: 25 days ago
JSON representation
ZF3/ZF2 Implementation of Google's newest RECAPTCHA. Plug and play.
- Host: GitHub
- URL: https://github.com/saeven/zf2-circlical-recaptcha
- Owner: Saeven
- License: other
- Created: 2015-02-12T21:13:38.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-08-21T20:13:04.000Z (about 1 year ago)
- Last Synced: 2024-04-24T04:32:38.758Z (7 months ago)
- Language: PHP
- Homepage:
- Size: 49.8 KB
- Stars: 4
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Easy Google Captcha for Zend Framework 3
[](https://packagist.org/packages/saeven/zf2-circlical-recaptcha)
[](https://www.codacy.com/app/saeven/zf2-circlical-recaptcha?utm_source=github.com&utm_medium=referral&utm_content=Saeven/zf2-circlical-recaptcha&utm_campaign=Badge_Grade)
[](https://www.codacy.com/app/saeven/zf2-circlical-recaptcha?utm_source=github.com&utm_medium=referral&utm_content=Saeven/zf2-circlical-recaptcha&utm_campaign=Badge_Coverage)
[](https://travis-ci.org/Saeven/zf2-circlical-recaptcha)
Google just rolled out their great new CAPTCHA (fewer angry old people is always great!), and you want to get it into your ZF2/ZF3 project! Please users and management alike with this easy module.
## Requirements
Add this line to your composer.json
```js
"saeven/zf2-circlical-recaptcha": "dev-master"
```
Then include ```'CirclicalRecaptcha',``` in your application's **module.config.php**. The module should now be loaded.
## Configuration
Copy **circlical.recaptcha.local.php** into your config/autoload folder. Open it up, and insert your ReCaptcha keys - you get these from [Google's website](https://www.google.com/recaptcha/admin#list).
```php
[
'recaptcha' => [
'client' => 'yourclientkeygoeshere',
'server' => 'yourserverkeygoeshere',
'bypass' => false,
'default_timeout' => 900,
],
],
];
```
A third parameter is there, to help you work through functional tests (e.g., behat). You could set 'bypass' to be true (don't validate the captcha) based on some fixed environment variable, example:
```php
'bypass' => getenv('SOMEKEY') === 'development'
```
The fourth is the timeout (in seconds) that you permit between the time the captcha is served, and the time that it is solved.
# Templates
You need to add the captcha to your form templates, E.g., using Twig it'd look like:
``` twig
{{ formLabel( form.get('g-recaptcha-response') ) }}
{{ recaptcha( form.get('g-recaptcha-response') ) }}
{{ formElementErrors( form.get('g-recaptcha-response') ) }}
```
*For now, the g-recaptcha-response is not mutable. The reason being that Google renders it with this name, there's no option to change*
# Form & InputFilter
If you're unfamiliar with ZF2, here's sample form code that implements the Captcha. There's more than needed, but you can see how the Element is added, and similarly, how the counterpart InputFilter (validator) is added as well.
```php
add([
'name' => 'g-recaptcha-response',
'type' => Recaptcha::class,
'options' => [
'label' => _( "Please complete the challenge below" ),
'no_sitekey' => false,
'no_script' => false,
'language' => 'en', // see https://developers.google.com/recaptcha/docs/language
],
]);
$this->add([
'name' => self::EMAIL,
'type' => self::EMAIL,
'options' => [
'label' => _( 'Email' ),
],
'attributes' => [
'maxlength' => 254,
],
]);
$this->add([
'name' => 'email_confirm',
'type' => self::EMAIL,
'options' => [
'label' => _( "Confirm Email" ),
],
'attributes' => [
'maxlength' => 254,
],
]);
$this->add([
'name' => 'submit',
'type' => Button::class,
'options' => [
'label' => _( "Submit" ),
],
'attributes' => [
'class' => 'btn btn-primary',
'type' => 'submit',
]
]);
}
}
```
And here's a sample InputFilter
```php
userRepository = $userRepository;
$this->has_captcha = $has_captcha;
}
public function init()
{
if( $this->has_captcha )
{
$this->add([
'name' => self::RECAPTCHA,
'required' => true,
'messages' => [_("Please complete the anti-robot check!")],
'validators' => [
['name' => \CirclicalRecaptcha\Form\Validator\RecaptchaValidator::class,],
],
]);
$this->get( self::RECAPTCHA )->setBreakOnFailure( true );
}
$this->add([
'name' => 'email',
'required' => true,
'filters' => [
['name' => ArrayBlock::class],
['name' => StringTrim::class],
['name' => HTMLPurifier::class],
['name' => StringToLower::class],
],
'validators' => [
[
'name' => EmailAddress::class,
'options' => [
'useMxCheck' => true,
'useDeepMxCheck' => true,
'useDomainCheck' => true,
'message' => _( "That email address has a typo in it, or its domain can't be checked" ),
],
],
[
'name' => NoObjectExists::class,
'options' => [
'fields' => ['email'],
'messages' => [
NoObjectExists::ERROR_OBJECT_FOUND => _( "That email is already taken, please log in instead" ),
],
'object_repository' => $this->userRepository,
],
],
],
]);
$this->add([
'name' => 'email_confirm',
'required' => true,
'filters' => [
['name' => ArrayBlock::class],
['name' => StringTrim::class],
['name' => HTMLPurifier::class],
['name' => StringToLower::class],
],
'validators' => [
[
'name' => 'identical',
'options' => [
'message' => _( "Your email and confirmation email are different" ),
'token' => self::EMAIL,
],
],
],
]);
}
}
```
That's all there is to it! Note the optional `no_sitekey` and `no_script` options on the form init. These are handy if you are sticking many recaptchas on the same view, but need to dynamically fade them in and out.