BotDetect Laravel 5.1 CAPTCHA Integration Quickstart (BotDetect v3.0; deprecated)

1. Installing the BotDetect Laravel Captcha Composer Package

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

"providers" => [
  ...
  LaravelCaptcha\Providers\LaravelCaptchaServiceProvider::class
]

{
  "repositories": [
    {
      "type": "composer",
      "url": "http://packages.captcha.com"
    }
  ]
}

"providers" => [
  ...
  LaravelCaptcha\Providers\LaravelCaptchaServiceProvider::class
]

2. Show a Captcha Challenge on the Form

Route::get('example', 'ExampleController@getExample');
Route::post('example', 'ExampleController@postExample');

<?php namespace App\Http\Controllers;

use Illuminate\Http\Request;
// Importing the BotDetectCaptcha class
use LaravelCaptcha\Integration\BotDetectCaptcha;

class ExampleController extends Controller 
{
  // get a captcha instance to handle for the example page
  private function getExampleCaptchaInstance() 
  {
    // Captcha parameters
    $captchaConfig = [
      'CaptchaId' => 'ExampleCaptcha', // a unique Id for the Captcha instance
      'UserInputId' => 'CaptchaCode', // Id of the Captcha code input textbox
      // The path of the Captcha config file is inside the config folder
      'CaptchaConfigFilePath' => 'captcha_config/ExampleCaptchaConfig.php'
    ];
    return BotDetectCaptcha::GetCaptchaInstance($captchaConfig);
  }

  public function getExample() 
  {
    // captcha instance of the example page
    $captcha = $this->getExampleCaptchaInstance();

    // passing Captcha Html to example view
    return view('example', ['captchaHtml' => $captcha->Html()]);
  }

}

Captcha configuration options (/config/captcha_config/ExampleCaptchaConfig.php):

<?php if (!class_exists('CaptchaConfiguration')) { return; }
  
// BotDetect PHP Captcha configuration options

$LBD_CaptchaConfig = CaptchaConfiguration::GetSettings();

$LBD_CaptchaConfig->CodeLength = 4;
$LBD_CaptchaConfig->ImageWidth = 250;
$LBD_CaptchaConfig->ImageHeight = 50;

Showing a Captcha challenge in a View:

  <link type="text/css" rel="stylesheet" href="{{ CaptchaUrls::LayoutStylesheetUrl() }}">
</head>
  
  [...]

  {!! $captchaHtml !!}
  <input type="text" id="CaptchaCode" name="CaptchaCode">

3. Check User Input During Form Submission

<?php namespace App\Http\Controllers;

use Illuminate\Http\Request;
// Importing the BotDetectCaptcha class
use LaravelCaptcha\Integration\BotDetectCaptcha;

class ExampleController extends Controller 
{
  // get a captcha instance to handle for the example page
  private function getExampleCaptchaInstance() {
    // Captcha parameters
    $captchaConfig = [
      'CaptchaId' => 'ExampleCaptcha', // a unique Id for the Captcha instance
      'UserInputId' => 'CaptchaCode', // Id of the Captcha code input textbox
      // The path of the Captcha config file is inside the config folder
      'CaptchaConfigFilePath' => 'captcha_config/ExampleCaptchaConfig.php'
    ];
    return BotDetectCaptcha::GetCaptchaInstance($captchaConfig);
  }

  public function getExample() 
  {
    // captcha instance of the example page
    $captcha = $this->getExampleCaptchaInstance();

    // passing Captcha Html to example view
    return view('example', ['captchaHtml' => $captcha->Html()]);
  }

  public function postExample(Request $request) 
  {
    // captcha instance of the example page
    $captcha = $this->getExampleCaptchaInstance();

    // validate the user-entered Captcha code when the form is submitted
    $code = $request->input('CaptchaCode');
    $isHuman = $captcha->Validate($code);

    if ($isHuman) {
      // TODO: Captcha validation passed, perform protected  action
    } else {
      // TODO: Captcha validation failed, show error message
    }
    
  }

}

In-Depth Laravel CAPTCHA Instructions and Explanations

Detailed Laravel Captcha instructions and explanations can be found in the Laravel 5.1 Captcha integration how to guide.

Other BotDetect PHP CAPTCHA Quickstarts

[back to the top of the page]