Go to file
kotas f622dec4e5 Add test to validate word with accent 2017-06-20 10:03:45 +02:00
src Add slovak list of bad words 2017-06-20 10:03:06 +02:00
tests Add test to validate word with accent 2017-06-20 10:03:45 +02:00
.gitignore initial commit 2016-07-18 18:28:52 -05:00
.travis.yml travis php versions ^ 5.6 2017-02-21 13:42:58 -06:00
LICENSE add license 2017-05-29 14:44:47 -05:00
README.md improve readme 2017-06-18 09:30:34 -05:00
composer.json Support Auto-discovery 2017-06-04 17:03:20 -05:00
composer.lock Support Auto-discovery 2017-06-04 17:03:20 -05:00
phpunit.xml I think it's done 2016-07-18 20:20:02 -05:00

README.md

Laravel Profanity Validator

Latest Stable Version Total Downloads License Daily Downloads composer.lock

I made this package to perform a validation for swearwords using Laravel validation service.

Instalation

Install via composer

composer require arandilopez/laravel-profane

Configuration

Add the ProfaneServiceProvider class in your config/app.php file.

<?php
return [
  // ...

  'providers' => [
    // ...
    LaravelProfane\ProfaneServiceProvider::class,
  ];

  // ...
];

Publish vendor lang files if you need to replace by your own.

php artisan vendor:publish

How to use

This package register a custom validator. You can use in your controller's validate function.

<?php
// ...
class MyController extends Controller
{
  public function store(Request $request)
  {
    $this->validate($request, [
      'username' => 'required|profane'
    ]);

    // ...
  }
}

The validator will load the default locale in your config/app.php file configuration which by is en. If your locale is not supported, please post an issue for this project

If you want to use others dictionaries you can pass them as parameters in the validator.

<?php
// ...
class MyController extends Controller
{
  public function store(Request $request)
  {
    $this->validate($request, [
      'username' => 'required|profane:es,en'
    ]);

    // ...
  }
}

You can also send as parameter a path of a file which is a dictionary in order to replace the default dictionary or add a new non supported locale.

<?php
// ...
class MyController extends Controller
{
  public function store(Request $request)
  {
    $this->validate($request, [
      'username' => 'required|profane:es,en,'.resource_path('lang/fr/dict.php')
    ]);

    // ...
  }
}

Getting Help

If you're stuck getting something to work, or need to report a bug, please post an issue in the Github Issues for this project.

Contributing

If you're interesting in contributing code to this project, clone it by running:

git clone git@github.com:arandilopez/laravel-profane.git

Pull requests are welcome, but please make sure you provide unit tests to cover your changes. You can help to add and support more locales!

Supported Locales

  • English
  • Spanish
  • Italian ( provided by @aletundo )

License

This project is open-sourced software licensed under the MIT license.