uyoobonga/words-translatable

Laravel多语言模型包

维护者

详细信息

github.com/uyo-obong/words-translatable

源代码

问题

安装: 97

依赖: 0

建议者: 0

安全: 0

星星: 0

关注者: 1

分支: 0

开放性问题: 0

v2.0.0 2020-11-28 03:00 UTC

Requires

Requires (Dev)

MIT 4f1557d48f82e33a49e280361a39228a61551344

databasetranslationlanguagelaravel

This package is auto-updated.

Last update: 2024-09-29 05:48:50 UTC

README

此包已被弃用。但不必担心。您可以使用 uyoobonga/words-translatable.

Laravel-Translatable

Total Downloads Build Status Code Coverage Latest Stable Version License SensioLabsInsight StyleCI

Laravel Translatable

如果您想将模型的翻译存储到数据库中，这个包就是为您准备的。

这是一个为可翻译模型提供的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兼容性

教程

4步骤安装

步骤1：安装包

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

composer require uyoobonga/words-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：模型

  1. 可翻译模型Country应该使用特质 Dimsav\Translatable\Translatable。
  2. 翻译模型的约定是CountryTranslation。
// models/Country.php
class Country extends Eloquent {
    
    use \Dimsav\Translatable\Translatable;
    
    public $translatedAttributes = ['name'];
    protected $fillable = ['code'];
    
    /**
     * 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 5.*

php artisan vendor:publish --tag=translatable

Laravel 4.*

php artisan config:publish dimsav/laravel-translatable

注意：没有对区域格式的限制。请随意使用您认为更好的格式，例如用“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 default 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 default locale.
// So in this case, french. If no french translation is found, it returns null.
$translation = $germany->translate();

// It is possible to define a default locale per model by overriding the model constructor.
public function __construct(array $attributes = [])
{
    parent::__construct($attributes);
    
    $this->defaultLocale = 'de';
}

// It is also possible to define a default locale for our model on the fly:
$germany->setDefaultLocale('de');

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

// To set the translation for a field you can either update the translation model.
// Saving the model will also save all the related translations.
$germany->translate('en')->name = 'Germany';
$germany->save();

// Alternatively we can use the shortcut
$germany->{'name:en'} = 'Germany';
$germany->save();

// There are two ways of inserting mutliple translations into the database
// First, using the locale as array key.
$greece = $country->fill([
    'en'  => ['name' => 'Greece'],
    'fr'  => ['name' => 'Grèce'],
]);

// The second way is to use the following syntax.  
$greece = $country->fill([
    'name:en' => 'Greece',
    'name:fr' => 'Grèce',
]);

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

// Remove all translations linked to an object
$germany->deleteTranslations();

// Delete one or multiple translations
$germany->deleteTranslations('de');
$germany->deleteTranslations(['de', 'en']);

// Gel all the translations as array
$germany->getTranslationsArray();
// Returns
[
 'en' => ['name' => 'Germany'],
 'de' => ['name' => 'Deutschland'],
 'fr' => ['name' => 'Allemagne'],
];

// Creates a clone and clones the translations
$replicate = $germany->replicateWithTranslations();

可用作用域

// 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 value, only in the specified locale
Country::whereTranslation('name', 'Greece', 'en')->first();

// Or where translation
Country::whereTranslation('name', 'Greece')->orWhereTranslation('name', 'France')->get();

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

// Or where translation like
Country::whereTranslationLike('name', '%eece%')->orWhereTranslationLike('name', '%ance%')->get();

魔法属性

要使用魔法属性，您必须在主模型中定义属性$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;

}

按属性回退

尽管我们尽量让所有模型都有很好的翻译，但某些字段可能仍然是空的。结果是什么？这些字段的翻译将丢失！

属性回退功能就是为了解决这个问题。启用后，可翻译属性将返回回退语言的值。

新安装默认启用此功能。如果您的配置文件在v7.1之前设置，请确保添加以下行以启用此功能

'use_property_fallback' => true,

当然，必须启用回退区域设置才能使用此功能。

如果配置中启用了属性回退，则可翻译属性将返回回退区域设置的翻译值，这些值在字段中为空。

自定义空翻译属性检测

此包旨在翻译字符串，但通常它也能翻译数字、布尔值或您想要的任何内容。默认情况下，使用简单的empty()调用检测翻译值是否为空。如果您想自定义此功能或按属性使用不同的逻辑，可以在主模型中重写isEmptyTranslatableAttribute()。

protected function isEmptyTranslatableAttribute(string $key, $value): bool
{
    switch($key) {
        case 'name':
            return empty($value);
        case 'price':
            return !is_number($value);
        default:
            return is_null($value);
    }
}

基于国家的回退

从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翻译。可翻译将使用作为回退的es（es-MX的第一部分）并只有在找不到任何内容时，才会返回en的翻译。

翻译自动加载

如果调用toArray()方法，则可以自动加载所有翻译。为了控制此功能，该包提供了一个配置值to_array_always_loads_translations和特例中的三个静态方法

  • enableAutoloadTranslations() - 强制加载所有翻译
  • disableAutoloadTranslations() - 禁用自动加载并返回父属性
  • defaultAutoloadTranslations() - 不更改默认行为逻辑（默认）

附加组件

感谢社区，一些包已被编写，使在使用表单时使用可翻译变得更加容易

常见问题解答

我需要一些示例代码！

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

我需要帮助！

有任何问题或建议？请随时创建一个问题。

我想帮助！

您很棒！关注仓库并回复问题。这将帮助为包的用户提供良好的体验。#communityWorks

通过进行捐赠为我买杯啤酒吧。❤️

我在其他特有方法上遇到了冲突！

可翻译与所有类型的Eloquent扩展完全兼容，包括Ardent。如果您需要帮助实现与这些扩展的可翻译，请查看此示例。

我如何将现有表迁移到使用laravel-translatable？

请参阅安装步骤，了解您的数据库应该如何构建。

如果您的属性是用英文写的，我们建议在迁移中使用这些命令

// We insert the translation attributes into the fresh translated table: 
\DB::statement("insert into country_translations (country_id, name, locale) select id, name, 'en' from countries");

// We drop the translation attributes in our main table: 
Schema::table('countries', function ($table) {
    $table->dropColumn('name');
});

我如何根据翻译排序？

这里的一个技巧是先进行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', function ($join) {
        $join->on('countries.id', '=', 't.country_id')
            ->where('t.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版本。并且始终确保在开发和生产环境中使用相同的版本！