README

此包包含一个特性，使 Eloquent 模型可翻译。翻译以 json 格式存储。不需要额外的表来存储它们。

一旦在模型上安装了特性，您可以这样做

$newsItem = new NewsItem; // This is an Eloquent model
$newsItem
   ->setTranslation('name', 'en', 'Name in English')
   ->setTranslation('name', 'nl', 'Naam in het Nederlands')
   ->save();
   
$newsItem->name; // Returns 'Name in English' given that the current app locale is 'en'
$newsItem->getTranslation('name', 'nl'); // returns 'Naam in het Nederlands'

app()->setLocale('nl');

$newsItem->name; // Returns 'Naam in het Nederlands'

Postcardware

您可以使用此包（它是 MIT 许可），但如果它进入您的生产环境，我们非常欢迎您从您家乡给我们寄一张明信片，说明您正在使用我们哪个包。

我们的地址是：Spatie，Samberstraat 69D，2060 安特卫普，比利时。

所有明信片都发布在我们的网站上这里。

安装

您可以通过 composer 安装此包

composer require spatie/laravel-translatable

包将自动注册自己。

如果您想更改 fallback_locale，您必须发布配置文件

php artisan vendor:publish --provider="Spatie\Translatable\TranslatableServiceProvider"

这是发布文件的内容

return [
  'fallback_locale' => 'en',
];

使模型可翻译

使模型可翻译所需的步骤是

首先，您需要添加 Spatie\Translatable\HasTranslations-特性。
接下来，您应该创建一个公共属性 $translatable，它包含所有您希望设置为可翻译的属性名称的数组。
最后，您应该确保所有可翻译的属性都已设置为数据库中的 text 数据类型。如果您的数据库支持 json 列，请使用它。

以下是一个准备好的模型的示例

use Illuminate\Database\Eloquent\Model;
use Spatie\Translatable\HasTranslations;

class NewsItem extends Model
{
    use HasTranslations;
    
    public $translatable = ['name'];
}

可用方法

获取翻译

获取当前区域设置的翻译的最简单方法是直接获取翻译属性的属性。例如（假设 name 是一个可翻译属性）

$newsItem->name;

您也可以使用此方法

public function getTranslation(string $attributeName, string $locale) : string

此函数有一个别名名为 translate。

设置翻译

public function setTranslation(string $attributeName, string $locale, string $value)

要实际保存翻译，请勿忘记保存您的模型。

$newsItem->setTranslation('name', 'en', 'Updated name in English');

$newsItem->save();

忘记翻译

您可以忘记特定字段的翻译

public function forgetTranslation(string $attributeName, string $locale)

您可以忘记特定区域的全部翻译

public function forgetAllTranslations(string $locale)

一次性获取所有翻译

public function getTranslations(string $attributeName): array

一次性设置翻译

public function setTranslations(string $attributeName, array $translations)

以下是一个示例

$translations = [
   'en' => 'Name in English',
   'nl' => 'Naam in het Nederlands'
];

$newsItem->setTranslations('name', $translations);

事件

TranslationHasBeenSet

在调用 setTranslation 后，将触发 Spatie\Translatable\Events\TranslationHasBeenSet-事件。

它具有以下属性

/** @var \Illuminate\Database\Eloquent\Model */
public $model;

/** @var string  */
public $attributeName;

/** @var string  */
public $locale;

public $oldValue;
public $newValue;

创建模型

在创建模型时可以立即设置翻译。以下是一个示例

NewsItem::create([
   'name' => [
      'en' => 'Name in English'
      'nl' => 'Naam in het Nederlands'
   ],
]);

查询可翻译属性

如果您使用的是 MySQL 5.7 或更高版本，建议您使用 json 数据类型在数据库中存储翻译。这将允许您像这样查询这些列

NewsItem::where('name->en', 'Name in English')->get();

在 json 响应中使用翻译

将翻译添加到 json 响应的最简单方法是覆盖模型上的 toArray 方法。

以下是一个快速示例

// in your model

    /**
     * Convert the model instance to an array.
     *
     * @return array
     */
    public function toArray()
    {
        $attributes = parent::toArray();
        
        foreach ($this->getTranslatableAttributes() as $name) {
            $attributes[$name] = $this->getTranslation($name, app()->getLocale());
        }
        
        return $attributes;
    }
}

更新日志

有关最近更改的更多信息，请参阅更新日志。

测试

$ composer test

贡献

有关详细信息，请参阅贡献。

安全

如果您发现任何与安全相关的问题，请通过电子邮件发送给 freek@spatie.be，而不是使用问题跟踪器。

致谢

我们从Mohamed Said那里得到了将翻译存储为JSON的列的想法。本说明书的某些部分使用了他的多语言包的readme。

关于Spatie

Spatie是一家位于比利时安特卫普的网页设计公司。您可以在我们的网站上找到我们所有开源项目的概述这里。

许可证

MIT许可证（MIT）。有关更多信息，请参阅许可证文件。

zoomyboy / laravel-translatable

维护者

详情