Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/phpdevsr/recaptcha-codeigniter4
Free to Use Library reCAPTCHA v2 for Codeigniter 4
https://github.com/phpdevsr/recaptcha-codeigniter4
Last synced: 2 days ago
JSON representation
Free to Use Library reCAPTCHA v2 for Codeigniter 4
- Host: GitHub
- URL: https://github.com/phpdevsr/recaptcha-codeigniter4
- Owner: PHPDevsr
- License: mit
- Created: 2022-07-28T06:40:01.000Z (about 2 years ago)
- Default Branch: dev
- Last Pushed: 2024-09-09T07:27:03.000Z (23 days ago)
- Last Synced: 2024-09-30T11:06:13.984Z (2 days ago)
- Language: PHP
- Size: 123 KB
- Stars: 8
- Watchers: 0
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
[](https://github.com/PHPDevsr/reCaptcha-Codeigniter4/actions/workflows/test-phpunit.yml)
[](https://github.com/PHPDevsr/reCaptcha-Codeigniter4/actions/workflows/test-phpstan.yml)
[](https://coveralls.io/github/PHPDevsr/reCaptcha-Codeigniter4?branch=dev)
[](https://packagist.org/packages/phpdevsr/recaptcha-codeigniter4)
[](https://packagist.org/packages/phpdevsr/recaptcha-codeigniter4)
[](https://packagist.org/packages/phpdevsr/recaptcha-codeigniter4)
[](https://github.com/PHPDevsr/reCaptcha-Codeigniter4/blob/dev/LICENSE)
# reCAPTCHA Codeigniter 4
Free to Use Library reCAPTCHA v2 for Codeigniter 4.
# What is reCAPTCHA?
reCAPTCHA is a free service that protects your site from spam and abuse. It uses advanced risk analysis engine to tell humans and bots apart. With the new API, a significant number of your valid human users will pass the reCAPTCHA challenge without having to solve a CAPTCHA (See blog for more details). reCAPTCHA comes in the form of a widget that you can easily add to your blog, forum, registration form, etc.
See [the details][1].
# Sign up for an API key pair
To use reCAPTCHA, you need to [sign up for an API key pair][4] for your site. The key pair consists of a site key and secret. The site key is used to display the widget on your site. The secret authorizes communication between your application backend and the reCAPTCHA server to verify the user's response. The secret needs to be kept safe for security purposes.
# Installation
install with composer
```bash
$ composer require phpdevsr/recaptcha-codeigniter4
$ php spark config:publish
```
# Usage
Since `v2.1.0`, environment config can be use for multiple config with `.env`
```env
recaptcha.recaptchaSiteKey
recaptcha.recaptchaSecretKey
recaptcha.recaptchaLang
```
## Initialization
```php
config = new RecaptchaConfig();
$this->recaptcha = new Recaptcha($this->config);
}
}
```
Since `v2.0.0`, you can using helper
```php
getScriptTag(),
'widgetTag' => getWidget(),
];
$captcha = $this->request->getPost('g-recaptcha-response');
$response = verifyResponse($captcha);
if (isset($response['success']) and $response['success'] === true) {
echo "You got it!";
}
return view('welcome_message', $data);
}
}
```
or directly use `service`
```php
$recaptcha->getScriptTag(),
'widgetTag' => $recaptcha->getWidget(),
];
$captcha = $this->request->getPost('g-recaptcha-response');
$response = $recaptcha->verifyResponse($captcha);
if (isset($response['success']) and $response['success'] === true) {
echo "You got it!";
}
return view('welcome_message', $data);
}
}
```
## Render reCAPTCHA Widget
- Default
```php
echo $this->recaptcha->getWidget();
// Output
```
- Theme
```php
echo $this->recaptcha->getWidget(array('data-theme' => 'dark'));
// Output
```
- Type
```php
echo $this->recaptcha->getWidget(array('data-theme' => 'dark', 'data-type' => 'audio'));
// Output
```
## Render Script Tag
- Default
```php
echo $this->recaptcha->getScriptTag();
// Output
```
- Render
```php
echo $this->recaptcha->getScriptTag(array('render' => 'explicit'));
// Output
```
- Language
```php
echo $this->recaptcha->getScriptTag(array('hl' => 'id'));
// Output
```
## Verify Response
Calls the reCAPTCHA siteverify API to verify whether the user passes `g-recaptcha-response` POST parameter.
```php
$captcha = $this->request->getPost('g-recaptcha-response');
$response = $this->recaptcha->verifyResponse($captcha);
if (isset($response['success']) and $response['success'] === true) {
echo "You got it!";
}
```
# License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
# Contrib
We does accept and encourage contributions from the community in any shape. It doesn't matter whether you can code, write documentation, or help find bugs, all contributions are welcome.
Made with [contrib.rocks](https://contrib.rocks).
[1]: https://www.google.com/recaptcha/intro/index.html
[2]: http://www.codeigniter.com/
[3]: https://developers.google.com/recaptcha/
[4]: http://www.google.com/recaptcha/admin