nyx-solutions / yii2-nyx-recaptcha-widget
Yii2 Google reCAPTCHA v2 and v3 widget
Installs: 72
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 0
Type:yii2-extension
Requires
- php: >=8.1.0 <8.2
- nyx-solutions/yii2-nyx: ~5.0.0
- yiisoft/yii2-httpclient: ~2.0.14
Requires (Dev)
- phpunit/phpunit: ^4.8.34
README
Based on Google reCaptcha API 2.0 and 3.0.
Upgrade to 2.x version
Warning! Classes ReCaptcha
and ReCaptchaValidator
is deprecated. Please replace their to ReCaptchaConfig
,
ReCaptcha2
and ReCaptchaValidator2
.
Installation
The preferred way to install this extension is through composer.
- Either run
php composer.phar require --prefer-dist "himiklab/yii2-recaptcha-widget" "*"
or add
"himiklab/yii2-recaptcha-widget" : "*"
to the require
section of your application's composer.json
file.
-
Configure the component in your configuration file (web.php). The parameters siteKey and secret are optional. But if you leave them out you need to set them in every validation rule and every view where you want to use this widget. If a siteKey or secret is set in an individual view or validation rule that would overrule what is set in the config.
'components' => [ 'reCaptcha' => [ 'class' => 'nyx\widgets\recaptcha\ReCaptchaConfig', 'siteKeyV2' => 'your siteKey v2', 'secretV2' => 'your secret key v2', 'siteKeyV3' => 'your siteKey v3', 'secretV3' => 'your secret key v3', ], ...
or use DI container:
'container' => [ 'definitions' => [ nyx\widgets\recaptcha\ReCaptcha2::className() => function ($container, $params, $config) { return new nyx\widgets\recaptcha\ReCaptcha2( 'your siteKey v2', '', // default $config ); }, nyx\widgets\recaptcha\ReCaptchaValidator2::className() => function ($container, $params, $config) { return new nyx\widgets\recaptcha\ReCaptchaValidator2( 'your secret key v2', '', // default null, // default null, // default $config ); }, ], ],
- Add
ReCaptchaValidator2
orReCaptchaValidator3
in your model, for example:
v2
public $reCaptcha; public function rules() { return [ // ... [['reCaptcha'], \nyx\widgets\recaptcha\ReCaptchaValidator2::className(), 'secret' => 'your secret key', // unnecessary if reСaptcha is already configured 'uncheckedMessage' => 'Please confirm that you are not a bot.'], ]; }
v3
public $reCaptcha; public function rules() { return [ // ... [['reCaptcha'], \nyx\widgets\recaptcha\ReCaptchaValidator3::className(), 'secret' => 'your secret key', // unnecessary if reСaptcha is already configured 'threshold' => 0.5, 'action' => 'homepage', ], ]; }
Usage
For example:
v2
<?= $form->field($model, 'reCaptcha')->widget( \nyx\widgets\recaptcha\ReCaptcha2::className(), [ 'siteKey' => 'your siteKey', // unnecessary is reCaptcha component was set up ] ) ?>
v3
<?= $form->field($model, 'reCaptcha')->widget( \nyx\widgets\recaptcha\ReCaptcha3::className(), [ 'siteKey' => 'your siteKey', // unnecessary is reCaptcha component was set up 'action' => 'homepage', ] ) ?>
or
v2
<?= \nyx\widgets\recaptcha\ReCaptcha2::widget([ 'name' => 'reCaptcha', 'siteKey' => 'your siteKey', // unnecessary is reCaptcha component was set up 'widgetOptions' => ['class' => 'col-sm-offset-3'], ]) ?>
v3
<?= \nyx\widgets\recaptcha\ReCaptcha3::widget([ 'name' => 'reCaptcha', 'siteKey' => 'your siteKey', // unnecessary is reCaptcha component was set up 'action' => 'homepage', 'widgetOptions' => ['class' => 'col-sm-offset-3'], ]) ?>
- NOTE: Please disable ajax validation for ReCaptcha field!