https://github.com/codezero-be/laravel-unique-translation
⭐️ Check if a translated value in a JSON column is unique in the database.
https://github.com/codezero-be/laravel-unique-translation
database json language laravel mysql php rule translation unique validation validator
Last synced: about 1 month ago
JSON representation
⭐️ Check if a translated value in a JSON column is unique in the database.
- Host: GitHub
- URL: https://github.com/codezero-be/laravel-unique-translation
- Owner: codezero-be
- License: mit
- Created: 2017-10-17T20:42:08.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-04-17T08:30:59.000Z (about 1 year ago)
- Last Synced: 2025-04-03T23:11:46.435Z (about 2 months ago)
- Topics: database, json, language, laravel, mysql, php, rule, translation, unique, validation, validator
- Language: PHP
- Homepage:
- Size: 77.1 KB
- Stars: 188
- Watchers: 7
- Forks: 25
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# Laravel Unique Translation
## IMPORTANT: March 2022
[](https://github.com/hampusborgos/country-flags/blob/main/png100px/ua.png)
It's horrible to see what is happening now in Ukraine, as Russian army is
[bombarding houses, hospitals and kindergartens](https://twitter.com/DavidCornDC/status/1501620037785997316).
Please [check out supportukrainenow.org](https://supportukrainenow.org/) for the ways how you can help people there.
Spread the word.
And if you are from Russia and you are against this war, please express your protest in some way.
I know you can get punished for this, but you are one of the hopes of those innocent people.
---
[](https://github.com/codezero-be/laravel-unique-translation/releases)
[](https://laravel.com)
[](LICENSE.md)
[](https://github.com/codezero-be/laravel-unique-translation/actions)
[](https://app.codacy.com/gh/codezero-be/laravel-unique-translation)
[](https://app.codacy.com/gh/codezero-be/laravel-unique-translation)
[](https://packagist.org/packages/codezero/laravel-unique-translation)
[](https://ko-fi.com/R6R3UQ8V)
#### Check if a translated value in a JSON column is unique in the database.
Imagine you want store a `slug` for a `Post` model in different languages.
The amazing [`spatie/laravel-translatable`](https://github.com/spatie/laravel-translatable) package makes this a cinch!
But then you want to make sure each translation is unique for its language.
That's where this package comes in to play.
This package also supports [`spatie/nova-translatable`](https://github.com/spatie/nova-translatable/) in case you are using [Laravel Nova](https://nova.laravel.com/) and [`filamentphp/spatie-laravel-translatable-plugin`](https://github.com/filamentphp/spatie-laravel-translatable-plugin) in case you are using [Filament](https://filamentphp.com/).
## ✅ Requirements
- PHP ^7.2 or PHP ^8.0
- MySQL >= 5.7
- [Laravel](https://laravel.com/) >= 6
- [spatie/laravel-translatable](https://github.com/spatie/laravel-translatable) ^4.4|^5.0|^6.0
- [spatie/nova-translatable](https://github.com/spatie/nova-translatable/) ^3.0
- [filamentphp/spatie-laravel-translatable-plugin](https://github.com/filamentphp/spatie-laravel-translatable-plugin) ^3.0
## 📦 Installation
Require the package via Composer:
```
composer require codezero/laravel-unique-translation
```
Laravel will automatically register the [ServiceProvider](https://github.com/codezero-be/laravel-unique-translation/blob/master/src/UniqueTranslationServiceProvider.php).
## 🛠 Usage
For the following examples, I will use a `slug` in a `posts` table as the subject of our validation.
### ☑️ Validate a Single Translation
Your form can submit a single slug:
```html
```
We can then check if it is unique **in the current locale**:
```php
$attributes = request()->validate([
'slug' => 'required|unique_translation:posts',
]);
```
You could also use the Rule instance:
```php
use CodeZero\UniqueTranslation\UniqueTranslationRule;
$attributes = request()->validate([
'slug' => ['required', UniqueTranslationRule::for('posts')],
]);
```
### ☑️ Validate an Array of Translations
Your form can also submit an array of slugs.
```html
```
We need to validate the entire array in this case. Mind the `slug.*` key.
```php
$attributes = request()->validate([
'slug.*' => 'unique_translation:posts',
// or...
'slug.*' => UniqueTranslationRule::for('posts'),
]);
```
### ☑️ Specify a Column
Maybe your form field has a name of `post_slug` and your database field `slug`:
```php
$attributes = request()->validate([
'post_slug.*' => 'unique_translation:posts,slug',
// or...
'post_slug.*' => UniqueTranslationRule::for('posts', 'slug'),
]);
```
### ☑️ Specify a Database Connection
If you are using multiple database connections, you can specify which one to use by prepending it to the table name, separated by a dot:
```php
$attributes = request()->validate([
'slug.*' => 'unique_translation:db_connection.posts',
// or...
'slug.*' => UniqueTranslationRule::for('db_connection.posts'),
]);
```
### ☑️ Ignore a Record with ID
If you're updating a record, you may want to ignore the post itself from the unique check.
```php
$attributes = request()->validate([
'slug.*' => "unique_translation:posts,slug,{$post->id}",
// or...
'slug.*' => UniqueTranslationRule::for('posts')->ignore($post->id),
]);
```
### ☑️ Ignore Records with a Specific Column and Value
If your ID column has a different name, or you just want to use another column:
```php
$attributes = request()->validate([
'slug.*' => 'unique_translation:posts,slug,ignore_value,ignore_column',
// or...
'slug.*' => UniqueTranslationRule::for('posts')->ignore('ignore_value', 'ignore_column'),
]);
```
### ☑️ Use Additional Where Clauses
You can add 4 types of where clauses to the rule.
#### `where`
```php
$attributes = request()->validate([
'slug.*' => "unique_translation:posts,slug,null,null,column,value",
// or...
'slug.*' => UniqueTranslationRule::for('posts')->where('column', 'value'),
]);
```
#### `whereNot`
```php
$attributes = request()->validate([
'slug.*' => "unique_translation:posts,slug,null,null,column,!value",
// or...
'slug.*' => UniqueTranslationRule::for('posts')->whereNot('column', 'value'),
]);
```
#### `whereNull`
```php
$attributes = request()->validate([
'slug.*' => "unique_translation:posts,slug,null,null,column,NULL",
// or...
'slug.*' => UniqueTranslationRule::for('posts')->whereNull('column'),
]);
```
#### `whereNotNull`
```php
$attributes = request()->validate([
'slug.*' => "unique_translation:posts,slug,null,null,column,NOT_NULL",
// or...
'slug.*' => UniqueTranslationRule::for('posts')->whereNotNull('column'),
]);
```
### ☑️ Laravel Nova
If you are using [Laravel Nova](https://nova.laravel.com/) in combination with [`spatie/nova-translatable`](https://github.com/spatie/nova-translatable/), then you can add the validation rule like this:
```php
Text::make(__('Slug'), 'slug')
->creationRules('unique_translation:posts,slug')
->updateRules('unique_translation:posts,slug,{{resourceId}}');
```
### ☑️ Filament
If you are using [Filament](https://filamentphp.com/) in combination with [`filamentphp/spatie-laravel-translatable-plugin`](https://github.com/filamentphp/spatie-laravel-translatable-plugin), then you can add the validation rule like this:
```php
TextInput::make('slug')
->title(__('Slug'))
->rules([
UniqueTranslationRule::for('posts', 'slug')
])
```
```php
TextInput::make('slug')
->title(__('Slug'))
->rules([
fn (Get $get) => UniqueTranslationRule::for('posts', 'slug')->ignore($get('id'))
])
```
## 🖥 Example
Your existing `slug` column (JSON) in a `posts` table:
```json
{
"en":"not-abc",
"nl":"abc"
}
```
Your form input to create a new record:
```html
```
Your validation logic:
```php
$attributes = request()->validate([
'slug.*' => 'unique_translation:posts',
]);
```
The result is that `slug[en]` is valid, since the only `en` value in the database is `not-abc`.
And `slug[nl]` would fail, because there already is a `nl` value of `abc`.
## ⚠️ Error Messages
You can pass your own error messages as normal.
When validating a single form field:
```html
```
```php
$attributes = request()->validate([
'slug' => 'unique_translation:posts',
], [
'slug.unique_translation' => 'Your custom :attribute error.',
]);
```
In your view you can then get the error with `$errors->first('slug')`.
Or when validation an array:
```html
```
```php
$attributes = request()->validate([
'slug.*' => 'unique_translation:posts',
], [
'slug.*.unique_translation' => 'Your custom :attribute error.',
]);
```
In your view you can then get the error with `$errors->first('slug.en')` (`en` being your array key).
## 🚧 Testing
```
vendor/bin/phpunit
```
## ☕️ Credits
- [Ivan Vermeyen](https://byterider.io)
- [All contributors](../../contributors)
## 🔓 Security
If you discover any security related issues, please [e-mail me](mailto:[email protected]) instead of using the issue tracker.
## 📑 Changelog
A complete list of all notable changes to this package can be found on the
[releases page](https://github.com/codezero-be/laravel-unique-translation/releases).
## 📜 License
The MIT License (MIT). Please see [License File](https://github.com/codezero-be/laravel-unique-translation/blob/master/LICENSE.md) for more information.