README

这是一个用于可翻译模型的Laravel包。其目标是在获取和存储多语言模型实例时简化复杂性。使用此包，您可以编写更少的代码，因为翻译是在获取/保存实例时获取/保存的。

如果您想将模型的翻译存储到数据库中，这个包适合您。

演示
教程
安装
配置
文档
支持

Laravel兼容性

演示

获取翻译属性

  $greece = Country::where('code', 'gr')->first();
  echo $greece->translate('en')->name; // Greece
  
  App::setLocale('en');
  echo $greece->name;     // Greece

  App::setLocale('de');
  echo $greece->name;     // Griechenland

保存翻译属性

  $greece = Country::where('code', 'gr')->first();
  echo $greece->translate('en')->name; // Greece
  
  $greece->translate('en')->name = 'abc';
  $greece->save();
  
  $greece = Country::where('code', 'gr')->first();
  echo $greece->translate('en')->name; // abc

填充多个翻译

  $data = [
    'code' => 'gr',
    'en'  => ['name' => 'Greece'],
    'fr'  => ['name' => 'Grèce'],
  ];

  $greece = Country::create($data);
  
  echo $greece->translate('fr')->name; // Grèce

教程

请参阅laravel-news中关于laravel-translatable的教程：如何为Eloquent添加多语言支持

4步安装

步骤1：安装包

通过执行命令将包添加到您的composer.json中。

composer require dimsav/laravel-translatable

接下来，将服务提供者添加到app/config/app.php

Dimsav\Translatable\TranslatableServiceProvider::class,

步骤2：迁移

在此示例中，我们想要翻译模型Country。我们需要一个额外的表country_translations

Schema::create('countries', function(Blueprint $table)
{
    $table->increments('id');
    $table->string('code');
    $table->timestamps();
});

Schema::create('country_translations', function(Blueprint $table)
{
    $table->increments('id');
    $table->integer('country_id')->unsigned();
    $table->string('name');
    $table->string('locale')->index();

    $table->unique(['country_id','locale']);
    $table->foreign('country_id')->references('id')->on('countries')->onDelete('cascade');
});

步骤3：模型

可翻译模型Country应该使用特性 Dimsav\Translatable\Translatable。
翻译模型的约定是CountryTranslation。

// models/Country.php
class Country extends Eloquent {
    
    use \Dimsav\Translatable\Translatable;
    
    public $translatedAttributes = ['name'];
    protected $fillable = ['code', 'name'];
    
    /**
     * The relations to eager load on every query.
     *
     * @var array
     */
    // (optionaly)
    // protected $with = ['translations'];

}

// models/CountryTranslation.php
class CountryTranslation extends Eloquent {

    public $timestamps = false;
    protected $fillable = ['name'];

}

数组$translatedAttributes包含在“Translation”模型中翻译的字段名称。

步骤4：配置

Laravel 4.*

php artisan config:publish dimsav/laravel-translatable

Laravel 5.*

php artisan vendor:publish

使用此命令初始化配置并修改位于app/config/packages/dimsav/laravel-translatable/translatable.php下的创建的文件。

注意：对区域格式的限制没有限制。请随意使用您更喜欢的任何格式，例如使用“eng”而不是“en”，或使用“el”而不是“gr”。重要的是要定义您的区域并坚持使用它们。

配置

翻译模型

用于定义翻译模型类的约定是在关键字后面附加Translation。

所以如果你的模型是\MyApp\Models\Country，默认翻译将是\MyApp\Models\CountryTranslation。

要使用自定义类作为翻译模型，请将翻译类（包括命名空间）作为参数定义。例如

<?php 

namespace MyApp\Models;

use Dimsav\Translatable\Translatable;
use Illuminate\Database\Eloquent\Model as Eloquent;

class Country extends Eloquent
{
    use Translatable;

    public $translationModel = 'MyApp\Models\CountryAwesomeTranslation';
}

文档

请首先阅读安装步骤，以了解需要创建哪些类。

可用方法

// Before we get started, this is how we determine the current locale.
// It is set by laravel or other packages.
App::getLocale(); // 'fr' 

// To use this package, first we need an instance of our model
$germany = Country::where('code', 'de')->first();

// This returns an instance of CountryTranslation of using the current locale.
// So in this case, french. If no french translation is found, it returns null.
$translation = $germany->translate();

// If an german translation exists, it returns an instance of 
// CountryTranslation. Otherwise it returns null.
$translation = $germany->translate('de');

// If a german translation doesn't exist, it attempts to get a translation  
// of the fallback language (see fallback locale section below).
$translation = $germany->translate('de', true);

// Alias of the above.
$translation = $germany->translateOrDefault('de');

// Returns instance of CountryTranslation of using the current locale.
// If no translation is found, it returns a fallback translation
// if enabled in the configuration.
$translation = $germany->getTranslation();

// If an german translation exists, it returns an instance of 
// CountryTranslation. Otherwise it returns null.
// Same as $germany->translate('de');
$translation = $germany->getTranslation('de', true);

// Returns true/false if the model has translation about the current locale. 
$germany->hasTranslation();

// Returns true/false if the model has translation in french. 
$germany->hasTranslation('fr');

// If a german translation doesn't exist, it returns
// a new instance of CountryTranslation.
$translation = $germany->translateOrNew('de');

// Returns a new CountryTranslation instance for the selected
// language, and binds it to $germany
$translation = $germany->getNewTranslation('it');

// The eloquent model relationship. Do what you want with it ;) 
$germany->translations();

可用作用域

// Returns all countries having translations in english
Country::translatedIn('en')->get();

// Returns all countries not being translated in english
Country::notTranslatedIn('en')->get();

// Returns all countries having translations
Country::translated()->get();

// Eager loads translation relationship only for the default
// and fallback (if enabled) locale
Country::withTranslation()->get();

// Returns an array containing pairs of country ids and the translated
// name attribute. For example: 
// [
//     ['id' => 1, 'name' => 'Greece'], 
//     ['id' => 2, 'name' => 'Belgium']
// ]
Country::listsTranslations('name')->get()->toArray();

// Filters countries by checking the translation against the given value 
Country::whereTranslation('name', 'Greece')->first();

// Filters countries by checking the translation against the given string with wildcards
Country::whereTranslationLike('name', '%Gree%')->first();

魔术属性

要使用魔术属性，您必须在主模型中定义属性$translatedAttributes

class Country extends Eloquent {

    use \Dimsav\Translatable\Translatable;

    public $translatedAttributes = ['name'];
}

// Again we start by having a country instance
$germany = Country::where('code', 'de')->first();

// We can reference properties of the translation object directly from our main model.
// This uses the default locale and is the equivalent of $germany->translate()->name
$germany->name; // 'Germany'

// We can also quick access a translation with a custom locale
$germany->{'name:de'} // 'Deutschland'

回退区域

如果您想在找不到翻译时回退到默认翻译，请在配置中使用use_fallback键启用它。要选择默认区域，请使用fallback_locale键。

配置示例

return [
    'use_fallback' => true,

    'fallback_locale' => 'en',    
];

您还可以通过设置$useTranslationFallback属性为每个模型定义“是否使用回退”的默认值。

class Country {

    public $useTranslationFallback = true;

}

基于国家的回退

从版本v5.3开始，可以使用基于国家的区域。例如，您可以有以下区域

英语：en
西班牙语：es
墨西哥西班牙语：es-MX
哥伦比亚西班牙语：es-CO

这些区域的配置如下所示

    'locales' => [ 
        'en',
        'es' => [
            'MX',
            'CO',
        ],
    ];

我们还可以配置语言和国家之间的“粘合剂”。例如，如果我们更喜欢格式es_MX而不是es-MX，则配置应如下所示

   'locale_separator' => '_',

对于使用en-MX格式的区域设置的回退，适用什么规则？

假设我们的回退区域设置为en。现在，当我们尝试从数据库中获取es-MX区域设置的翻译，但该翻译不存在时，我们将不会回退到en的翻译。Translatable将使用回退es（es-MX的第一个部分）并仅在找不到任何内容时返回en的翻译。

附加组件

多亏了社区，已经编写了一些包，使在处理表单时使用Translatable更加容易

常见问题解答

我需要一些示例代码！

所有包功能的示例可以在用于测试的代码中找到这里。

我需要帮助！

有任何问题或建议？请随意提交问题。

我想帮忙！

你太棒了！关注了仓库并回复了问题。你将帮助为包的用户提供更好的体验。#communityWorks

我在其他特质方法中遇到了冲突！

Translatable与所有类型的Eloquent扩展完全兼容，包括Ardent。如果您需要帮助将这些扩展与Translatable一起实现，请参阅这个示例。

我如何根据翻译进行排序？

一个提示是首先执行MySQL查询，然后执行Eloquent查询。

要获取按翻译字段排序的记录列表，您可以这样做

SELECT * from countries
JOIN country_translations as t on t.country_id = countries.id 
WHERE locale = 'en'
GROUP BY countries.id
ORDER BY t.name desc

相应的Eloquent查询将是

Country::join('country_translations as t', 't.country_id', '=', 'countries.id')
    ->where('locale', 'en')
    ->groupBy('countries.id')
    ->orderBy('t.name', 'desc')
    ->with('translations')
    ->get();

我如何通过翻译字段选择国家？

例如，让我们假设我们想要找到国家翻译名称等于'Portugal'的国家。

Country::whereHas('translations', function ($query) {
    $query->where('locale', 'en')
    ->where('name', 'Portugal');
})->first();

您可以在Laravel的查询关系文档中找到更多信息。

为什么在运行迁移时我遇到了mysql错误？

如果您看到以下mysql错误

[Illuminate\Database\QueryException]
SQLSTATE[HY000]: General error: 1005 Can't create table 'my_database.#sql-455_63'
  (errno: 150) (SQL: alter table `country_translations` 
  add constraint country_translations_country_id_foreign foreign key (`country_id`) 
  references `countries` (`id`) on delete cascade)

那么您的表使用的是MyISAM引擎，该引擎不允许外键约束。MyISAM是5.5版本之前mysql版本的默认引擎。从版本5.5开始，表默认使用InnoDB存储引擎。

如何修复

对于已在生产中创建的表，更新迁移以在添加外键约束之前更改表的引擎。

public function up()
{
    DB::statement('ALTER TABLE countries ENGINE=InnoDB');
}

public function down()
{
    DB::statement('ALTER TABLE countries ENGINE=MyISAM');
}

对于新表，一个快速的解决方案是在迁移中设置存储引擎

Schema::create('language_translations', function(Blueprint $table){
  $table->engine = 'InnoDB';
  $table->increments('id');
    // ...
});

不过，最好的解决方案是更新您的mysql版本。并且始终确保开发和生产环境中版本相同！

hissezhaut / laravel-translatable

维护者

详细信息