README

Laravel Gettext是一个与Laravel框架兼容的翻译包。它提供了一种简单的方法来为Laravel应用程序添加本地化支持。它旨在与GNU gettext和Poedit一起工作。此包的前版本（4.x之前）与原生php-gettext模块一起工作。当前版本默认使用Symfony翻译包，而不是原生php扩展。

Laravel 8的laravel-gettext

Laravel 6的laravel-gettext

Laravel最新的长期支持版本是Laravel 6，我们不推荐使用版本小于6的Laravel。

1. 要求

1.1 可选

1.1.1 APCU

已安装APCU扩展 - https://php.ac.cn/manual/en/book.apcu.php

如果安装了APCU php扩展，则库将使用内存来缓存加载的翻译，以避免在每个请求中解析翻译文件（mo/po）。

当翻译文件发生变化时，缓存会自动失效。

1.1.2 gettext

如果你想要使用原生php-gettext扩展，则需要以下可选要求

php-gettext - https://php.ac.cn/manual/en/book.gettext.php
系统（和生产服务器！）上的GNU gettext - https://gnu.ac.cn/software/gettext/

为了使用原生php-gettext模块，你需要将'handler'选项更新为'gettext'。

2. 安装

安装完成后，Laravel将自动发现提供者并加载它。（仅适用于5.5及以上版本）

    composer require zerospam/laravel-gettext

现在，你需要发布配置文件来设置自己的应用程序值

    php artisan vendor:publish

此命令在config/laravel-gettext.php中创建包配置文件。

你还需要在app/Http/Kernel.php文件中注册LaravelGettext中间件

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

请确保在Illuminate\Session\Middleware\StartSession之后添加该行，否则区域设置将不会被保存到会话中。

3. 配置

到目前为止，你的应用程序已完全支持gettext。现在，你需要在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',

好的，现在已配置完毕。现在是时候生成目录结构和翻译文件了。

在运行此命令之前，请确保你有对resources/的写入权限

    php artisan gettext:create

使用此命令，在resources/lang/i18n上创建所需的目录和文件

4. 工作流程

A. 编写字符串 :D

默认情况下，LaravelGettext 会递归地在 app/Http/Controllers 和 resources/views 目录中查找翻译。所有使用 _i() 函数打印的文本都被视为翻译。让我们看看一个简单的视图示例。

    // 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 不“理解”blade语法。当使用blade视图时，您必须运行 php artisan gettext:update 来编译所有blade视图为纯PHP，然后再更新Poedit中的翻译。

B. 复数字符串

复数翻译遵循上面的相同模式。复数翻译是使用 _n() 函数打印的所有文本，它遵循 php ngettext。让我们看看一个简单的视图示例。

    // 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) }}

Poedit的关键字在配置文件中通过以下默认模式定义。

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

查看 Poedit 用于配置您语言的复数形式。

使用Symfony

如果您使用 Symfony 作为翻译后端，您可以通过 _s 方法访问它们的复数语法。在Poedit中，它将被视为单行而不是复数。

    // 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);

使用symfony复杂语法

    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. 使用Poedit进行翻译

使用Poedit打开您要翻译的语言的PO文件。PO文件默认位于 resources/lang/i18n/[locale]/LC_MESSAGES/[domain].po。如果您有多个gettext域，每个域将生成一个文件。

一旦Poedit加载，请按更新按钮以加载所有本地化字符串。每次您添加新的本地化字符串时，都可以重复此步骤。

在Poedit中填写翻译字段并保存文件。第一次这样做时，将为每个区域生成MO文件。

C. 运行时方法

要在运行时更改配置，您有这些方法

    /**
     * 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. 功能和示例

A. 路由和控制器实现示例

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. 基本语言选择器示例

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

C. 内置语言选择器

您可以在视图中使用内置的语言选择器

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

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

它还支持自定义标签

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

D. 添加源目录和域

您可以通过编辑 source-paths 配置数组来实现这一点。默认情况下，已设置 resources/views 和 app/Http/Controllers。

    /**
     * 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
    ),

您可能希望将翻译放在不同的文件中。GNUGettext中的翻译按域分隔，域仅仅是上下文名称。

Laravel-Gettext始终设置一个默认域，该域包含不属于任何域的所有路径，其名称由 'domain' 配置选项确定。

要添加新域，只需将路径包裹在所需的域名中，例如以下示例

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

此配置将为每种语言生成三个翻译文件： messages.po、frontend.po 和 backend.po

要更改当前域的运行时（路由中间件将是一个很好的地方来做这件事）

    LaravelGettext::setDomain("backend");

记住： 每次更改 'source-paths' 选项时，请更新您的gettext文件，否则是不必要的。

    php artisan gettext:update

此命令将更新您的PO文件并保留当前翻译不变。在此之后，您可以打开Poedit并单击更新按钮，以将新文本字符串添加到新路径。

您可以使用相同的命令仅更新单个域的文件

    php artisan gettext:update --domain backend

E. 关于gettext缓存（仅适用于php-gettext原生模块）

有时当您在PO文件上编辑/添加翻译时，更改不会立即显示。这是因为gettext缓存系统保留了内容。最快速的修复方法是重新启动您的Web服务器。

6. 贡献

如果您想帮助开发此包，您可以

在问题部分警告您找到的错误
将您的补丁作为pull request发送给我
修复文档/注释中的糟糕英文吧 ;-)
创建一个分支，并创建laravel-gettext的自己的版本
给个star吧！

7. 从4.*版本升级

如果您是从4.*版本（Laravel 5.3使用的版本）升级，您需要重构使用__方法的方式。

Laravel现在使用这个方法进行自己的翻译。您现在需要使用_i，并在Laravel-Gettext的配置文件中添加这个关键字。

此外，如果您使用Symfony作为后端，您可以添加_s方法。它是为了使用Symfony复数语法的完整功能集而设计的。

  /**
     * 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 \Xinax\LaravelGettext\Support\helpers.php
     */
    'keywords-list' => ['_', '__', '_i', '_s', 'gettext', '_n:1,2', 'ngettext:1,2', 'dgettext:2'],;

marcandreappel / laravel-gettext

维护者

详细信息