https://github.com/heyitsmi/content-guard
ContentGuard is a robust PHP content sanitization library specifically designed for the Indonesian web ecosystem. It helps developers filter out online gambling spam (judi online), profanity, and hate speech with advanced detection capabilities.
https://github.com/heyitsmi/content-guard
library package php
Last synced: 6 months ago
JSON representation
ContentGuard is a robust PHP content sanitization library specifically designed for the Indonesian web ecosystem. It helps developers filter out online gambling spam (judi online), profanity, and hate speech with advanced detection capabilities.
- Host: GitHub
- URL: https://github.com/heyitsmi/content-guard
- Owner: heyitsmi
- License: mit
- Created: 2025-11-29T11:32:35.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2026-01-10T12:34:46.000Z (6 months ago)
- Last Synced: 2026-01-11T03:53:01.599Z (6 months ago)
- Topics: library, package, php
- Language: PHP
- Homepage: https://content-guard.diaiti.com
- Size: 19.5 KB
- Stars: 3
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# ContentGuard
**ContentGuard** is a robust PHP content sanitization library specifically designed for the **Indonesian** web ecosystem. It helps developers filter out online gambling spam (*judi online*), profanity, and hate speech with advanced detection capabilities.
Unlike simple string replacement tools, ContentGuard uses an intelligent **Regex Engine** to detect "Leet Speak" (visual masking) commonly used by spammers (e.g., detecting `s10t g4c0r` as `slot gacor`).
## Features
- ✅ **Smart Detection:** Catch masked words like `g4c0r`, `s.l.o.t`, `judi`, etc.
- ✅ **Pre-built Dictionary:** Comes with a comprehensive database of Indonesian gambling terms and profanity.
- ✅ **Laravel Ready:** Includes Service Provider and Facade for seamless integration.
- ✅ **Customizable:** Add your own blocklist and configure strictness.
- ✅ **Zero Dependencies:** Lightweight and fast.
## Installation
You can install the package via composer:
```bash
composer require heyitsmi/content-guard
```
## Configuration (Laravel)
If you are using Laravel, you can publish the configuration file to customize the behavior (e.g., changing the mask character or adding custom keywords).
Run the following command:
```bash
php artisan vendor:publish --tag="content-guard-config"
```
This will create a `config/content-guard.php` file in your application.
## Usage
### 1. Using Laravel Facade (Recommended for Laravel)
You can use the `ContentGuard` facade anywhere in your controllers, jobs, or blade directives.
```php
use Heyitsmi\ContentGuard\Facades\ContentGuard;
// 1. Check if text contains bad words (returns boolean)
$isSpam = ContentGuard::hasBadWords("Ayo main s10t g4c0r hari ini!");
if ($isSpam) {
return back()->withErrors(['message' => 'Your comment contains restricted content.']);
}
// 2. Sanitize text (returns clean string)
$cleanText = ContentGuard::sanitize("Jangan main judi online!");
// Output: "Jangan main **** ******!"
```
### 2. Standalone PHP Usage
If you are not using Laravel, you can instantiate the class directly.
```php
use Heyitsmi\ContentGuard\ContentGuard;
$guard = new ContentGuard();
$input = "Situs g.a.c.o.r terpercaya";
if ($guard->hasBadWords($input)) {
echo "Spam detected!";
}
echo $guard->sanitize($input);
```
### 3. Client-side Masking (Blur or Hidden)
ContentGuard can wrap detected words in HTML tags, allowing you to use CSS and JavaScript for a premium "click-to-reveal" experience.
#### Publication (Laravel)
Publish the assets (CSS and JS):
```bash
php artisan vendor:publish --tag="content-guard-assets"
```
#### Assets Inclusion
In your layout file (e.g., `app.blade.php`), inclusion the assets using the blade directive:
```html
...
@contentGuardAssets
```
#### Usage
Use the `wrap()` method instead of `sanitize()` to get HTML-tagged content:
```php
$text = "Bocoran slot gacor hari ini";
// Default is 'blur'
echo ContentGuard::wrap($text);
// Or use 'mask' for a solid black box
echo ContentGuard::wrap($text, 'mask');
```
The `wrap()` method will generate:
`slot`
Users can click on the blurred/masked word to reveal the original content.
## How It Works
ContentGuard converts standard keywords into flexible Regex patterns based on a Substitution Map.
- **Input:** `slot`
- **Regex Generated:** `/\b(s|5|\$|z)[\W_]*(l|1|!|\|)[\W_]*(o|0|@|ø)[\W_]*(t|7|\+)\b/i`
- **Matches:** `slot`, `s1ot`, `s.l.o.t`, `s-l-o-t`, `sl0t`, etc.
## Testing
To run the unit tests included in this package:
```bash
composer test
```
## Contributing
Contributions are welcome! If you find new slang words or spam patterns popular in Indonesia, please submit a Pull Request to update the `src/Dictionary` files.
## License
The MIT License (MIT). Please see License File for more information.