179 lines
4.2 KiB
Markdown
179 lines
4.2 KiB
Markdown
# Captcha for Laravel 5
|
|
|
|
[](https://travis-ci.org/mewebstudio/captcha) [](https://scrutinizer-ci.com/g/mewebstudio/captcha/?branch=master)
|
|
|
|
A simple [Laravel 5](http://www.laravel.com/) service provider for including the [Captcha for Laravel 5](https://github.com/mewebstudio/captcha).
|
|
|
|
for Laravel 4 [Captcha for Laravel Laravel 4](https://github.com/mewebstudio/captcha/tree/master-l4)
|
|
|
|
## Preview
|
|
|
|
|
|
## Installation
|
|
|
|
The Captcha Service Provider can be installed via [Composer](http://getcomposer.org) by requiring the
|
|
`mews/captcha` package and setting the `minimum-stability` to `dev` (required for Laravel 5) in your
|
|
project's `composer.json`.
|
|
|
|
```json
|
|
{
|
|
"require": {
|
|
"laravel/framework": "5.0.*",
|
|
"mews/captcha": "~2.0"
|
|
},
|
|
"minimum-stability": "dev"
|
|
}
|
|
```
|
|
|
|
or
|
|
|
|
Require this package with composer:
|
|
```
|
|
composer require mews/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 `mews/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.
|
|
|
|
```php
|
|
'providers' => [
|
|
// ...
|
|
'Mews\Captcha\CaptchaServiceProvider',
|
|
]
|
|
```
|
|
for Laravel 5.1+
|
|
```php
|
|
'providers' => [
|
|
// ...
|
|
Mews\Captcha\CaptchaServiceProvider::class,
|
|
]
|
|
```
|
|
|
|
Find the `aliases` key in `config/app.php`.
|
|
|
|
```php
|
|
'aliases' => [
|
|
// ...
|
|
'Captcha' => 'Mews\Captcha\Facades\Captcha',
|
|
]
|
|
```
|
|
for Laravel 5.1+
|
|
```php
|
|
'aliases' => [
|
|
// ...
|
|
'Captcha' => Mews\Captcha\Facades\Captcha::class,
|
|
]
|
|
```
|
|
|
|
## Configuration
|
|
|
|
To use your own settings, publish config.
|
|
|
|
```$ php artisan vendor:publish```
|
|
|
|
`config/captcha.php`
|
|
|
|
```php
|
|
return [
|
|
'default' => [
|
|
'length' => 5,
|
|
'width' => 120,
|
|
'height' => 36,
|
|
'quality' => 90,
|
|
],
|
|
// ...
|
|
];
|
|
```
|
|
|
|
## Example Usage
|
|
```php
|
|
|
|
// [your site path]/Http/routes.php
|
|
|
|
Route::any('captcha-test', function()
|
|
{
|
|
if (Request::getMethod() == 'POST')
|
|
{
|
|
$rules = ['captcha' => 'required|captcha'];
|
|
$validator = Validator::make(Input::all(), $rules);
|
|
if ($validator->fails())
|
|
{
|
|
echo '<p style="color: #ff0000;">Incorrect!</p>';
|
|
}
|
|
else
|
|
{
|
|
echo '<p style="color: #00ff30;">Matched :)</p>';
|
|
}
|
|
}
|
|
|
|
$form = '<form method="post" action="captcha-test">';
|
|
$form .= '<input type="hidden" name="_token" value="' . csrf_token() . '">';
|
|
$form .= '<p>' . captcha_img() . '</p>';
|
|
$form .= '<p><input type="text" name="captcha"></p>';
|
|
$form .= '<p><button type="submit" name="check">Check</button></p>';
|
|
$form .= '</form>';
|
|
return $form;
|
|
});
|
|
```
|
|
|
|
# Return Image
|
|
```php
|
|
captcha();
|
|
```
|
|
or
|
|
```php
|
|
Captcha::create();
|
|
```
|
|
|
|
|
|
# Return URL
|
|
```php
|
|
captcha_src();
|
|
```
|
|
or
|
|
```
|
|
Captcha::src();
|
|
```
|
|
|
|
# Return HTML
|
|
```php
|
|
captcha_img();
|
|
```
|
|
or
|
|
```php
|
|
Captcha::img();
|
|
```
|
|
|
|
# To use different configurations
|
|
```php
|
|
captcha_img('flat');
|
|
|
|
Captcha::img('inverse');
|
|
```
|
|
etc.
|
|
|
|
Based on [Intervention Image](https://github.com/Intervention/image)
|
|
|
|
^_^
|
|
|
|
## Links
|
|
* [Intervention Image](https://github.com/Intervention/image)
|
|
* [L5 Captcha on Github](https://github.com/mewebstudio/captcha)
|
|
* [L5 Captcha on Packagist](https://packagist.org/packages/mews/captcha)
|
|
* [For L4 on Github](https://github.com/mewebstudio/captcha/tree/master-l4)
|
|
* [License](http://www.opensource.org/licenses/mit-license.php)
|
|
* [Laravel website](http://laravel.com)
|
|
* [Laravel Turkiye website](http://www.laravel.gen.tr)
|
|
* [MeWebStudio website](http://www.mewebstudio.com)
|