README

🌐 Laravel Translate

Professional Multi-Source Translation Package for Laravel 11+

Transform your Laravel application into a multilingual powerhouse with zero API costs!
Automatic fallback • Smart caching • Batch translation • Analytics dashboard • Offline support

Installation • Quick Start • Features • Documentation • Support

✨ Why Laravel Translate?

🎯 Zero API Costs - Use completely free translation services (no API key needed!)
⚡ Lightning Fast - Smart caching reduces API calls by 90%+
🔄 Bulletproof - Automatic fallback across 5 translation services
🎨 Developer Friendly - Blade directives, helpers, facades, CLI
📊 Production Ready - Built-in analytics and performance monitoring
🌍 Truly Multilingual - Support 100+ languages out of the box
🔌 Offline Capable - Works without internet using Argos
🚀 SaaS Ready - Perfect for multi-tenant applications

🎁 Features

🔥 Core Features

✅ 5 Free Translation APIs
- Lingva Translate (Default - No API Key)
- Google Free (No API Key)
- MyMemory (No API Key)
- LibreTranslate (Free tier available)
- Argos (Offline)
✅ Auto Language Detection
✅ Intelligent Fallback Chain
✅ Batch Translation
✅ Smart Caching System

🛠️ Developer Tools

✅ 5 Powerful CLI Commands
✅ Blade Directives
✅ Helper Functions
✅ Facade Support
✅ Auto-Locale Middleware
✅ Queue Integration
✅ Analytics Dashboard
✅ Translation Logging
✅ Service Testing Tool

📦 Installation

Step 1: Install via Composer

composer require subhashladumor1/laravel-translate

Step 2: Publish Configuration (Optional)

php artisan vendor:publish --tag=translate-config

Step 3: Configure (Optional)

Add to your .env file:

# Default service (works without API key)
TRANSLATE_DEFAULT_SERVICE=lingva

# Enable caching for better performance
TRANSLATE_CACHE_ENABLED=true
TRANSLATE_CACHE_DRIVER=redis
TRANSLATE_CACHE_TTL=86400

# Optional: Enable LibreTranslate with API key
# Get free key at https://portal.libretranslate.com
TRANSLATE_LIBRE_ENABLED=false
TRANSLATE_LIBRE_API_KEY=your-api-key-here

That's it! 🎉 The package works out-of-the-box with 3 services (Lingva, Google, MyMemory) - no API key required!

🚀 Quick Start

💡 Translate in 3 Ways

1️⃣ Using Helper Function

// Simple translation
echo translateText('Hello World', 'es');
// Output: Hola Mundo

// With auto-detection
echo translate('Bonjour', 'en');
// Output: Hello

2️⃣ Using Facade

use Subhashladumor1\Translate\Facades\Translate;

$translation = Translate::translate('Good morning', 'fr');
// Output: Bonjour

3️⃣ In Blade Templates

<!-- Simple translation -->
<h1>@translate('Welcome to our site', 'es')</h1>

<!-- Block translation -->
@translateStart('de')
    This entire block will be translated to German.
    Multiple sentences are supported!
@translateEnd

<!-- Dynamic locale -->
<p>{{ translateText('Thank you', app()->getLocale()) }}</p>

📖 Complete Documentation

🎯 Basic Usage

Translate Text

// Basic translation
$spanish = Translate::translate('Hello', 'es');

// Specify source language
$french = Translate::translate('Hello', 'fr', 'en');

// Auto-detect source
$result = Translate::translate('Hola', 'en', 'auto');

Detect Language

$lang = Translate::detectLanguage('Bonjour le monde');
// Returns: 'fr'

// In Blade
<span>Language: @detectLang($userText)</span>

Batch Translation

$texts = ['Hello', 'Goodbye', 'Thank you'];
$translations = Translate::translateBatch($texts, 'it');
// Returns: ['Ciao', 'Arrivederci', 'Grazie']

// Translate arrays
$data = [
    'title' => 'Welcome',
    'message' => 'Hello World',
    'items' => ['One', 'Two', 'Three']
];

$translated = app('translator')->translateArray($data, 'es');

🎨 Blade Directives

@translate Directive

<!-- Simple usage -->
<h1>@translate('Hello', 'es')</h1>

<!-- With variables -->
<p>@translate($product->name, $userLanguage)</p>

<!-- Navigation example -->
<nav>
    <a href="/">@translate('Home', app()->getLocale())</a>
    <a href="/about">@translate('About Us', app()->getLocale())</a>
    <a href="/contact">@translate('Contact', app()->getLocale())</a>
</nav>

Block Translation

@translateStart('fr')
    We offer the best services in the industry.
    Our team is dedicated to providing excellent customer support.
    Contact us today to learn more about our offerings!
@translateEnd

Forms with Translation

<form>
    <label>@translate('Full Name', $locale)</label>
    <input type="text" placeholder="@translate('Enter your name', $locale)">
    
    <label>@translate('Email Address', $locale)</label>
    <input type="email" placeholder="@translate('your@email.com', $locale)">
    
    <button>@translate('Submit', $locale)</button>
</form>

🔧 CLI Commands

1. Test Services

# Test all translation services
php artisan translate:test

# Test specific service
php artisan translate:test --service=lingva

# Custom text and language
php artisan translate:test --text="Good morning" --target=fr

This command helps you:

✅ Verify which services are working
✅ Check API response times
✅ Diagnose connection issues
✅ See translation quality

2. Translate String

# Basic usage
php artisan translate:string "Hello World" es
# Output: Hola Mundo

# Specify source language
php artisan translate:string "Bonjour" en --source=fr
# Output: Hello

3. Translate Files

# Translate Laravel language file
php artisan translate:file resources/lang/en/messages.php es

# Custom output path
php artisan translate:file resources/lang/en/auth.php fr --output=lang/fr/auth.php

# Export as JSON
php artisan translate:file resources/lang/en/validation.php de --format=json

4. Sync Translations

# Sync to multiple languages
php artisan translate:sync --source=en --target=es,fr,de

# Force overwrite existing translations
php artisan translate:sync --source=en --target=es --force

# Custom language directory
php artisan translate:sync --source=en --target=fr --path=lang

5. Clear Cache

# Clear translation cache
php artisan translate:clear-cache

# Also clear analytics
php artisan translate:clear-cache --analytics

🎯 Advanced Features

Middleware - Auto Locale Detection

// In bootstrap/app.php (Laravel 11)
->withMiddleware(function (Middleware $middleware) {
    $middleware->alias([
        'detect.locale' => \Subhashladumor1\Translate\Http\Middleware\DetectLocale::class,
    ]);
})

Apply to routes:

Route::middleware(['detect.locale'])->group(function () {
    Route::get('/', [HomeController::class, 'index']);
    Route::get('/products', [ProductController::class, 'index']);
});

The middleware automatically detects locale from:

URL query parameter (?lang=es)
User session
Authenticated user's language preference
Browser Accept-Language header
GeoIP (optional)

Queue Integration

For large translation jobs:

use Illuminate\Support\Facades\Queue;

Queue::push(function() {
    $products = Product::all();
    
    foreach ($products as $product) {
        $translations = Translate::translateBatch([
            $product->name,
            $product->description
        ], 'es');
        
        // Save translations...
    }
});

Configure queue settings in config/translate.php:

'queue' => [
    'enabled' => true,
    'connection' => 'redis',
    'queue' => 'translations',
],

📊 Analytics Dashboard

Access the beautiful analytics dashboard:

http://your-app.test/translate/dashboard

Monitor:

📈 Cache hit/miss rates
⚡ API latency per service
📝 Recent translation logs
🎯 Service performance comparison
💾 Storage efficiency

Protect the dashboard (recommended):

// In routes/web.php or RouteServiceProvider
Route::middleware(['web', 'auth', 'can:view-analytics'])->group(function () {
    Route::get('/translate/dashboard', [\Subhashladumor1\Translate\Http\Controllers\DashboardController::class, 'index']);
});

⚙️ Configuration

Service Configuration

Edit config/translate.php:

return [
    // Default translation service (no API key required)
    'default_service' => env('TRANSLATE_DEFAULT_SERVICE', 'lingva'),
    
    // Fallback chain - tries services in order
    // Services without API key requirements are prioritized
    'fallback_chain' => ['lingva', 'google', 'mymemory', 'libre'],
    
    // Default languages
    'source_lang' => env('TRANSLATE_SOURCE_LANG', 'auto'),
    'target_lang' => env('TRANSLATE_TARGET_LANG', 'en'),
    'fallback_lang' => env('TRANSLATE_FALLBACK_LANG', 'en'),
    
    // Cache configuration
    'cache' => [
        'enabled' => env('TRANSLATE_CACHE_ENABLED', true),
        'driver' => env('TRANSLATE_CACHE_DRIVER', 'file'), // file, redis, database
        'ttl' => env('TRANSLATE_CACHE_TTL', 86400), // 24 hours
        'prefix' => 'translate',
        'auto_invalidate' => true,
    ],
    
    // Service endpoints
    'services' => [
        'libre' => [
            'enabled' => env('TRANSLATE_LIBRE_ENABLED', false), // Requires API key
            'endpoint' => 'https://libretranslate.com',
            'api_key' => env('TRANSLATE_LIBRE_API_KEY', null), // Get free key at https://portal.libretranslate.com
            'timeout' => 15,
        ],
        'lingva' => [
            'enabled' => env('TRANSLATE_LINGVA_ENABLED', true), // No API key needed
            'endpoint' => 'https://lingva.ml',
            'timeout' => 15,
        ],
        'google' => [
            'enabled' => env('TRANSLATE_GOOGLE_ENABLED', true), // No API key needed
            'endpoint' => 'https://translate.googleapis.com',
            'timeout' => 15,
        ],
        'mymemory' => [
            'enabled' => env('TRANSLATE_MYMEMORY_ENABLED', true), // No API key needed
            'endpoint' => 'https://api.mymemory.translated.net',
            'email' => env('TRANSLATE_MYMEMORY_EMAIL', null), // Optional for higher limits
            'timeout' => 15,
        ],
        // ... more services
    ],
    
    // Analytics
    'analytics' => [
        'enabled' => env('TRANSLATE_ANALYTICS_ENABLED', true),
        'track_cache_hits' => true,
        'track_api_latency' => true,
        'log_translations' => env('TRANSLATE_LOG_TRANSLATIONS', false),
        'retention_days' => 30,
    ],
];

Cache Drivers

For Production (Redis - Recommended):

TRANSLATE_CACHE_DRIVER=redis
REDIS_HOST=127.0.0.1
REDIS_PORT=6379

For Development (File):

TRANSLATE_CACHE_DRIVER=file

For Database:

php artisan cache:table
php artisan migrate

TRANSLATE_CACHE_DRIVER=database

🌍 Supported Translation Services

Service	Speed	Quality	API Key	Offline	Rate Limit	Status
🟢 Lingva	⚡⚡⚡⚡	⭐⭐⭐⭐	❌ No	❌	Generous	✅ Default
🟢 Google Free	⚡⚡⚡⚡⚡	⭐⭐⭐⭐⭐	❌ No	❌	Good	✅ Active
🟡 MyMemory	⚡⚡	⭐⭐⭐	❌ No	❌	1000/day	✅ Active
🟡 LibreTranslate	⚡⚡⚡	⭐⭐⭐⭐	⚠️ Required	❌	100K/mo free	⚙️ Optional
🟢 Argos	⚡⚡⚡	⭐⭐⭐	❌ No	✅	Unlimited	⚙️ Optional

Legend: ⚡ = Fast | ⭐ = Quality Rating

Important Notes:

Lingva, Google, MyMemory: Work out-of-the-box, no API key required
LibreTranslate: Now requires free API key from portal.libretranslate.com
Argos: Self-hosted, offline translation (requires installation)

🔑 LibreTranslate API Key Setup (Optional)

LibreTranslate now requires an API key. Get one for FREE (100,000 characters/month):

Step 1: Get Free API Key

Visit https://portal.libretranslate.com
Sign up (no credit card required)
Get your API key from dashboard

Step 2: Configure Laravel

Add to .env:

TRANSLATE_LIBRE_ENABLED=true
TRANSLATE_LIBRE_API_KEY=your-api-key-here

Step 3: Test

php artisan translate:test --service=libre

Alternative: Self-Host LibreTranslate

# Run locally with Docker (no API key needed)
docker run -d -p 5000:5000 libretranslate/libretranslate

Then configure:

TRANSLATE_LIBRE_ENABLED=true
TRANSLATE_LIBRE_ENDPOINT=http://localhost:5000
# No API key needed for self-hosted

🔌 Offline Translation (Argos)

Setup Argos Translate for offline use:

Install Argos:

pip install argostranslate

Run Argos server:

argos-translate --host 0.0.0.0 --port 5000

Enable in config:

'services' => [
    'argos' => [
        'enabled' => true,
        'endpoint' => 'http://localhost:5000',
    ],
],

Perfect for:

Air-gapped environments
Privacy-sensitive applications
No internet dependency
Unlimited translations

💼 Real-World Examples

E-commerce Product Translation

namespace App\Http\Controllers;

use App\Models\Product;
use Subhashladumor1\Translate\Facades\Translate;

class ProductController extends Controller
{
    public function translateProducts()
    {
        $products = Product::all();
        $targetLanguages = ['es', 'fr', 'de', 'it'];
        
        foreach ($products as $product) {
            foreach ($targetLanguages as $lang) {
                ProductTranslation::updateOrCreate([
                    'product_id' => $product->id,
                    'language' => $lang,
                ], [
                    'name' => translateText($product->name, $lang),
                    'description' => translateText($product->description, $lang),
                    'features' => translate_array($product->features, $lang),
                ]);
            }
        }
        
        return response()->json(['message' => 'Products translated!']);
    }
}

Multi-Language Blog

<!-- resources/views/blog/post.blade.php -->
<article>
    <h1>{{ translateText($post->title, app()->getLocale()) }}</h1>
    
    <div class="meta">
        <span>{{ translateText('Published on', app()->getLocale()) }}: {{ $post->published_at }}</span>
        <span>{{ translateText('By', app()->getLocale()) }} {{ $post->author }}</span>
    </div>
    
    <div class="content">
        @translateStart(app()->getLocale())
            {!! $post->content !!}
        @translateEnd
    </div>
    
    <div class="tags">
        <strong>{{ translateText('Tags', app()->getLocale()) }}:</strong>
        @foreach($post->tags as $tag)
            <span class="tag">{{ translateText($tag, app()->getLocale()) }}</span>
        @endforeach
    </div>
</article>

Dynamic Contact Form

public function sendContactForm(Request $request)
{
    $userLang = $request->user()->preferred_language ?? 'en';
    
    // Send confirmation in user's language
    $confirmationMessage = translateText(
        'Thank you for contacting us! We will respond within 24 hours.',
        $userLang
    );
    
    // Send notification to admin in default language
    $adminNotification = translateText(
        'New contact form submission from {name}',
        config('app.locale')
    );
    
    return response()->json([
        'message' => $confirmationMessage
    ]);
}

Automated Language File Sync

// app/Console/Kernel.php
protected function schedule(Schedule $schedule)
{
    // Auto-sync translations daily at 2 AM
    $schedule->command('translate:sync --source=en --target=es,fr,de')
             ->dailyAt('02:00')
             ->emailOutputOnFailure('admin@example.com');
    
    // Clear old cache weekly
    $schedule->command('translate:clear-cache')
             ->weekly()
             ->sundays()
             ->at('03:00');
}

🎓 API Reference

Facade Methods

`Translate::translate()`

Translate::translate(string $text, ?string $targetLang = null, string $sourceLang = 'auto'): string

Translates text to the target language.

`Translate::translateBatch()`

Translate::translateBatch(array $texts, ?string $targetLang = null, string $sourceLang = 'auto'): array

Translates multiple texts at once.

`Translate::detectLanguage()`

Translate::detectLanguage(string $text): string

Detects the language of given text.

`Translate::clearCache()`

Translate::clearCache(): void

Clears all translation cache.

`Translate::getAnalytics()`

Translate::getAnalytics(): array

Returns analytics data including cache stats and latency.

Helper Functions

Function	Description	Example
`translateText()`	Translate text	`translateText('Hello', 'es')`
`translate()`	Full translation	`translate('Hello', 'fr')`
`translate_batch()`	Batch translate	`translate_batch(['Hi', 'Bye'], 'de')`
`detect_language()`	Detect language	`detect_language('Bonjour')`
`translate_array()`	Array translation	`translate_array($data, 'es')`

Blade Directives

Directive	Usage	Example
`@translate`	Inline translation	`@translate('Welcome', 'es')`
`@translateStart/@translateEnd`	Block translation	`@translateStart('fr') ... @translateEnd`
`@detectLang`	Detect language	`@detectLang($text)`

Artisan Commands

Command	Description
`translate:test`	Test all translation services
`translate:string {text} {target}`	Translate a string
`translate:file {source} {target}`	Translate entire file
`translate:sync --source=en --target=es,fr`	Sync translations
`translate:clear-cache`	Clear cache

🎯 Supported Languages

100+ languages supported including:

ar Arabic • bn Bengali • zh Chinese • cs Czech • da Danish • nl Dutch • en English • fi Finnish • fr French • de German • el Greek • he Hebrew • hi Hindi • hu Hungarian • id Indonesian • it Italian • ja Japanese • ko Korean • ms Malay • no Norwegian • pl Polish • pt Portuguese • ro Romanian • ru Russian • es Spanish • sv Swedish • th Thai • tr Turkish • uk Ukrainian • ur Urdu • vi Vietnamese

And many more! Check service documentation for complete list.

📊 Performance & Benchmarks

Translation Speed

Operation	Without Cache	With Cache	Improvement
Single Translation	~150ms	~1ms	150x faster
Batch (50 items)	~3000ms	~50ms	60x faster
File Translation	~5000ms	~100ms	50x faster

Cache Hit Rates

In production environments with proper caching:

📈 Average cache hit rate: 85-95%
⚡ Average response time: 2-5ms
💾 Storage overhead: Minimal

🛡️ Security

Best Practices

// ✅ GOOD - Sanitize input
$cleanText = strip_tags($userInput);
$translation = Translate::translate($cleanText, 'es');

// ❌ BAD - Direct user input
$translation = Translate::translate($_POST['text'], 'es');

// ✅ GOOD - Rate limiting
use Illuminate\Support\Facades\RateLimiter;

if (RateLimiter::tooManyAttempts('translate:'.$request->ip(), 60)) {
    abort(429);
}

Data Privacy

⚠️ Text is sent to third-party APIs
✅ No data stored on our servers
✅ HTTPS encryption for all requests
✅ Use Argos for sensitive data (offline)
✅ Cache can be encrypted

🤝 Contributing

We welcome contributions! Please see CONTRIBUTING.md for details.

Quick Contribution Steps

Fork the repository
Create your feature branch (git checkout -b feature/amazing-feature)
Write tests for your changes
Commit your changes (git commit -m 'Add amazing feature')
Push to the branch (git push origin feature/amazing-feature)
Open a Pull Request

🆘 Troubleshooting

LibreTranslate API Key Error?

If you see: "Visit https://portal.libretranslate.com to get an API key"

Solution 1: Use services that don't require API key (Default)

# Package now uses Lingva by default (no API key needed)
php artisan translate:test
# Should show Lingva, Google, MyMemory working

Solution 2: Get free LibreTranslate API key

Visit https://portal.libretranslate.com
Sign up (100,000 characters/month FREE)
Add to .env:

TRANSLATE_LIBRE_ENABLED=true
TRANSLATE_LIBRE_API_KEY=your-api-key-here

Solution 3: Self-host LibreTranslate

docker run -d -p 5000:5000 libretranslate/libretranslate

TRANSLATE_LIBRE_ENDPOINT=http://localhost:5000

Translations not working?

Test services: php artisan translate:test
Check internet connectivity
Verify services are enabled in config
Clear cache: php artisan translate:clear-cache
Check logs: storage/logs/laravel.log

Cache not working?

php artisan config:clear
php artisan cache:clear
php artisan translate:clear-cache

Dashboard not accessible?

Make sure routes are loaded and middleware is not blocking access.

Need Help?

📖 Read the documentation above
🐛 Report bugs
💬 Ask questions
📧 Email: subhashladumor1@gmail.com

📜 License

This package is open-sourced software licensed under the MIT license.

💖 Credits

Author: Subhash Ladumor
Translation APIs: LibreTranslate, Lingva, MyMemory, Google, Argos
Community: All our amazing contributors

⭐ Show Your Support

If you find this package helpful, please consider:

⭐ Starring the repository
🐦 Sharing on social media
📝 Writing a blog post
💬 Telling your friends

🌟 Made with ❤️ for the Laravel Community

Documentation • Examples • Contributing • License

Ready to make your Laravel app multilingual? Install now and start translating! 🚀

composer require subhashladumor1/laravel-translate

subhashladumor1/laravel-translate

包简介

关键字：

README 文档