library laravel-translation-manager

xodock/laravel-translation-manager

Manage Laravel Translations

Laravel 5 Translation Manager

For Laravel 4, please use the 0.1 branch!

This is a package to manage Laravel translation files. It does not replace the Translation system, only import/export the php files to a database and make them editable through a webinterface. The workflow would be:, _(*1)

- Import translations: Read all translation files and save them in the database
- Find all translations in php/twig sources
- Optionally: Listen to missing translation with the custom Translator
- Translate all keys through the webinterface
- Export: Write all translations back to the translation files.

This way, translations can be saved in git history and no overhead is introduced in production., _(*2)

, _(*3)

Installation

Require this package in your composer.json and run composer update (or run composer require barryvdh/laravel-translation-manager directly):, _(*4)

"barryvdh/laravel-translation-manager": "0.2.x"

After updating composer, add the ServiceProvider to the providers array in config/app.php, _(*5)

'Barryvdh\TranslationManager\ManagerServiceProvider',

You need to run the migrations for this package., _(*6)

$ php artisan vendor:publish --provider="Barryvdh\TranslationManager\ManagerServiceProvider" --tag=migrations
$ php artisan migrate

You need to publish the config file for this package. This will add the file config/translation-manager.php, where you can configure this package., _(*7)

$ php artisan vendor:publish --provider="Barryvdh\TranslationManager\ManagerServiceProvider" --tag=config

In order to edit the default template, the views must be published as well. The views will then be placed in resources/views/vendor/translation-manager., _(*8)

$ php artisan vendor:publish --provider="Barryvdh\TranslationManager\ManagerServiceProvider" --tag=views

Routes are added in the ServiceProvider. You can set the group parameters for the routes in the configuration. You can change the prefix or filter/middleware for the routes. If you want full customisation, you can extend the ServiceProvider and override the map() function., _(*9)

This example will make the translation manager available at http://yourdomain.com/translations, _(*10)

Laravel >= 5.2

The configuration file by default only includes the auth middleware, but the latests changes in Laravel 5.2 makes it that session variables are only accessible when your route includes the web middleware. In order to make this package work on Laravel 5.2, you will have to change the route/middleware setting from the default, _(*11)

    'route' => [
        'prefix' => 'translations',
        'middleware' => 'auth',
    ],

to, _(*12)

    'route' => [
        'prefix' => 'translations',
        'middleware' => [
            'web',
            'auth',
        ],
    ],

NOTE: This is only needed in Laravel 5.2 (and up!), _(*13)

Usage

Web interface

When you have imported your translation (via buttons or command), you can view them in the webinterface (on the url you defined with the controller). You can click on a translation and an edit field will popup. Just click save and it is saved :) When a translation is not yet created in a different locale, you can also just edit it to create it., _(*14)

Using the buttons on the webinterface, you can import/export the translations. For publishing translations, make sure your application can write to the language directory., _(*15)

You can also use the commands below., _(*16)

Import command

The import command will search through app/lang and load all strings in the database, so you can easily manage them., _(*17)

$ php artisan translations:import

Translation strings from app/lang/locale.json files will be imported to the __json_ group., _(*18)

Note: By default, only new strings are added. Translations already in the DB are kept the same. If you want to replace all values with the ones from the files, add the --replace (or -R) option: php artisan translations:import --replace, _(*19)

Find translations in source

The Find command/button will look search for all php/twig files in the app directory, to see if they contain translation functions, and will try to extract the group/item names. The found keys will be added to the database, so they can be easily translated. This can be done through the webinterface, or via an Artisan command., _(*20)

$ php artisan translations:find

If your project uses translation strings as keys, these will be stored into then __json_ group., _(*21)

Export command

The export command will write the contents of the database back to app/lang php files. This will overwrite existing translations and remove all comments, so make sure to backup your data before using. Supply the group name to define which groups you want to publish., _(*22)

$ php artisan translations:export <group>

For example, php artisan translations:export reminders when you have 2 locales (en/nl), will write to app/lang/en/reminders.php and app/lang/nl/reminders.php, _(*23)

To export translation strings as keys to JSON files , use the --json (or -J) option: php artisan translations:import --json. This will import every entries from the __json_ group., _(*24)

Clean command

The clean command will search for all translation that are NULL and delete them, so your interface is a bit cleaner. Note: empty translations are never exported., _(*25)

$ php artisan translations:clean

Reset command

The reset command simply clears all translation in the database, so you can start fresh (by a new import). Make sure to export your work if needed before doing this., _(*26)

$ php artisan translations:reset

Detect missing translations

Most translations can be found by using the Find command (see above), but in case you have dynamic keys (variables/automatic forms etc), it can be helpful to 'listen' to the missing translations. To detect missing translations, we can swap the Laravel TranslationServicepProvider with a custom provider. In your config/app.php, comment out the original TranslationServiceProvider and add the one from this package:, _(*27)

//'Illuminate\Translation\TranslationServiceProvider',
'Barryvdh\TranslationManager\TranslationServiceProvider',

This will extend the Translator and will create a new database entry, whenever a key is not found, so you have to visit the pages that use them. This way it shows up in the webinterface and can be edited and later exported. You shouldn't use this in production, just in production to translate your views, then just switch back., _(*28)

TODO

This package is still very alpha. Few thinks that are on the todo-list:, _(*29)

- Add locales/groups via webinterface
- Improve webinterface (more selection/filtering, behavior of popup after save etc)
- Seed existing languages (https://github.com/caouecs/Laravel-lang)
- Suggestions are welcome :)