Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/keevitaja/linguist

Easy multilingual urls and redirection support for the Laravel framework
https://github.com/keevitaja/linguist

estonia i18n laravel linguist locales localization multilingual php translation

Last synced: 2 months ago
JSON representation

Easy multilingual urls and redirection support for the Laravel framework

Lists

README 

        
# Linguist - Multilingual urls and redirects for Laravel



This package provides an easy multilingual urls and redirection support for the Laravel framework. 



In short Laravel will generate localized urls for links and redirections.



```php

route('people') 

```



```

http://site.com/people

http://site.com/fr/people

```



> Linguist works perfectly well with https://github.com/tightenco/ziggy named Laravel routes for javascript package!



## Installation



Linguist is very easy to use. The locale slug is removed from the REQUEST_URI leaving the developer with the cleanest multilingual environment possible.



Install using Composer:



```bash

composer require keevitaja/linguist

```



There are several options to make Linguist work.



### Option 1: Modify the `public/index.php`



Add following line after the vendor autoloading to your projects `public/index.php` file.



```php

(new Keevitaja\Linguist\UriFixer)->fixit();

```



End result would be this:



```php

/*

|--------------------------------------------------------------------------

| Register The Auto Loader

|--------------------------------------------------------------------------

|

| Composer provides a convenient, automatically generated class loader for

| our application. We just need to utilize it! We'll simply require it

| into the script here so that we don't have to worry about manual

| loading any of our classes later on. It feels great to relax.

|

*/



require __DIR__.'/../vendor/autoload.php';



(new Keevitaja\Linguist\UriFixer)->fixit();

```



### Option 2: Use LocalizedKernel



> Note: This option works only if you have not changed your applications root namespace. Default is `App`.



In your projects `bootstrap/app.php` swap the `App\Http\Kernel` with `Keevitaja\Linguist\LocalazedKernel`:



```php

/*

|--------------------------------------------------------------------------

| Bind Important Interfaces

|--------------------------------------------------------------------------

|

| Next, we need to bind some important interfaces into the container so

| we will be able to resolve them when needed. The kernels serve the

| incoming requests to this application from both the web and CLI.

|

*/



$app->singleton(

    Illuminate\Contracts\Http\Kernel::class,

    //App\Http\Kernel::class

    Keevitaja\Linguist\LocalizedKernel::class

);

```



### Option 3: modify the `App\Http\Kernel`



> Note: This also works with custom root namespace. 



```php

fixit();



        parent::__construct($app, $router);

    }

```



### Publish config



Finally you need to publish the Linguist config to set your enabled locales and other relavant configurations. 



```

php artisan vendor:publish --provider="Keevitaja\Linguist\LinguistServiceProvider"

```



Your personal configuration file will be `config/linguist.php`.



## Usage



You can add the LocalizeUrls middleware your web middleware group as the first item to get the linguist support:



```php

/**

 * The application's route middleware groups.

 *

 * @var array

 */

protected $middlewareGroups = [

    'web' => [

        \Keevitaja\Linguist\LocalizeUrls::class,

```



> Note: This middleware has to be the first item in group!



Another option is to use Linguist in your applications service provider:



```php

class AppServiceProvider extends ServiceProvider

{

    /**

     * Bootstrap any application services.

     *

     * @return void

     */

    public function boot(\Keevitaja\Linguist\Linguist $linguist)

    {

        $linguist->localize();

    }

```



`UrlGenerator` will add the locale slug in front of the URI when needed. No extra actions needed.



```php

Route::get('people', ['as' => 'people.index', 'uses' => ''PeopleController@index'']);

```



```twig

{{ route('people.index') }} or {{ url('people') }}

```



```

http://site.com/people // default locale from linguist config

http://site.com/fr/people

http://site.com/ru/people

```



Switcher is a little helper to get the current URLs for the locale switcher.



```php

$urls = dispatch_now(new \Keevitaja\Linguist\Switcher);

```



NB! Both config and route caching are working!



## Assets



Use linguist helpers for a correct routing of assets



**Regular Assets**

 

 ```twig

 

 

 ```

 

 **Secure Assets**

 

 ```twig

 

 

```



## Queues



To make localization work in queues you need to run `Linguist->localize($theLocaleYouWant)` inside the queued item.



## Licence



MIT