Download the PHP package blaspsoft/blasp without Composer

Blasp - Advanced Profanity Filter for Laravel

Blasp is a powerful, extensible profanity filter package for Laravel that helps detect and mask profane words in text. Version 3.0 introduces a simplified API with method chaining, comprehensive multi-language support (English, Spanish, German, French), all-languages detection mode, and advanced caching for enterprise-grade performance.

✨ Key Features

• 🔗 Method Chaining: Elegant fluent API with Blasp::spanish()->check()
• 🌍 Multi-Language Support: English, Spanish, German, and French with language-specific normalizers
• 🌐 All Languages Mode: Check against all languages simultaneously with Blasp::allLanguages()
• 🎨 Custom Masking: Configure custom mask characters with maskWith() method
• ⚡ High Performance: Advanced caching with O(1) lookups and optimized algorithms
• 🎯 Smart Detection: Handles substitutions, separators, variations, and false positives
• 🏗️ Modern Architecture: Built on SOLID principles with dependency injection
• ✅ Battle Tested: 148 tests with 858 assertions ensuring reliability

Installation

You can install the package via Composer:

Quick Start

Basic Usage

Simplified API with Method Chaining

Working with Results

Profanity Detection Types

Blasp can detect different types of profanities based on variations such as:

1. Straight match: Direct matches of profane words.
2. Substitution: Substituted characters (e.g., pro0fán1ty).
3. Obscured: Profanities with separators (e.g., p-r-o-f-a-n-i-t-y).
4. Doubled: Repeated letters (e.g., pprrooffaanniittyy).
5. Combination: Combinations of the above (e.g., pp-rof@n|tty).

Laravel Validation Rule

Blasp also provides a custom Laravel validation rule called blasp_check, which you can use to validate form input for profanity.

Example

Configuration

Blasp uses configuration files to manage profanities, separators, and substitutions. The main configuration includes:

You can publish the configuration files:

This will publish:

• config/blasp.php - Main configuration with default language settings
• config/languages/ - Language-specific profanity lists (English, Spanish, German, French)

Custom Configuration

You can specify custom profanity and false positive lists using the configure() method:

This is particularly useful when you need different profanity rules for specific contexts, such as username validation.

🚀 Advanced Features (v3.0+)

All Languages Detection

Perfect for international platforms, forums, or any application with multilingual content:

Multi-Language Support

Blasp includes comprehensive support for multiple languages with automatic character normalization:

• English: Full profanity database with common variations
• Spanish: Handles accent normalization (á→a, ñ→n)
• German: Processes umlauts (ä→ae, ö→oe, ü→ue) and ß→ss
• French: Accent and cedilla normalization

Complete Chainable Methods Reference

Advanced Method Chaining Examples

Laravel Integration

Cache Management

Blasp uses Laravel's cache system to improve performance. The package automatically caches profanity expressions and their variations. To clear the cache, you can use the provided Artisan command:

This command will clear all cached Blasp expressions and configurations.

⚡ Performance

Blasp v3.0 includes significant performance optimizations:

• Cached Expression Sorting: Profanity expressions are sorted once and cached, eliminating repeated O(n log n) operations
• Hash Map Lookups: False positive checking and unique profanity tracking use O(1) hash map lookups instead of O(n) linear searches
• Optimized Regular Expressions: Improved regex generation and matching algorithms
• Intelligent Caching: Multi-layer caching system with automatic cache invalidation

Benchmarks

Version 3.0 shows substantial performance improvements over v2:

• Expression Processing: 60% faster profanity expression generation
• Detection Speed: 40% faster text analysis with large profanity lists
• Memory Usage: 30% reduction in memory footprint
• Cache Efficiency: 80% fewer database/config queries with intelligent caching

🔄 Migration from v2.x to v3.0

100% Backward Compatible

All existing v2.x code continues to work without any changes:

New Features in v3.0

Take advantage of the simplified API:

🎨 Custom Masking

Using Custom Mask Characters

You can customize how profanities are masked using the maskWith() method:

Setting Default Mask Character

You can set a default mask character in the configuration:

Combining with Other Methods

The maskWith() method can be chained with other methods:

🏗️ Architecture

Blasp v3.0 follows SOLID principles and modern PHP practices:

• Facade Pattern: Simplified API with Laravel facade integration
• Builder Pattern: Method chaining for fluent interface
• Strategy Pattern: Language-specific detection and normalization
• Dependency Injection: Full Laravel service container integration
• Caching: Intelligent performance optimization

📋 Requirements

• PHP 8.1+
• Laravel 10.0+
• BCMath PHP Extension (for advanced calculations)

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

📄 Changelog

See CHANGELOG.md for detailed version history.

License

Blasp is open-sourced software licensed under the MIT license.