longman/laravel-multilang

Package to integrate multi language (multi locale) functionality in Laravel 5.x

Laravel 5.x MultiLanguage

, _(*1)

This version of MultiLang package requires minimum PHP 7.0. For older PHP versions use MultiLang 1.x, _(*2)

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., _(*3)

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)., _(*4)

Table of Contents

• Installation
• Usage
  • Translating
  • Blade Templates
  • URL Generation
  • Text Scopes
  • Import/Export Texts
• TODO
• Troubleshooting
• Contributing
• License
• Credits

Installation

Install this package through Composer., _(*5)

Edit your project's composer.json file to require longman/laravel-multilang, _(*6)

Create composer.json file:, _(*7)

{
    "name": "yourproject/yourproject",
    "type": "project",
    "require": {
        "longman/laravel-multilang": "~2.0"
    }
}

And run composer update, _(*8)

Or run a command in your command line:, _(*9)

composer require longman/laravel-multilang

In Laravel the service provider and facade will automatically get registered., _(*10)

Copy the package config to your local config with the publish command:, _(*11)

php artisan vendor:publish --provider="Longman\LaravelMultiLang\MultiLangServiceProvider"

After run multilang migration command, _(*12)

php artisan multilang:migration

Its creates multilang migration file in your database/migrations folder. After you can run, _(*13)

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, _(*14)

I suggest add multilang after CheckForMaintenanceMode middleware, _(*15)

protected $middleware = [
    \Illuminate\Foundation\Http\Middleware\CheckForMaintenanceMode::class,
    \Longman\LaravelMultiLang\Middleware\MultiLang::class,
];

In your RoutesServiceProvider modify that:, _(*16)

MultiLang::routeGroup(function($router) {
    require app_path('Http/routes.php');
});

or directly in app/Http/routes.php file add multilang group:, _(*17)

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:, _(*18)

App::setLocale('en');

Usage

Translating

Everywhere in application you can use t() helper function like:, _(*19)

$string = t('Your translatable string');

You can use markers for dynamic texts and pass any data like, _(*20)

$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., _(*21)

Blade Templates

In blade templates you can use just @t() notation like, _(*22)

@t('Your translatable string')

which is equivalent to {{ t('Your translatable string') }}, _(*23)

URL Generation

Also you can use lang_url() helper function for appending current lang marker in urls automatically., _(*24)

$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., _(*25)

$url = lang_url('users', [], null, 'ka'); // which returns /ka/users ignoring current locale

or, _(*26)

$url = lang_url('en/users', [], null, 'ka'); // also returns /ka/users

Also you use named routes via lang_route() function, _(*27)

$url = lang_route('users'); // which returns en.users depending on your language (locale)

Also Request::locale() always will return current locale., _(*28)

Note: Texts will be selected after firing Laravel's LocaleUpdated event. Therefore you should use MultiLang middleware, or manually set locale in the application., _(*29)

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:, _(*30)

app('multilang')->setScope('admin');

before setting the locale., _(*31)

Note: Default scope is global, _(*32)

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., _(*33)

yml file format is:, _(*34)

-
  key: 'authorization'
  texts:
    en: 'Authorization'
    ge: 'ავტორიზაცია'
-
  key: 'registration'
  texts:
    en: 'Registration'
    ge: 'რეგისტრაცია'

Run commands for possible options and more information:, _(*35)

php artisan help multilang:import

php artisan help multilang:export

TODO

write more tests, _(*36)

Troubleshooting

If you like living on the edge, please report any bugs you find on the laravel-multilang issues page., _(*37)

Contributing

Pull requests are welcome. See CONTRIBUTING.md for information., _(*38)

License

Please see the LICENSE included in this repository for a full copy of the MIT license, which this project is licensed under., _(*39)

Credits

• Avtandil Kikabidze aka LONGMAN

Full credit list in CREDITS, _(*40)