Download the PHP package vasilgerginski/filamentphp-text-extractor without Composer

Filament Text Extractor

A powerful Laravel package that seamlessly integrates with Filament Admin Panel to extract and manage translatable text from your Eloquent models. Perfect for multi-language applications, content management systems, and any project requiring dynamic text extraction and translation management.

🚀 Features

🔍 Automatic Text Extraction

• Extract translatable fields from any Eloquent model with a simple trait
• Auto-generate Laravel translation files in standard format (lang/en/model_name.php)
• Support for simple text fields, JSON structures, and rich content

✨ Translation Casts (NEW!)

• Translatable Cast: Use {{ $post->title }} instead of {{ __('blog_post.' . $post->title) }}
• JsonTranslatable Cast: Automatic translation for JSON UI components (hero sections, feature grids, etc.)
• Zero code changes required in your templates!

🎨 Filament Integration

• Beautiful admin interface built with Filament for managing extracted texts
• Filament Plugin Architecture: Automatically registers with your admin panel
• Built-in resource for managing translations

🏗️ Advanced Content Support

• Rich Text Support: Extracts text from HTML, Markdown, and rich text editor content
• JSON Field Translation: Perfect for page builders, CMS blocks, and UI components
• Nested Structure Support: Works recursively through complex JSON data

🌍 Multi-Language Ready

• Built-in support for multiple languages and locales
• Laravel Standard: Uses Laravel's translation system (__() helper)
• Smart Fallbacks: Returns original text if no translation found

⚡ Performance & Developer Experience

• Queue Support: Handle bulk text extraction asynchronously
• Live Demos: Comprehensive examples showing all features
• Well Tested: Comprehensive test suite included
• Easy Installation: Simple setup with minimal configuration

📋 Requirements

• PHP 8.1 or higher
• Laravel 10.0 or higher
• Filament 3.0 or higher

🔧 Installation

Install the package via Composer:

Register the plugin in your Panel provider (e.g., app/Providers/Filament/AdminPanelProvider.php):

Publish and run the migrations:

Optionally, publish the config file:

🎯 Quick Start

1. Add the Trait to Your Model

Add the ExtractsTranslatableText trait to any model you want to extract text from:

2. Extract Text

You can extract text from a single model instance:

Or extract from all instances of a model:

3. Use the Artisan Command

Extract text for any model using the provided Artisan command:

✨ Translation Casts (NEW!)

🎯 Translatable Cast for Simple Fields

Instead of manual translation calls, use the Translatable cast for automatic translation:

Usage in templates:

🏗️ JsonTranslatable Cast for UI Components

Perfect for page builders, CMS content blocks, and JSON-based UI components:

JSON Structure (stored in database):

Template Usage (no translation calls needed!):

Translation Results:

• English: "Welcome to Our Platform"
• Spanish: "Bienvenido a Nuestra Plataforma" (automatic!)

🧠 Smart Field Detection

The JsonTranslatable cast automatically detects and translates:

• ✅ UI Text: title, subtitle, heading, description, label, button_text
• ❌ Technical Data: type, icon, url, id, background_image (ignored)

🎭 Live Demos & Examples

Check out the examples/ directory for comprehensive demos:

• 🌍 Translation Demo: Classic __() approach
• ✨ Cast Demo: Automatic {{ $property }} translation
• 🏗️ JSON Demo: UI component translation with JsonTranslatable cast
• 📊 CLI Demo: Command-line testing and statistics

Quick demo setup:

📄 Advanced Features

Filament Builder Block Extraction

The package automatically detects and extracts text from Filament Builder JSON blocks. When you have a Builder field with blocks like:

The extractor will automatically:

• Parse the JSON structure
• Extract text from all text-based fields within blocks
• Maintain context with keys like model.field.block_type.field_name
• Skip non-text fields like images (but extract alt text!)

Rich Text Extraction

For rich text fields (TinyMCE, Trix, etc.), the package:

• Strips HTML tags to extract clean text
• Preserves meaningful content structure
• Handles nested HTML elements
• Extracts alt text from images
• Processes both plain HTML and encoded content

Example:

🎨 Filament Admin Interface

The package automatically registers a Filament resource for managing extracted texts. After installation, you'll find a new "Extracted Texts" section in your Filament admin panel with:

• List View: Browse all extracted texts with search and filters
• Edit View: Update extracted text content and metadata
• Create View: Manually add new text entries
• Dashboard: Overview of extraction statistics and recent activity

Dashboard Features

The extraction dashboard provides:

• Total number of extracted texts
• Breakdown by model type
• Language distribution
• Recent extractions
• Quick actions for bulk operations

⚙️ Configuration

The configuration file (config/filament-text-extractor.php) allows you to customize:

🔄 Field Handlers

The package includes specialized handlers for different field types:

• EmailHandler: Validates and formats email fields
• UrlHandler: Handles URL validation and formatting
• RichTextHandler: Processes HTML/rich text content, strips tags and extracts clean text
• SlugHandler: Manages URL slugs
• LongTextHandler: Optimized for large text fields
• Built-in JSON Support: Automatically detects and extracts text from Filament Builder blocks and other JSON structures

Creating Custom Field Handlers

You can create custom field handlers by extending the AbstractFieldHandler:

🌐 Auto-Generated Translation Files

The package can automatically generate Laravel translation files in your lang directory, enabling seamless localization:

Automatic Translation File Generation

When texts are extracted, the package automatically creates/updates translation files:

Using Translations in Your Models

With the generated translation files, you can easily access localized content:

Automatic Model Casting

You can even create a custom cast for automatic translation:

Translation Workflow

1. Extract: Run extraction to populate the database and generate translation files
2. Translate: Edit the generated files in lang/[locale]/ or use the Filament admin
3. Deploy: Your application automatically uses the translated values

🧪 Testing

The package includes a comprehensive test suite. Run the tests with:

For code coverage:

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

🐛 Bug Reports

If you discover any issues, please create an issue on GitHub: https://github.com/vasilGerginski/filamentphp-text-extractor/issues

📝 Changelog

Please see CHANGELOG for more information on what has changed recently.

🔒 Security

If you discover any security-related issues, please email [email protected] instead of using the issue tracker.

👏 Credits

• Vasil Gerginski
• All Contributors

📄 License

The MIT License (MIT). Please see License File for more information.

🌟 Show Your Support

If you find this package helpful, please consider giving it a star on GitHub! ⭐

Built with ❤️ by Vasil Gerginski