README

A simple Lumen 9/10 service provider for including the Captcha for Lumen.

Installation

The Captcha Service Provider can be installed via Composer by requiring the swjtuhyq/captcha package and setting the minimum-stability to dev (required for Laravel 5) in your project's composer.json.

{
    "require": {
        "laravel/lumen-framework": "^10.0",
        "swjtuhyq/captcha": "~2.0"
    },
    "minimum-stability": "dev"
}

Require this package with composer:

composer require swjtuhyq/captcha

Update your packages with composer update or install with composer install.

In Windows, you'll need to include the GD2 DLL php_gd2.dll in php.ini. And you also need include php_fileinfo.dll and php_mbstring.dll to fit the requirements of swjtuhyq/captcha's dependencies.

Usage

To use the Captcha Service Provider, you must register the provider when bootstrapping your Laravel application. There are essentially two ways to do this.

Find the providers key in config/app.php and register the Captcha Service Provider.

    'providers' => [
        // ...
        'Swjtuhyq\Captcha\CaptchaServiceProvider',
    ]

Find the aliases key in config/app.php.

    'aliases' => [
        // ...
        'Captcha' => 'Swjtuhyq\Captcha\Facades\Captcha',
    ]

Configuration

To use your own settings, publish config.

config/captcha.php

return [
    'default'   => [
        'length'    => 5,
        'width'     => 120,
        'height'    => 36,
        'quality'   => 90,
        'math'      => true,  //Enable Math Captcha
        'expire'    => 60,    //Stateless/API captcha expiration
    ],
    // ...
];

Example Usage

Stateless Mode:

You get key and img from this url http://localhost/captcha/api/math and verify the captcha using this method:

    //key is the one that you got from json response
    // fix validator
    // $rules = ['captcha' => 'required|captcha_api:'. request('key')];
    $rules = ['captcha' => 'required|captcha_api:'. request('key') . ',math'];
    $validator = validator()->make(request()->all(), $rules);
    if ($validator->fails()) {
        return response()->json([
            'message' => 'invalid captcha',
        ]);

    } else {
        //do the job
    }

Return Image

captcha();

Captcha::create();

Return URL

captcha_src();

Captcha::src('default');

Return HTML

captcha_img();

Captcha::img();

To use different configurations

captcha_img('flat');

Captcha::img('inverse');

etc.

Based on Captcha for Laravel 5/6/7/8

^_^

swjtuhyq / captcha

Maintainers

Details