Как создать переведенные на несколько языков маршруты в Laravel

То, что Марцин Набиалек предоставил нам в своем первоначальном ответе, является надежным решением проблемы локализации маршрута.

Мелкий Жучок:

Единственным реальным недостатком его решения является то, что мы не можем использовать кэшированные маршруты, что иногда может быть очень полезно в соответствии с Laravel's документы:

Если ваше приложение использует исключительно маршруты на основе контроллеров, вам следует воспользоваться преимуществами кэша маршрутов Laravel. С помощью кэш маршрутов значительно сократит время, необходимое для регистрации всех маршрутов вашего приложения. В некоторых случаях регистрация вашего маршрута может быть даже в 100 раз быстрее. Чтобы создать кэш маршрутов, просто выполните команду route:cache Artisan.

Почему мы не можем кэшировать наши маршруты?

Поскольку Метод Марчина Набиолека генерирует новые маршруты на основе locale_prefix динамически, их кэширование приведет к ошибке 404 при посещение любого префикса, не сохраненного в переменной locale_prefix во время кэширования.

Что мы храним?

Фундамент кажется действительно прочным, и мы можем сохранить большую его часть!

Мы, безусловно, можем сохранить различные файлы маршрутов, зависящие от локализации:

<?php

// app/lang/pl/routes.php

return array(

    'contact' => 'kontakt',
    'about'   => 'o-nas'
);

Мы также можем сохранить все переменные app/config/app.php:

/**
* Default locale 
*/
'locale' => 'pl'

/**
 * List of alternative languages (not including the one specified as 'locale')
 */
'alt_langs' => array ('en', 'fr'),

/**
 *  Prefix of selected locale  - leave empty (set in runtime)
 */
'locale_prefix' => '',

 /**
 * Let's also add a all_langs array
 */
'all_langs' => array ('en', 'fr', 'pl'),

Нам также понадобится бит кода, который проверяет сегменты маршрута. Но так как смысл этого в том, чтобы использовать кэш, нам нужно переместите его за пределы файла routes.php. Этот больше не будет использоваться, как только мы кэшируем маршруты. На данный момент мы можем переместить его в app/Providers/AppServiceProver.php, например:

public function boot(){
  /*
   *  Set up locale and locale_prefix if other language is selected
   */
   if (in_array(Request::segment(1), config('app.alt_langs'))) {
       App::setLocale(Request::segment(1));
       config([ 'app.locale_prefix' => Request::segment(1) ]);
   }
}

Не забывайте:

use Illuminate\Support\Facades\Request;
use Illuminate\Support\Facades\App;

Настройка наших маршрутов:

В нашем файле app/Http/routes.php произойдет несколько изменений.

Во-первых, мы должны создать новый массив, содержащий все alt_langs, а также значение по умолчанию locale_prefix, которое, скорее всего, будет '':

$all_langs = config('app.all_langs');

Для того, чтобы иметь возможность кэшируйте все различные префиксы языка lang с переведенными параметрами маршрута, которые нам нужны, чтобы зарегистрировать их все. Как мы можем это сделать?

*** Laravel aside 1: ***

Давайте взглянем на определение Lang::get(..):

public static function get($key, $replace = array(), $locale = null, $fallback = true){
      return \Illuminate\Translation\Translator::get($key, $replace, $locale, $fallback);
}

Третьим параметром этой функции является переменная $locale! Отлично - мы, безусловно, можем использовать это в наших интересах! Эта функция на самом деле позволяет нам выбрать, из какой локали мы хотим получить перевод!

Следующее, что мы собираемся сделать, это повторить $all_langs массив и создайте новую группу Route для каждого языкового префикса. Не только это, но мы также собираемся избавиться от цепочек where и patterns, которые нам были нужны ранее, и регистрировать маршруты только с их правильными переводами (другие будут выбрасывать 404 без необходимости проверять это больше):

/**
* Iterate over each language prefix 
*/
foreach( $all_langs as $prefix ){

   if ($prefix == 'pl') $prefix = '';

   /**
   * Register new route group with current prefix
   */
   Route::group(['prefix' => $prefix], function() use ($prefix) {

         // Now we need to make sure the default prefix points to default  lang folder.
         if ($prefix == '') $prefix = 'pl';

         /**
         * The following line will register:
         *
         * example.com/
         * example.com/en/
         */
         Route::get('/', 'MainController@getHome')->name('home');

         /**
         * The following line will register:
         *
         * example.com/kontakt
         * example.com/en/contact
         */
         Route::get(Lang::get('routes.contact',[], $prefix) , 'MainController@getContact')->name('contact');

         /**
         * “In another moment down went Alice after it, never once 
         * considering how in the world she was to get out again.”
         */
         Route::group(['prefix' => 'admin', 'middleware' => 'admin'], function () use ($prefix){

            /**
            * The following line will register:
            *
            * example.com/admin/uzivatelia
            * example.com/en/admin/users
            */
            Route::get(Lang::get('routes.admin.users',[], $prefix), 'AdminController@getUsers')
            ->name('admin-users');

         });
   });
}

/**
* There might be routes that we want to exclude from our language setup.
* For example these pesky ajax routes! Well let's just move them out of the `foreach` loop.
* I will get back to this later.
*/
Route::group(['middleware' => 'ajax', 'prefix' => 'api'], function () {
    /**
    * This will only register example.com/api/login
    */
    Route::post('login', 'AjaxController@login')->name('ajax-login');
});

Хьюстон, у нас проблема!

Как вы можете видеть, я предпочитаю использовать именованные маршруты (вероятно, большинство людей так и делают):

Route::get('/', 'MainController@getHome')->name('home');

Их можно очень легко использовать внутри ваших шаблонов лезвий:

{{route('home')}}

Но до сих пор в моем решении есть проблема: имена маршрутов переопределяют друг друга. Цикл foreach выше будет регистрировать только последние маршруты с префиксами с их именами.

Другими словами, только example.com/ будет привязан к маршруту home, поскольку locale_perfix был последним элементом в массиве $all_langs.

Мы можем обойти это, добавив к названиям маршрутов префикс языка $prefix. Например:

Route::get('/', 'MainController@getHome')->name($prefix.'_home');

Нам придется сделать это для каждого из маршруты внутри нашего цикла. Это создает еще одно небольшое препятствие.

Но мой масштабный проект почти завершен!

Ну, как вы, наверное, догадались, теперь вам нужно вернуться ко всем вашим файлам и добавить префикс к каждому вызову вспомогательной функции route с текущим locale_prefix, загруженным из конфигурации app.

Только ты этого не делаешь!

*** Laravel aside 2: ***

Давайте посмотрим, как Laravel реализует свой вспомогательный метод route.

if (! function_exists('route')) {
    /**
     * Generate a URL to a named route.
     *
     * @param  string  $name
     * @param  array   $parameters
     * @param  bool    $absolute
     * @return string
     */
    function route($name, $parameters = [], $absolute = true)
    {
        return app('url')->route($name, $parameters, $absolute);
    }
}

Как вы можете видеть Laravel сначала проверит, существует ли уже функция route. Он зарегистрирует свою функцию route только в том случае, если другой функции еще не существует!

Это означает, что мы можем очень легко обойти нашу проблему, не переписывая каждый вызов route, сделанный до сих пор в наших шаблонах Blade.

Давайте быстро создадим файл app/helpers.php.

Давайте убедимся, что Laravel загружает файл до того, как он загрузит свой helpers.php, поместив следующую строку в bootstrap/autoload.php

//Put this line here
require __DIR__ . '/../app/helpers.php';
//Right before this original line
require __DIR__.'/../vendor/autoload.php';

Все мы сейчас нужно сделать, это создать нашу собственную функцию route в нашем файле app/helpers.php. Мы будем использовать оригинальную реализацию в качестве основы:

<?php
//Same parameters and a new $lang parameter
function route($name, $parameters = [], $absolute = true, $lang = null)
{
    /*
    * Remember the ajax routes we wanted to exclude from our lang system?
    * Check if the name provided to the function is the one you want to
    * exclude. If it is we will just use the original implementation.
    **/
    if (str_contains($name, ['ajax', 'autocomplete'])){
        return app('url')->route($name, $parameters, $absolute);
    }

   //Check if $lang is valid and make a route to chosen lang
   if ( $lang && in_array($lang, config('app.alt_langs')) ){
       return app('url')->route($lang . '_' . $name, $parameters, $absolute);
   }

    /**
    * For all other routes get the current locale_prefix and prefix the name.
    */
    $locale_prefix = config('app.locale_prefix');
    if ($locale_prefix == '') $locale_prefix = 'pl';
    return app('url')->route($locale_prefix . '_' . $name, $parameters, $absolute);
}

Вот и все!

Итак, то, что мы сделали, по сути, зарегистрировало все доступные группы префиксов. Создал каждый переведенный маршрут с префиксом его имени. А затем своего рода переопределите функцию Laravel route, чтобы добавить ко всем именам маршрутов (кроме некоторых) префикс текущего locale_prefix, чтобы соответствующие URL-адреса были созданный в наших шаблонах блейдов без необходимости вводить config('app.locale_prefix') каждый раз.

О да:

php artisan route:cache

Кэширование маршрутов действительно следует выполнять только после развертывания проекта, так как, скорее всего, вы будете возиться с ними во время разработки. Но вы всегда можете очистить кэш:

php artisan route:clear

Еще раз спасибо Марцину Набиалеку за его оригинальный ответ. Это было действительно полезно для меня.