README

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

laravel-gettext for Laravel 8

laravel-gettext for Laravel 6

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/

您需要将 'handler' 选项更新为 'gettext'，才能使用原生 php-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'],;

djlimix / laravel-gettext

维护者

详细信息