本地化

使用区域设置
语言本地化

使用区域设置 

CodeIgniter 提供了几个工具来帮助你为不同的语言本地化应用程序。尽管完整地本地化一个应用程序是个复杂的题目,但在应用程序中用不同的支持语言交换字符串是非常简单的。

语言字符串存储在 app/Language 目录中,每个支持的语言都有对应的子目录:

app/
    Language/
        en/
            App.php
        fr/
            App.php

重要

仅基于网络的请求才会启用本地化检测,需要使用 IncomingRequest 类。命令行下的请求不支持这些特性。

配置区域设置 

设置默认语言环境 

每个站点都会有一个它们运作的默认语言环境/区域设置。这可以在 app/Config/App.php 中设置:

<?php

namespace Config;

use CodeIgniter\Config\BaseConfig;

class App extends BaseConfig
{
    // ...

    public string $defaultLocale = 'en';

    // ...
}

这个值可以是你的应用程序用来管理文本字符串和其他格式的任意字符串。建议使用 BCP 47 语言代码。这会产生像 en-US 表示美式英语,或者 fr-FR 表示法语/法国这样的语言代码。W3C 网站上有更容易理解的介绍。

如果无法找到完全匹配的语言环境,系统足够智能到退回到更通用的语言代码。如果语言环境代码被设置为 en-US,但我们只设置了 en 的语言文件,那么就会使用 en,因为没有更具体的 en-US 存在。然而,如果 app/Language/en-US 目录存在,那么它将被首先使用。

区域设置检测 

在请求期间支持两种方法来检测正确的区域设置。第一种方法是一个“设置完就忘记”的方式,将自动为你执行内容协商以确定使用的正确区域设置。第二种方法允许你在路由中指定一个片段来设置区域设置。

如果你需要直接设置区域设置,请参见设置当前区域设置。

内容协商 

你可以通过在 app/Config/App.php 中设置两个附加配置来启用内容协商自动执行。第一个值告诉 Request 类我们确实希望协商一个区域设置,所以简单地设置为 true :

<?php

namespace Config;

use CodeIgniter\Config\BaseConfig;

class App extends BaseConfig
{
    // ...

    public bool $negotiateLocale = true;

    // ...
}

一旦启用,系统将自动根据你定义的区域设置列表 $supportLocales 协商出正确的语言。如果在你支持的语言和请求的语言之间找不到匹配, $supportedLocales 中的第一项将被使用。在下面的例子中,如果找不到匹配,将使用 en 区域设置:

<?php

namespace Config;

use CodeIgniter\Config\BaseConfig;

class App extends BaseConfig
{
    // ...

    public array $supportedLocales = ['en', 'es', 'fr-FR'];

    // ...
}

在路由中 

第二种方法使用一个自定义占位符来检测所需的区域设置并在 Request 中设置它。可以将占位符 {locale} 作为路由中的一个片段。如果存在,匹配片段的内容将是你的区域设置:

<?php

$routes->get('{locale}/books', 'App\Books::index');

在这个例子中,如果用户试图访问 http://example.com/fr/books,那么区域设置将被设置为 fr,假设它已经在 $supportedLocales 中被配置为有效的区域设置。

如果该值与 app/Config/App.php 中定义的 $supportedLocales 中的有效区域设置不匹配,将使用默认区域设置取代,除非你设置只使用 App 配置文件中定义的受支持区域设置:

<?php

$routes->useSupportedLocalesOnly(true);

备注

useSupportedLocalesOnly() 方法可以在 v4.3.0 及以上版本中使用。

设置当前区域设置 

如果你想直接设置区域设置,可以使用 IncomingRequest::setLocale(string $locale)。你必须在 app/Config/App.php 中设置支持的区域设置:

<?php

namespace Config;

use CodeIgniter\Config\BaseConfig;

class App extends BaseConfig
{
    // ...

    public array $supportedLocales = ['en', 'es', 'fr-FR'];

    // ...
}

备注

尝试设置一个不在该数组中的区域设置的任何尝试都将结果在默认区域设置被设置。

获取当前区域设置 

当前区域设置始终可以从 IncomingRequest 对象中通过 getLocale() 方法获取。如果你的控制器继承了 CodeIgniter\Controller,它将通过 $this->request 可用:

<?php

namespace App\Controllers;

class UserController extends BaseController
{
    public function index()
    {
        $locale = $this->request->getLocale();
    }
}

或者,你可以使用 Services 类来检索当前请求:

<?php

$locale = service('request')->getLocale();

语言本地化 

创建语言文件 

备注

语言文件没有命名空间。

语言文件没有任何特定的命名约定是必需的。文件名应该具有描述它所包含内容的逻辑名称。例如,假设你想创建一个包含错误信息的文件。你可以简单地将其命名为:Errors.php。

在文件中,你将返回一个数组,数组中的每个元素都有一个语言键和可以返回的字符串:

<?php

return [
    'languageKey' => 'The actual message to be shown.',
];

它也支持嵌套定义:

<?php

return [
    'languageKey' => [
        'nested' => [
            'key' => 'The actual message to be shown.',
        ],
    ],
];

<?php

return [
    'errorEmailMissing'    => 'You must submit an email address',
    'errorURLMissing'      => 'You must submit a URL',
    'errorUsernameMissing' => 'You must submit a username',
    'nested'               => [
        'error' => [
            'message' => 'A specific error message',
        ],
    ],
];

基本用法 

你可以使用 lang() 辅助函数来检索任何语言文件中的文本,方法是将文件名和语言键作为第一个参数传递,用点号 (.) 分隔。例如,要从 Errors.php 语言文件加载 errorEmailMissing 字符串,你可以执行以下操作:

<?php

echo lang('Errors.errorEmailMissing');

对于嵌套定义,你可以执行以下操作:

<?php

echo lang('Errors.nested.error.message');

如果请求的语言键在当前区域设置的文件中不存在,字符串将原封不动地返回。在此例中,如果它不存在,将返回 ‘Errors.errorEmailMissing’ 或者 ‘Errors.nested.error.message’。

替换参数 

备注

以下函数都需要在你的系统上加载 intl 扩展才能工作。如果没有加载该扩展,将不会尝试替换。你可以在 Sitepoint 上找到很好的概述。

你可以将值数组作为 lang() 函数的第二个参数传递,以替换语言字符串中的占位符。这允许非常简单的数字翻译和格式化:

<?php

// The language file, Tests.php:
return [
    'apples'      => 'I have {0, number} apples.',
    'men'         => 'The top {1, number} men out-performed the remaining {0, number}',
    'namedApples' => 'I have {number_apples, number, integer} apples.',
];

// Displays "I have 3 apples."
echo lang('Tests.apples', [3]);

数组中第一个项目对应于索引的项目的占位符,如果是数字的话:

<?php

// Displays "The top 23 men out-performed the remaining 20"
echo lang('Tests.men', [20, 23]);

你也可以使用命名键以保持简洁,如果你愿意的话:

<?php

// Displays "I have 3 apples."
echo lang('Tests.namedApples', ['number_apples' => 3]);

显然,你不仅可以进行数字替换。根据项目底层库的官方 ICU 文档 , 可以替换以下类型的数据:

数字 - 整数、货币、百分比
日期 - 短、中、长、完整
时间 - 短、中、长、完整
拼写 - 拼出数字(即 34 变为 thirty-four)
序数
时长

这里有一些例子:

<?php

// The language file, Tests.php
return [
    'shortTime'  => 'The time is now {0, time, short}.',
    'mediumTime' => 'The time is now {0, time, medium}.',
    'longTime'   => 'The time is now {0, time, long}.',
    'fullTime'   => 'The time is now {0, time, full}.',
    'shortDate'  => 'The date is now {0, date, short}.',
    'mediumDate' => 'The date is now {0, date, medium}.',
    'longDate'   => 'The date is now {0, date, long}.',
    'fullDate'   => 'The date is now {0, date, full}.',
    'spelledOut' => '34 is {0, spellout}',
    'ordinal'    => 'The ordinal is {0, ordinal}',
    'duration'   => 'It has been {0, duration}',
];

// Displays "The time is now 11:18 PM"
echo lang('Tests.shortTime', [time()]);
// Displays "The time is now 11:18:50 PM"
echo lang('Tests.mediumTime', [time()]);
// Displays "The time is now 11:19:09 PM CDT"
echo lang('Tests.longTime', [time()]);
// Displays "The time is now 11:19:26 PM Central Daylight Time"
echo lang('Tests.fullTime', [time()]);

// Displays "The date is now 8/14/16"
echo lang('Tests.shortDate', [time()]);
// Displays "The date is now Aug 14, 2016"
echo lang('Tests.mediumDate', [time()]);
// Displays "The date is now August 14, 2016"
echo lang('Tests.longDate', [time()]);
// Displays "The date is now Sunday, August 14, 2016"
echo lang('Tests.fullDate', [time()]);

// Displays "34 is thirty-four"
echo lang('Tests.spelledOut', [34]);

// Displays "It has been 408,676:24:35"
echo lang('Tests.ordinal', [time()]);

你应该确保阅读 MessageFormatter 类和基础 ICU 格式相关的内容,以更好地了解它的功能,比如执行条件替换、复数化等。之前提供的两个链接都会给你关于可用选项的极好的主意。

指定区域设置 

要指定不同的区域设置用于替换参数,你可以将区域设置作为第三个参数传递给 lang() 函数。

<?php

// Displays "The time is now 23:21:28 GMT-5"
echo lang('Test.longTime', [time()], 'ru-RU');

// Displays "£7.41"
echo lang('{price, number, currency}', ['price' => 7.41], 'en-GB');
// Displays "$7.41"
echo lang('{price, number, currency}', ['price' => 7.41], 'en-US');

嵌套数组 

语言文件也允许使用嵌套数组使得使用列表等更简单。

<?php

// Language/en/Fruit.php

return [
    'list' => [
        'Apples',
        'Bananas',
        'Grapes',
        'Lemons',
        'Oranges',
        'Strawberries',
    ],
];

// Displays "Apples, Bananas, Grapes, Lemons, Oranges, Strawberries"
echo implode(', ', lang('Fruit.list'));

语言回退 

如果你为一个给定的区域设置拥有一组消息,例如 Language/en/app.php,你可以为该区域设置添加语言变体, 每种变体各自一个文件夹,例如 Language/en-US/app.php。

你只需要为需要针对该区域设置变体进行本地化的消息提供不同的值。任何缺失的消息定义将自动从主要的区域设置中获取。

更好的是,本地化可以一直回退到英语, 以防还没有机会为你的区域设置翻译框架中添加的新消息。

因此,如果你使用 fr-CA 区域设置,则本地化消息将首先在 Language/fr-CA 目录中查找,然后在 Language/fr 目录中查找, 最后在 Language/en 目录中查找。

消息翻译 

我们在自己的仓库中有一组“官方”翻译。

你可以下载该仓库,并将其 Language 文件夹复制到你的 app 文件夹中。合并的翻译将被自动使用,因为 App 命名空间映射到你的 app 文件夹。

或者,在你的项目中运行以下命令会更好:

> composer require codeigniter4/translations

翻译的消息将自动被使用,因为翻译文件夹得到了正确的映射。