Download the PHP package diego-ninja/banthis without Composer
On this page you can find all versions of the php package diego-ninja/banthis. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download diego-ninja/banthis
More information about diego-ninja/banthis
Files in diego-ninja/banthis
Package banthis
Short Description A censor and word filtering library for PHP 8.2+
License AGPL-3.0
Homepage https://github.com/diego-ninja/banthis
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package banthis
BanThis - A censor and word filtering library for PHP 8.2+
BanThis is a PHP package for profanity filtering. The PHP script uses regex to intelligently look for "leetspeak"-style numeric or symbol replacements.
This package is an evolution of snipe/banbuilder adapted and refactored to modern php versions.
📦 Installation
To install BanThis, simply include it in your projects's composer.json.
"diego-ninja/banthis": "^1",There are no additional dependencies required for this package to work.
🚀 Usage
Setting the Dictionary
You can set or add dictionaries to the Censor instance.
Adding words from an array
You can add words directly from an array.
Managing the whitelist
You can add words to the whitelist to exclude them from being censored.
Setting the replacement character
You can set the character or string that will replace the censored words.
⚙️ How it works
In a nutshell, this code takes an array of bad words and compares it to an array of common filter-evasion tactics. It then does a string replacement to insert regex parameters into your badwords array, and then evaluates your input string to that expanded banned word list.
So in your bad words array, you might have:
[0] => 'ass'The preg_replace functions replace all of the possible shenanigan letters with regex patterns (in lieu of adding the variants onto the end of the array), so the 'ass' in your array gets turned into this, right before the preg_replace checks for matches:
[0] => /(a|a\.|a\-|4|@|Á|á|À|Â|à|Â|â|Ä|ä|Ã|ã|Å|å|α)(s|s\.|s\-|5|\$|§)(s|s\.|s\-|5|\$|§)/iThis means that a word can have none, one or any variety of leet replacements and it will still trip the trigger. Part of the leet filter includes stripping out letter-dash and letter-dots.
This means that the following all evaluate to the "bitch":
- B1tch
- bi7tch
- b.i.t.c.h.
- b-i-t-c-h
- b.1.t.c.h.
- ßitch
- and so on....
🔬 Tests
To run the unit tests on this package, simply run vendor/bin/phpunit from the package directory.
🙏 Credits
This project is developed and maintained by 🥷 Diego Rin in his free time.
Special thanks to:
- snipe for developing the inital code that serves BanThis as starting point.
- All the contributors and testers who have helped to improve this project through their contributions.
If you find this project useful, please consider giving it a ⭐ on GitHub!
