jojoee/leo-profanity

Profanity filter, based on Shutterstock dictionary

leo-profanity-php

![Software License][ico-license] , _(*1)

Profanity filter, based on Shutterstock dictionary, _(*2)

Install

Via Composer, _(*3)

``` bash $ composer require jojoee/leo-profanity, <sub>(*4)</sub>

``` php
use Jojoee\Library\LeoProfanity as LeoProfanity;

$filter = new LeoProfanity();
$filter->check('I have BoOb');

Usage

$filter->getList()

``` php // return all profanity words (string[]) $filter->getList();, <sub>(*5)</sub>

### $filter->check(string)

Check out mor example on `clean` method

``` php
// output: true
$filter->clean('I have boob');

$filter->clean(string, [replaceKey=*])

``` php // no bad word // output: I have 2 eyes $filter->clean('I have 2 eyes');, <sub>(*6)</sub>

// normal case // output: I have ****, etc. $filter->clean('I have boob, etc.');, <sub>(*7)</sub>

// case sensitive // output: I have **** $filter->clean('I have BoOb');, <sub>(*8)</sub>

// separated by comma and dot // output: I have ****. $filter->clean('I have BoOb.');, <sub>(*9)</sub>

// multi occurrence // output: I have ****,****, ***, and etc. $filter->clean('I have boob,boob, ass, and etc.');, <sub>(*10)</sub>

// should not detect unspaced-word // output: Buy classic watches online $filter->clean('Buy classic watches online');, <sub>(*11)</sub>

// clean with custom replacement-character // output: I have ++++ $filter->clean('I have boob', '+');, <sub>(*12)</sub>

### $filter->add(string|string[])

``` php
// add word
$filter->add('b00b');

// add word's array
// check duplication automatically
$filter->add(['b00b', 'b@@b']);

$filter->remove(string|string[])

``` php // remove word $filter->remove('b00b');, <sub>(*13)</sub>

// remove word's array $filter->remove(['b00b', 'b@@b']); ```, <sub>(*14)</sub>

$filter->reset()

Reset word list by using default dictionary (also remove word that manually add), <sub>(*15)</sub>

$filter->clearList()

Clear all profanity words, <sub>(*16)</sub>

Note

• Filter algorithm from jojoee/leo-profanity
• Testing (using composer test)
• PSR-2 Coding Standard (tested by composer check-style and fix it with composer fix-style.)
• Security, if you discover any security related issues, please email inid3a@gmail.com instead of using the issue tracker.
• Follow SemVer v2.0.0
• Coherent history (each individual commit is meaningful), if not please squash them.

TODO

• [x] Unit test
• [x] Test coverage
• [x] PHP CodeSniffer
• [x] Support PHP version 5.6, 7.0, hhvm

Other languages

• [x] Javascript on npmjs.com/package/leo-profanity
• [x] PHP on packagist.org/packages/jojoee/leo-profanity
• [ ] Python on PyPI
• [ ] Java on Maven
• [ ] Wordpress on wordpress.org

Contribute

Please run composer check and fix before commit, <sub>(*17)</sub>

Reference

• Skeleton template: thephpleague/skeleton, koriym/Koriym.PhpSkeleton, petk/php-skeleton