https://github.com/divineomega/is_offensive

🤬🤭 Is Offensive Helper Function - Check if a string contains offensive words or variations of them
https://github.com/divineomega/is_offensive

offensive offensive-language php php-helper php-library

Last synced: about 2 months ago
JSON representation

🤬🤭 Is Offensive Helper Function - Check if a string contains offensive words or variations of them

• Host: GitHub
• URL: https://github.com/divineomega/is_offensive
• Owner: DivineOmega
• License: lgpl-3.0
• Created: 2018-01-30T13:30:24.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2020-09-03T14:31:10.000Z (over 4 years ago)
• Last Synced: 2024-10-15T02:37:41.792Z (2 months ago)
• Topics: offensive, offensive-language, php, php-helper, php-library
• Language: PHP
• Homepage:
• Size: 138 KB
• Stars: 7
• Watchers: 3
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

# 🤬🤭 Is Offensive Helper Function

[![Build Status](https://travis-ci.org/DivineOmega/is_offensive.svg?branch=master)](https://travis-ci.org/DivineOmega/is_offensive)

[![Coverage Status](https://coveralls.io/repos/github/DivineOmega/is_offensive/badge.svg?branch=master)](https://coveralls.io/github/DivineOmega/is_offensive?branch=master)

[![StyleCI](https://styleci.io/repos/119539842/shield?branch=master)](https://styleci.io/repos/119539842)

This PHP package provides an `is_offensive` helper function. Passing a string to `is_offensive` will return a boolean telling you if it contains offensive words.

## Installation

The `is_offensive` package can be easily installed using Composer. Just run the following command from the root of your project.

```

composer require "divineomega/is_offensive"

```

If you have never used the Composer dependency manager before, head to the [Composer website](https://getcomposer.org/) for more information on how to get started.

## Usage

To check if a word is offensive, just pass it to the `is_offensive` method.

Here are a few examples:

```php

is_offensive('fuck');  // true

is_offensive('fuk');   // true

is_offensive('duck');  // false

is_offensive('cat');   // false

is_offensive('sex');         // true

is_offensive('Middlesex');   // false

is_offensive('tit');         // true

is_offensive('Tittesworth'); // false

is_offensive('cunt');        // true

is_offensive('Scunthorpe');  // false

```

If you prefer to avoid using helper functions, the following syntax is also available.

```php

$offensive = (new OffensiveChecker())->isOffensive('fuck')  // true

```

### Custom word lists

There are reasons why you may wish to define your own list of offensive words. Perhaps the

ones supplied are too strict, or not strict enough.

```php

$blacklist = ['moist', 'stinky', 'poo'];

$offensiveChecker = new OffensiveChecker($blacklist);

$offensiveChecker->isOffensive('poo');     // true

$offensiveChecker->isOffensive('poops');   // true

```

You can also define a whitelist of words that will be accepted even if they match the defined

list of offensive words.

```php

$blacklist = ['moist', 'stinky', 'poo'];

$whitelist = ['poop'];

$offensiveChecker = new OffensiveChecker($blacklist, $whitelist);

$offensiveChecker->isOffensive('poo');     // true

$offensiveChecker->isOffensive('poops');   // false

```