longman / laravel-multilang
Package to integrate multi language (multi locale) functionality in Laravel 5.x
Installs: 13 529
Dependents: 1
Suggesters: 1
Security: 0
Stars: 55
Watchers: 8
Forks: 15
Open Issues: 7
Requires
- php: ^8.1.0
- ext-mbstring: *
- illuminate/console: ^10.0
- illuminate/database: ^10.0
- illuminate/http: ^10.0
- illuminate/support: ^10.0
- symfony/translation: ^6.0
- symfony/yaml: ^6.0
Requires (Dev)
- longman/php-code-style: ^10.0
- mockery/mockery: ~1.3
- orchestra/testbench: ^8.5
- phpunit/phpunit: ~10.0
- dev-master
- 5.0.1
- 5.0.0
- 4.0.0
- 3.0.6
- 3.0.5
- 3.0.4
- 3.0.3
- 3.0.2
- 3.0.1
- 3.0.0
- 2.0.1
- 2.0.0
- 1.3.3
- 1.3.2
- 1.3.1
- 1.3.0
- 1.2.11
- 1.2.10
- 1.2.9
- 1.2.8
- 1.2.7
- 1.2.6
- 1.2.5
- 1.2.4
- 1.2.3
- 1.2.2
- 1.2.1
- 1.2.0
- 1.1.10
- 1.1.9
- 1.1.8
- 1.1.7
- 1.1.6
- 1.1.5
- 1.1.4
- 1.1.3
- 1.1.2
- 1.1.1
- 1.1.0
- 1.0.9
- 1.0.8
- 1.0.7
- 1.0.6
- 1.0.5
- 1.0.4
- 1.0.3
- 1.0.2
- 1.0.1
- 1.0.0
- 0.2.0
- 0.1.0
- dev-dependabot/composer/guzzlehttp/psr7-2.5.0
- dev-dependabot/composer/symfony/http-kernel-6.2.6
- dev-fix
- dev-dev
This package is auto-updated.
Last update: 2024-11-02 10:47:21 UTC
README
This version of MultiLang package requires minimum PHP 7.0. For older PHP versions use MultiLang 1.x
This is a very useful package to integrate multi language (multi locale) functionality in Laravel 5.x.
It includes a ServiceProvider to register the multilang and Middleware for automatic modification routes like http://site.com/en/your-routes
.
This package uses database for storing translations (it caches data on production environment for improving performance) Also package automatically adds in database missing keys (on the local environment only).
Table of Contents
Installation
Install this package through Composer.
Edit your project's composer.json
file to require longman/laravel-multilang
Create composer.json file:
{ "name": "yourproject/yourproject", "type": "project", "require": { "longman/laravel-multilang": "~2.0" } }
And run composer update
Or run a command in your command line:
composer require longman/laravel-multilang
In Laravel the service provider and facade will automatically get registered.
Copy the package config to your local config with the publish command:
php artisan vendor:publish --provider="Longman\LaravelMultiLang\MultiLangServiceProvider"
After run multilang migration command
php artisan multilang:migration
Its creates multilang migration file in your database/migrations folder. After you can run
php artisan migrate
Also if you want automatically change locale depending on url (like http://site.com/en/your-routes
)
you must add middleware in app/Http/Kernel.php
I suggest add multilang after CheckForMaintenanceMode middleware
protected $middleware = [ \Illuminate\Foundation\Http\Middleware\CheckForMaintenanceMode::class, \Longman\LaravelMultiLang\Middleware\MultiLang::class, ];
In your RoutesServiceProvider modify that:
MultiLang::routeGroup(function($router) { require app_path('Http/routes.php'); });
or directly in app/Http/routes.php file add multilang group:
MultiLang::routeGroup(function($router) { // your routes and route groups here });
Or if you want only translate strings without automatic resolving locale and redirect, you can manually set locale in your application like:
App::setLocale('en');
Usage
Translating
Everywhere in application you can use t()
helper function like:
$string = t('Your translatable string');
You can use markers for dynamic texts and pass any data like
$string = t('The :attribute must be a date after :date.', ['attribute' => 'Start Date', 'date' => '7 April 1986']);
which will be return The Start Date must be a date after 7 April 1986.
Blade Templates
In blade templates you can use just @t()
notation like
@t('Your translatable string')
which is equivalent to {{ t('Your translatable string') }}
URL Generation
Also you can use lang_url()
helper function for appending current lang marker in urls automatically.
$url = lang_url('users'); // which returns /en/users depending on your language (locale)
You can force locale and get localized url for current url for example.
$url = lang_url('users', [], null, 'ka'); // which returns /ka/users ignoring current locale
or
$url = lang_url('en/users', [], null, 'ka'); // also returns /ka/users
Also you use named routes via lang_route()
function
$url = lang_route('users'); // which returns en.users depending on your language (locale)
Also Request::locale()
always will return current locale.
Note: Texts will be selected after firing Laravel's LocaleUpdated
event. Therefore you should use MultiLang middleware, or manually set locale in the application.
Text Scopes
If you want group translations by some scope, in package available defining of scopes.
For example to define scope admin
in application, you should call:
app('multilang')->setScope('admin');
before setting the locale.
Note: Default scope is global
Import/Export Texts
For versioning texts with source code (git/svn) and easy management, there is possible import texts from yml file and also export in the file.
yml file format is:
- key: 'authorization' texts: en: 'Authorization' ge: 'ავტორიზაცია' - key: 'registration' texts: en: 'Registration' ge: 'რეგისტრაცია'
Run commands for possible options and more information:
php artisan help multilang:import
php artisan help multilang:export
TODO
write more tests
Troubleshooting
If you like living on the edge, please report any bugs you find on the laravel-multilang issues page.
Contributing
Pull requests are welcome. See CONTRIBUTING.md for information.
License
Please see the LICENSE included in this repository for a full copy of the MIT license, which this project is licensed under.
Credits
Full credit list in CREDITS