wtone/lumen-captcha

Laravel 5 & 6 & lumen 6 Captcha Package

1.0.3 2020-03-20 04:00 UTC

This package is auto-updated.

Last update: 2024-12-06 01:30:22 UTC


README

A simple Lumen service provider for including the Captcha for Laravel.

for Lumen 6

Preview

Based on news/captcha

Installation

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

{
    "require": {
        "wtone/lumen-captcha": "~2.0"
    },
    "minimum-stability": "dev"
}

or

Require this package with composer:

composer require wtone/lumen-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 wtone/lumen-captcha's dependencies.

Usage

To use the Captcha Service Provider, you must register session provider and captcha provider when bootstrapping your application.

Configuration

create a new file config/captcha.php

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

create a new file config/session.php

return [
    'driver' => env('SESSION_DRIVER', 'file'),//默认使用file驱动,你可以在.env中配置
    'lifetime' => 120,//缓存失效时间
    'expire_on_close' => false,
    'encrypt' => false,
    'files' => storage_path('framework/session'),//file缓存保存路径
    'connection' => null,
    'table' => 'sessions',
    'lottery' => [2, 100],
    'cookie' => 'laravel_session',
    'path' => '/',
    'domain' => null,
    'secure' => false,
];

in bootstrap/app.php.

    // regiseter Provider
    $app->register(Illuminate\Session\SessionServiceProvider::class);
    $app->register(Wtone\Captcha\CaptchaServiceProvider::class);
    // load config
    $app->configure('session');
    $app->configure('captcha');
    // set alias
    $app->alias('session', 'Illuminate\Session\SessionManager');
    $app->alias('Captcha', Wtone\Captcha\Facades\Captcha::class);

make sure create folder "storage/framework/session" and chmod it

Return Image

captcha();

or

Captcha::create();

Return URL

captcha_src();

or

Captcha::src('default');

Return HTML

captcha_img();

or

Captcha::img();

To use different configurations

captcha_img('flat');

Captcha::img('inverse');

etc.

^_^