Download the PHP package keypoint-solutions/laravel-localization-helpers without Composer

Laravel Localization Helpers

This branch is the current dev branch

LLH is a set of artisan commands to manage translations in your Laravel project. Key features :

• parse your code and generate lang files
• translate your sentences automatically, thanks to Microsoft Translator API
• configure output according to your code style

Table of contents

1. Installation
2. Configuration
3. Usage
4. Support
5. Contribute

1. Installation

• Choose your version according to the version compatibility matrix:

• Add the following line in the require-dev array of the composer.json file and replace the version if needed according to your Laravel version:

• Update your installation : composer update

• For Laravel, add the following line in the providers array of the config/app.php configuration file :

• For Lumen, add the following lines in the bootstrap/app.php file :

• Now execute php artisan list and you should view the new localization commands:

In Laravel, you can add the facade in the Aliases if you need to manage translations in your code :

2. Configuration

To configure your fresh installed package, please create a configuration file by executing :

Then you can modify the configuration in file :

Add new folders to search for, add your own lang methods or functions, ...

Backup files

You should not include backup lang files in GIT or other versioning systems.

In your laravel folder, add this in .gitignore file :

3. Usage

3.1 Command localization:missing

This command parses all your code and generates translations according to lang files in all lang/XXX/ directories.

Use php artisan help localization:missing for more informations about options.

Examples

Generate all lang files

Generate all lang files without prompt

Generate all lang files without backuping old files

Generate all lang files with automatic translations

Generate all lang files without keeping obsolete lemmas

Generate all lang files without any comment for new found lemmas

Generate all lang files without header comment

Generate all lang files and set new lemma values

3 commands below produce the same output:

You can customize the default generated values for unknown lemmas.

The following command let new values empty:

The following command prefixes all lemma values with "Please translate this : "

The following command set all lemma values to null to provide fallback translations to all missing values.

The following command set all lemma values to "Please translate this !"

Silent option for shell integration

Simulate all operations (do not write anything) with a dry run

Open all must-edit files at the end of the process

You can edit the editor path in your configuration file. By default, editor is Sublime Text on Mac OS X :

For PHPStorm on Mac OS X:

3.2 Command localization:find

This command will search in all your code for the argument as a lemma.

Use php artisan help localization:find for more informations about options.

Examples

Find regular lemma

Find regular lemma with verbose

Find regular lemma with short path displayed

Find lemma with a regular expression

PCRE functions are used

3.3 Command localization:clear

This command will remove all backup lang files.

Use php artisan help localization:clear for more informations about options.

Examples

Remove all backups

Remove backups older than 7 days

4. Support

Use the github issue tool to open an issue or ask for something.

5. Contribute

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Added some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request