README

Laravel Gettext is a package compatible with the great Laravel PHP Framework. It provides a simple way to add localization support to Laravel applications. It is designed to work with GNU gettext and Poedit. Former versions of this package (before 4.x) works with the native php-gettext module. Current versions uses the Symfony translation package by default instead of native php extension.

Latest Laravel 7 stable release (7.3.0)

Note: This documentation applies to laravel 5.5.x and up. For older versions of laravel check the following links:

Older versions

Latest Laravel 6 stable release (7.2.0)

Latest Laravel 5.6.x & 5.7.x stable release (7.1.0)

Latest Laravel 5.5.x stable release (6.1.0)

Latest Laravel 5.4.x stable release (5.0.2)

Latest Laravel 5.3.x stable release (4.0.4)

Latest Laravel 5.2.x stable release (3.1.0)

Latest Laravel 5.1.x stable release (3.0.3)

Latest Laravel 5.0 stable release (2.0.3)

Latest Laravel 4.x stable release (1.0.3)

Development master Unstable, only for development (dev-master)

1. Requirements

1.1 Optional

1.1.1 APCU

APCU extension installed - http://php.net/manual/en/book.apcu.php

If the APCU php extension is installed, the library will use the memory to cache the loaded translation to avoid having to parse the translation file (mo/po) at each request.

The cache is automatically invalidated when there is a change in the translation file.

1.1.2 gettext

Optional requirements if you want to use the native php-gettext extension:

php-gettext - http://www.php.net/manual/en/book.gettext.php
GNU gettext on system (and production server!) - https://www.gnu.org/software/gettext/

You will need to update the 'handler' option to 'gettext' in order to use the native php-gettext module.

2. Install

Add the composer repository to your composer.json file:

    "deepskylog/laravel-gettext": "7.x"

And run composer update. Once it's installed, laravel will discover automatically the provider and load it. (Only for 5.5)

Now you need to publish the configuration file in order to set your own application values:

    php artisan vendor:publish

This command creates the package configuration file in: config/laravel-gettext.php.

You also need to register the LaravelGettext middleware in the app/Http/Kernel.php file:

    protected $middlewareGroups = [
        'web' => [
            // ...
            \deepskylog\LaravelGettext\Middleware\GettextMiddleware::class,
        ],
        // ...
    ]

Be sure to add the line after Illuminate\Session\Middleware\StartSession, otherwise the locale won't be saved into the session.

3. Configuration

At this time your application has full gettext support. Now you need to set some configuration values in config/laravel-gettext.php.

    /**
     * Default locale: this will be the default for your application all
     * localized strings. Is to be supposed that all strings are written
     * on this language.
     */
    'locale' => 'es_ES',

    /**
     * Supported locales: An array containing all allowed languages
     */
    'supported-locales' => array(
        'es_ES',
        'en_US',
        'it_IT',
        'es_AR',
    ),

    /**
     * Default charset encoding.
     */
    'encoding' => 'UTF-8',

Ok, now it's configured. It's time to generate the directory structure and translation files for the first time.

Make sure you have write permissions on resources/ before you run this command

    php artisan gettext:create

With this command the needed directories and files are created on resources/lang/i18n

4. Workflow

A. Write strings :D

By default LaravelGettext looks on app/Http/Controllers and resources/views recursively searching for translations. Translations are all texts printed with the _i() function. Let's look a simple view example:

    // an example view file
    echo 'Non translated string';
    echo _i('Translated string');
    echo _i('Another translated string');
    // with parameter
    $str = 'parameter';
    $n = 2;
    echo _i('Translated string with %s', $str);
    echo _i('%dnd translated string with %s', [$n, $str]);

    // an example view in blade
    {{ _i('Translated string') }}

Poedit doesn't "understand" blade syntax. When using blade views you must run php artisan gettext:update in order to compile all blade views to plain php before update the translations in Poedit

B. Plural strings

The plural translations follow the same pattern above. Plural translations are all texts printed with the _n() function, and it follow the php ngettext. Let's look a simple view example:

    // an example view file
    $n = 2;
    echo ($n > 1) ? 'Non translated plural string' : 'Non translated string';
    echo _n('Translated string', 'Translated plural string', $n);
    // with parameter
    $str = 'parameter';
    echo _n('Translated string %s', 'Translated plural string %s', 2, $str);

    // an example view in blade
    {{ _n('Translated string', 'Translated plural string', $n) }}

The Poedit keywords are defined in configuration file with this default pattern:

    ['_n:1,2', 'ngettext:1,2']

See Plural forms used by Poedit to configure for your language.

With Symfony

If you're using Symfony as your translation backend, you have access to their plurals syntax with the _s method. In Poedit it will be considered as a single line instead of a plural.

    // an example view file
    $n = 2;
    echo ($n > 1) ? 'Non translated plural string' : 'Non translated string';
    echo _s('Translated string|Translated plural string', $n);
    // with parameter
    $str = 'parameter';
    echo _n('Translated string %s|Translated plural string %s', 2, $str);

With symfony complex syntax:

    echo _s('{0} There are no apples|{1} There is one apple|]1,Inf[ There are %count% apples', $n);
    // with parameter
    $str = 'red';
    echo _s('{0} There are no %s apples|{1} There is one %s apple|]1,Inf[ There are %count% %s apples', 2, $str);

C. Translate with Poedit

Open the PO file for the language that you want to translate with Poedit. The PO files are located by default in resources/lang/i18n/[locale]/LC_MESSAGES/[domain].po. If you have multiple gettext domains, one file is generated by each domain.

Once Poedit is loaded press the Update button to load all localized strings. You can repeat this step anytime you add a new localized string.

Fill translation fields in Poedit and save the file. The first time that you do this the MO files will be generated for each locale.

C. Runtime methods

To change configuration on runtime you have these methods:

    /**
     * Sets the Current locale.
     * Example param value: 'es_ES'
     *
     * @param mixed $locale the locale
     * @return LaravelGettext
     */
    LaravelGettext::setLocale($locale);

    /**
     * Gets the Current locale.
     * Example returned value: 'es_ES'
     *
     * @return String
     */
     LaravelGettext::getLocale();

    /**
     * Gets the language portion of the locale.
     * Eg from en_GB, returns en
     *
     * @return mixed
     */
    LaravelGettext::getLocaleLanguage()

    /**
     * Sets the Current encoding.
     * Example param value: 'UTF-8'
     *
     * @param mixed $encoding the encoding
     * @return LaravelGettext
     */
     LaravelGettext::setEncoding($encoding);

    /**
     * Gets the Current encoding.
     * Example returned value: 'UTF-8'
     *
     * @return String
     */
     LaravelGettext::getEncoding();

    /**
     * Sets the current domain
     *
     * @param String $domain
     */
    LaravelGettext::setDomain($domain);

    /**
     * Returns the current domain
     *
     * @return String
     */
    LaravelGettext::getDomain();

    /**
     * Returns the language selector object
     *
     * @param  Array $labels
     * @return LanguageSelector
     */
    LaravelGettext::getSelector($labels = []);

5. Features and examples:

A. Route and controller implementation example:

app/Http/routes.php

    Route::get('/lang/{locale?}', [
        'as'=>'lang',
        'uses'=>'HomeController@changeLang'
    ]);

app/Http/Controllers/HomeController.php

    /**
     * Changes the current language and returns to previous page
     * @return Redirect
     */
    public function changeLang($locale=null)
    {
        LaravelGettext::setLocale($locale);
        return Redirect::to(URL::previous());
    }

B. A basic language selector example:

  <ul>
      @foreach(Config::get('laravel-gettext.supported-locales') as $locale)
            <li><a href="/lang/{{$locale}}">{{$locale}}</a></li>
      @endforeach
  </ul>

C. Built-in language selector:

You can use the built-in language selector in your views:

    // Plain php:
    LaravelGettext::getSelector()->render();

    // Blade views:
    {!! LaravelGettext::getSelector()->render() !!}

It also supports custom labels:

    LaravelGettext::getSelector([
        'en_US' => 'English',
        'es_ES' => 'Spanish',
        'de_DE' => 'Deutsch',
    ])->render();

D. Adding source directories and domains

You can achieve this editing the source-paths configuration array. By default resources/views and app/Http/Controllers are set.

    /**
     * Paths where Poedit will search recursively for strings to translate.
     * All paths are relative to app/ (don't use trailing slash).
     *
     * Remember to call artisan gettext:update after change this.
     */
    'source-paths' => array(
        'Http/Controllers',
        '../resources/views',
        'foo/bar',              // app/foo/bar
    ),

You may want your translations in different files. Translations in GNUGettext are separated by domains, domains are simply context names.

Laravel-Gettext set always a default domain that contains all paths that doesn't belong to any domain, its name is established by the 'domain' configuration option.

To add a new domain just wrap your paths in the desired domain name, like this example:

    'source-paths' => array(
        'frontend' => array(
            'Http/Controllers',
            '../resources/views/frontend',
        ),
        'backend' => array(
            '../resources/views/backend',
        ),
        '../resources/views/misc',
    ),

This configuration generates three translation files by each language: messages.po, frontend.po and backend.po

To change the current domain in runtime (a route-middleware would be a nice place for do this):

    LaravelGettext::setDomain("backend");

Remember: update your gettext files every time you change the 'source-paths' option, otherwise is not necessary.

    php artisan gettext:update

This command will update your PO files and will keep the current translations intact. After this you can open Poedit and click on update button to add the new text strings in the new paths.

You can update only the files of a single domain with the same command:

    php artisan gettext:update --domain backend

E. About gettext cache (only applies to php-gettext native module)

Sometimes when you edit/add translations on PO files the changes does not appear instantly. This is because the gettext cache system holds content. The most quick fix is restart your web server.

6. Contributing

If you want to help with the development of this package, you can:

Warn about errors that you find, in issues section
Send me a pull request with your patch
Fix my disastrous English in the documentation/comments ;-)
Make a fork and create your own version of laravel-gettext
Give a star!

7. Upgrade from 4.*

If you're upgrading from the 4., the one for Laravel 5.3., you need to refactor your usage of the __ method.

Laravel now use this method for their own translation. You now need to use _i instead and add this keyword in the configuration file of Laravel-Gettext:

Also, if you're using Symfony as your backend, you can add the _s method. It's made to use the full feature set of Symfony plurals syntax.

  /**
     * The keywords list used by poedit to search the strings to be translated
     *
     * The "_", "__" and "gettext" are singular translation functions
     * The "_n" and "ngettext" are plural translation functions
     * The "dgettext" function allows a translation domain to be explicitly specified
     *
     * "__" and "_n" and "_i" and "_s" are helpers functions @see \deepskylog\LaravelGettext\Support\helpers.php
     */
    'keywords-list' => ['_', '__', '_i', '_s', 'gettext', '_n:1,2', 'ngettext:1,2', 'dgettext:2'],;

deepskylog / laravel-gettext

Maintainers

Details