https://github.com/mohammadv184/arcaptcha-laravel

Laravel Package for the ArCaptcha
https://github.com/mohammadv184/arcaptcha-laravel

arcaptcha captcha laravel laravel-framework laravelpackage persian-captcha

Last synced: 17 days ago
JSON representation

Laravel Package for the ArCaptcha

• Host: GitHub
• URL: https://github.com/mohammadv184/arcaptcha-laravel
• Owner: mohammadv184
• License: mit
• Created: 2021-08-07T07:02:46.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-02-10T18:21:38.000Z (over 2 years ago)
• Last Synced: 2024-10-09T16:23:36.548Z (28 days ago)
• Topics: arcaptcha, captcha, laravel, laravel-framework, laravelpackage, persian-captcha
• Language: PHP
• Homepage: https://arcaptcha.ir
• Size: 72.3 KB
• Stars: 9
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# Laravel ArCaptcha Package

[![Latest Stable Version](http://poser.pugx.org/mohammadv184/arcaptcha-laravel/v)](https://packagist.org/packages/mohammadv184/arcaptcha-laravel) 

[![Total Downloads](http://poser.pugx.org/mohammadv184/arcaptcha-laravel/downloads)](https://packagist.org/packages/mohammadv184/arcaptcha-laravel) 

[![Latest Unstable Version](http://poser.pugx.org/mohammadv184/arcaptcha-laravel/v/unstable)](https://packagist.org/packages/mohammadv184/arcaptcha-laravel) 

[![License](http://poser.pugx.org/mohammadv184/arcaptcha-laravel/license)](https://packagist.org/packages/mohammadv184/arcaptcha-laravel)

Laravel Package for the ArCaptcha

This package supports `PHP 7.3+`.

For **PHP** integration you can use [mohammadv184/arcaptcha](https://github.com/mohammadv184/arcaptcha) package.

# List of contents

- [PHP ArCaptcha Library](#PHP-ArCaptcha-Library)

- [List of contents](#list-of-contents)

    - [Installation](#Installation)

    - [Configuration](#Configuration)

        - [Publish package](#publish-package)

        - [Set the environment](#set-the-environment)

        - [Customize error message](#customize-error-message)

    - [How to use](#how-to-use)

        - [Embed Script in Blade](#Embed-Script-in-Blade)

        - [Form setup](#Form-setup)

        - [Verify submitted data](#Verify-submitted-data)

    - [Credits](#credits)

    - [License](#license)

## Installation

You can install the package via composer:

```bash

composer require mohammadv184/arcaptcha-laravel

```

Laravel 5.5 (or greater) uses package auto-discovery, so doesn't require you to manually add the Service Provider, but if you 

don't use auto-discovery ArCaptchaServiceProvider must be registered in config/app.php:

```php

'providers' => [

    ...

    Mohammadv184\ArCaptcha\Laravel\ArCaptchaServiceProvider::class,

];

```

You can use the facade for shorter code. Add ArCaptcha to your aliases:

```php

'aliases' => [

    ...

    'ArCaptcha' => Mohammadv184\ArCaptcha\Laravel\Facade\ArCaptcha::class,

];

```

## Configuration

### Publish package

Create config/arcaptcha.php configuration file using the following artisan command:

```php

php artisan vendor:publish --provider="Mohammadv184\ArCaptcha\Laravel\ArCaptchaServiceProvider"

```

### Set the environment

Open .env file and set `ARCAPTCHA_SITE_KEY` and `ARCAPTCHA_SECRET_KEY`:

```dotenv

# in your .env file

ARCAPTCHA_SITE_KEY=YOUR_API_SITE_KEY

ARCAPTCHA_SECRET_KEY=YOUR_API_SECRET_KEY

```

### Customize error message

Before starting please add the validation message to `resources/lang/[LANG]/validation.php` file

```php

return [

    ...

    'arcaptcha' => 'Hey!!! :attribute is wrong!',

];

```

## How to use

How to use ArCaptcha in Laravel.

### Embed Script in Blade

Insert `@arcaptchaScript` blade directive before closing `` tag.

You can also use `ArCaptcha::getScript()`.

```html

    

        ...

        @arcaptchaScript

    

```

### Form setup

After you have to insert `@arcaptchaWidget` blade directive inside the form where you want to use the field `arcaptcha-token`.

You can also use `ArCaptcha::getWidget()`.

```html

    @csrf

    ...

    @arcaptchaWidget

    

    {!! ArCaptcha::getWidget() !!}

    

```

### Verify submitted data

Add `arcaptcha` to your rules

```php

$validator = Validator::make(request()->all(), [

        ...

        'arcaptcha-token' => 'arcaptcha',

    ]);

    // check if validator fails

    if($validator->fails()) {

        ...

        $errors = $validator->errors();

    }

```

## Credits

- [Mohammad Abbasi](https://github.com/mohammadv184)

- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE) for more information.