README

This package provides a simple way to sync your Laravel translations with Lokalise without changing anything in your translations nor in your lokalise settings. It just works!

Lokalise states, that they support Laravel translations, but out of the box this is not the case.
They do not support Laravels placeholders and also not its pluralization. In Laravel it is also common to use two translation files. Multiple PHP files per locale which contain nested keys and also one JSON file per locale which uses the base locale as key.

How does it work?

The package does a few things to give the best out-of-the-box experience.
It checks your JSON and PHP translations separately.
Dotted translation keys will get prefixed by the file name.
The translations are then processed on the fly to convert placeholders and pluralization to Lokalise compatible formats.
It then uploads the files to Lokalise.
Downloading translations works a bit different since Lokalise converts the placeholders to a non-reversible format when downloading whole files. Therefor the package makes usage of the translation keys API instead of the files API. It fetches all keys, converts the placeholders back to the Laravel format and then groups them per locale and file. Instead if just dumping the files it always merges them with the local files. Any leaf node collisions will be resolved and moved to the JSON file.

Installation

You can install the package via composer.

composer require bambamboole/laravel-lokalise

Add the following environment variables to your .env file:

LOKALISE_API_TOKEN=your-lokalise-api-token
LOKALISE_PROJECT_ID=your-lokalise-project-id

Usage

The package is still in its early development and therefor pretty opinionated and not very flexible.

To upload your translations to Lokalise you can run the following command:

php artisan lokalise:upload

To upload only specific files You can add relative file path directly behind the command

php artisan lokalise:upload lang/en.json lang/en/validation.php
# or for CI
git diff --name-only | grep lang/ | xargs php artisan lokalise:upload

The --replace flag will set replace_modified on the API to true.

You can add the --cleanup flag to remove all translations from Lokalise which are not in your project anymore. If you add it without specifying files it will also remove all keys from files which do not exist anymore

To download your translations from Lokalise you can run the following command:

php artisan lokalise:download

Testing

composer test

Contributing

Ideas/Roadmap

• Add more tests
• Support nested files
• Support multi pluralisation like 'apples' => '{0} There are none|[1,19] There are some|[20,*] There are many'
• Your idea here

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email manuel@christlieb.eu instead of using the issue tracker.

Credits

• Manuel Christlieb
• All Contributors

License

The MIT License (MIT). Please see License File for more information.