theupriser/laravel-unique-translation

检查数据库中JSON列中的翻译值是否唯一。

4.2 2024-03-11 11:23 UTC

This package is auto-updated.

Last update: 2024-09-12 17:01:02 UTC


README

重要:2022年3月

Support Ukraine

看到现在乌克兰发生的事情真是太可怕了,因为俄罗斯军队正在轰炸房屋、医院和幼儿园

查看 supportukrainenow.org 了解您如何帮助他们。传播这个消息。

如果你来自俄罗斯,并且你反对这场战争,请以某种方式表达你的抗议。我知道你会因此受到惩罚,但你将是那些无辜人民的希望之一。

GitHub release Laravel License Build Status Code Coverage Code Quality Total Downloads

ko-fi

检查数据库中JSON列中的翻译值是否唯一。

想象一下,你想要为不同的语言存储一个用于Post模型的slug

神奇的spatie/laravel-translatable包让这变得轻而易举!

但然后你想要确保每种翻译对其语言都是唯一的。

这就是这个包发挥作用的地方。

此包还支持spatie/nova-translatable,如果你使用Laravel Nova,以及如果你使用filamentphp/spatie-laravel-translatable-plugin,则支持Filament

✅ 要求

📦 安装

通过Composer安装包

composer require codezero/laravel-unique-translation

Laravel会自动注册ServiceProvider

🛠 使用

以下示例中,我将使用posts表中的slug作为验证的主题。

☑️ 验证单个翻译

您的表单可以提交单个slug

<input name="slug">

然后我们可以检查它是否在当前区域strong唯一

$attributes = request()->validate([
    'slug' => 'required|unique_translation:posts',
]);

您也可以使用规则实例

use CodeZero\UniqueTranslation\UniqueTranslationRule;

$attributes = request()->validate([
    'slug' => ['required', UniqueTranslationRule::for('posts')],
]);

☑️ 验证翻译数组

您的表单也可以提交slug数组。

<input name="slug[en]">
<input name="slug[nl]">

在这种情况下,我们需要验证整个数组。注意slug.*键。

$attributes = request()->validate([
    'slug.*' => 'unique_translation:posts',
    // or...
    'slug.*' => UniqueTranslationRule::for('posts'),
]);

☑️ 指定列

也许您的表单字段名称为post_slug,而您的数据库字段名称为slug

$attributes = request()->validate([
    'post_slug.*' => 'unique_translation:posts,slug',
    // or...
    'post_slug.*' => UniqueTranslationRule::for('posts', 'slug'),
]);

☑️ 指定数据库连接

如果您使用多个数据库连接,您可以通过在表名前加上前缀来指定要使用哪个连接,并用点分隔

$attributes = request()->validate([
    'slug.*' => 'unique_translation:db_connection.posts',
    // or...
    'slug.*' => UniqueTranslationRule::for('db_connection.posts'),
]);

☑️ 忽略具有ID的记录

如果您正在更新记录,您可能希望忽略唯一的检查。

$attributes = request()->validate([
    'slug.*' => "unique_translation:posts,slug,{$post->id}",
    // or...
    'slug.*' => UniqueTranslationRule::for('posts')->ignore($post->id),
]);

☑️ 忽略具有特定列和值的记录

如果您的ID列名称不同,或者您只是想使用其他列

$attributes = request()->validate([
    'slug.*' => 'unique_translation:posts,slug,ignore_value,ignore_column',
    // or...
    'slug.*' => UniqueTranslationRule::for('posts')->ignore('ignore_value', 'ignore_column'),
]);

☑️ 使用附加的where子句

您可以向规则添加4种类型的where子句。

where

$attributes = request()->validate([
    'slug.*' => "unique_translation:posts,slug,null,null,column,value",
    // or...
    'slug.*' => UniqueTranslationRule::for('posts')->where('column', 'value'),
]);

whereNot

$attributes = request()->validate([
    'slug.*' => "unique_translation:posts,slug,null,null,column,!value",
    // or...
    'slug.*' => UniqueTranslationRule::for('posts')->whereNot('column', 'value'),
]);

whereNull

$attributes = request()->validate([
    'slug.*' => "unique_translation:posts,slug,null,null,column,NULL",
    // or...
    'slug.*' => UniqueTranslationRule::for('posts')->whereNull('column'),
]);

whereNotNull

$attributes = request()->validate([
    'slug.*' => "unique_translation:posts,slug,null,null,column,NOT_NULL",
    // or...
    'slug.*' => UniqueTranslationRule::for('posts')->whereNotNull('column'),
]);

☑️ Laravel Nova

如果您正在使用与 Laravel Nova 结合的 spatie/nova-translatable,则可以添加如下验证规则:

Text::make(__('Slug'), 'slug')
  ->creationRules('unique_translation:posts,slug')
  ->updateRules('unique_translation:posts,slug,{{resourceId}}');

☑️ Filament

如果您正在使用与 Filament 结合的 filamentphp/spatie-laravel-translatable-plugin,则可以添加如下验证规则:

TextInput::make('slug')
  ->title(__('Slug'))
  ->rules([
    UniqueTranslationRule::for('posts', 'slug')
  ])
TextInput::make('slug')
  ->title(__('Slug'))
  ->rules([
    fn (Get $get) => UniqueTranslationRule::for('posts', 'slug')->ignore($get('id'))
  ])

🖥 示例

您现有 slug 列(JSON)在 posts 表中

{
  "en":"not-abc",
  "nl":"abc"
}

您用于创建新记录的表单输入

<input name="slug[en]" value="abc">
<input name="slug[nl]" value="abc">

您的验证逻辑

$attributes = request()->validate([
    'slug.*' => 'unique_translation:posts',
]);

结果是 slug[en] 是有效的,因为数据库中唯一的 en 值是 not-abc

slug[nl] 将会失败,因为已经存在一个值为 abcnl

⚠️ 错误信息

您可以通过常规方式传递自己的错误信息。

当验证单个表单字段时

<input name="slug">
$attributes = request()->validate([
    'slug' => 'unique_translation:posts',
], [
    'slug.unique_translation' => 'Your custom :attribute error.',
]);

在视图中,您可以使用 $errors->first('slug') 获取错误。

或当验证数组时

<input name="slug[en]">
$attributes = request()->validate([
    'slug.*' => 'unique_translation:posts',
], [
    'slug.*.unique_translation' => 'Your custom :attribute error.',
]);

在视图中,您可以使用 $errors->first('slug.en') 获取错误(en 是您的数组键)。

🚧 测试

vendor/bin/phpunit

☕️ 致谢

🔓 安全性

如果您发现任何与安全性相关的问题,请通过 电子邮件我,而不是使用问题跟踪器。

📑 更新日志

有关此包的所有显著变更的完整列表可以在 发布页面 上找到。

📜 许可证

MIT 许可证(MIT)。有关更多信息,请参阅 许可证文件