BotDetect Symfony 4 CAPTCHA Integration Quickstart

Unlike Recaptcha the Stalker -- BotDetect CAPTCHA works in China! Licensable source-code; self-hosted -- doesn't stalk -- nor does it slurp your form-data! Think: GDPR & LGPD!

1. Installing the BotDetect Symfony CaptchaBundle

Note: If you do not have Composer yet, you can install it by following the instructions on https://getcomposer.org

If you have Git installed on your development machine, you should use the following installation procedure:

Step 1: Download CaptchaBundle using composer

Run the following command in your application's root directory:

Step 2: Import CaptchaBundle routing file (config/routes.yml):

captcha_routing: 
  resource: "@CaptchaBundle/Resources/config/routing.yml" 

2. Show a Captcha Challenge on the Form

a) If Symfony is a backend for your js-based frontend, perhaps you should start with a guide that describes integration from js-framework point of view: jQuery, Angular, AngularJS, or React.

b) If you are using Symfony forms, here is how to configure Captcha options, and display Captcha in your Symfony form:

Captcha configuration options (config/packages/captcha.php):

<?php if (!class_exists('CaptchaConfiguration')) { return; } 

// BotDetect PHP Captcha configuration options 

return [ 
  // Captcha configuration for example page 
  'ExampleCaptcha' => [ 
    'UserInputID' => 'captchaCode', 
    'ImageWidth' => 250, 
    'ImageHeight' => 50, 
  ], 

]; 

Adding the CaptchaType in your form:

use Captcha\Bundle\CaptchaBundle\Form\Type\CaptchaType; 

$builder->add('captchaCode', CaptchaType::class, array( 
  'captchaConfig' => 'ExampleCaptcha' 
)); 

3. Check User Input During Form Submission

Using the ValidCaptcha constraint to validate captcha code when a form is submitted:

namespace App\Entity; 

use Captcha\Bundle\CaptchaBundle\Validator\Constraints as CaptchaAssert; 

class Example 
{ 
  /** 
   * @CaptchaAssert\ValidCaptcha( 
   *      message = "CAPTCHA validation failed, try again." 
   * ) 
   */ 
  protected $captchaCode; 

  public function getCaptchaCode() 
  { 
    return $this->captchaCode; 
  } 

  public function setCaptchaCode($captchaCode) 
  { 
    $this->captchaCode = $captchaCode; 
  } 
} 

In-Depth Symfony CAPTCHA Instructions and Explanations

Detailed Symfony Captcha instructions and explanations can be found in the Symfony 4 Captcha integration how to guide.

Other BotDetect PHP CAPTCHA Quickstarts

PHP CAPTCHA CodeIgniter CAPTCHA Laravel CAPTCHA
CakePHP CAPTCHA

BotDetect Symfony CAPTCHA System Requirements

Symfony

Supported Symfony Versions:

  • Symfony 4.x