eastree/uniquewith-validator

Custom Laravel Validator for combined unique indexes

unique_with Validator Rule For Laravel

, _(*1)

This package contains a variant of the validateUnique rule for Laravel, that allows for validation of multi-column UNIQUE indexes., _(*2)

Documentation for older versions

• Laravel 4

Installation

Install the package through Composer. On the command line:, _(*3)

composer require felixkiss/uniquewith-validator

Configuration

Add the following to your providers array in config/app.php:, _(*4)

'providers' => [
    // ...

    Felixkiss\UniqueWithValidator\ServiceProvider::class,
],

Usage

Use it like any Validator rule:, _(*5)

$rules = [
    '<field1>' => 'unique_with:<table>,<field2>[,<field3>,...,<ignore_rowid>]',
];

See the Validation documentation of Laravel., _(*6)

Specify different column names in the database

If your input field names are different from the corresponding database columns, you can specify the column names explicitly., _(*7)

e.g. your input contains a field 'last_name', but the column in your database is called 'sur_name':, _(*8)

$rules = [
    'first_name' => 'unique_with:users, middle_name, last_name = sur_name',
];

Example

Pretend you have a users table in your database plus User model like this:, _(*9)

<?php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;

class CreateUsersTable extends Migration {

    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::create('users', function(Blueprint $table) {
            $table->increments('id');

            $table->timestamps();

            $table->string('first_name');
            $table->string('last_name');

            $table->unique(['first_name', 'last_name']);
        });
    }

    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        Schema::drop('users');
    }

}

<?php

class User extends Eloquent { }

Now you can validate a given first_name, last_name combination with something like this:, _(*10)

Route::post('test', function() {
    $rules = [
        'first_name' => 'required|unique_with:users,last_name',
        'last_name' => 'required',
    ];

    $validator = Validator::make(Input::all(), $rules);

    if($validator->fails()) {
        return Redirect::back()->withErrors($validator);
    }

    $user = new User;
    $user->first_name = Input::get('first_name');
    $user->last_name = Input::get('last_name');
    $user->save();

    return Redirect::home()->with('success', 'User created!');
});

You can also specify a row id to ignore (useful to solve unique constraint when updating), _(*11)

This will ignore row with id 2, _(*12)

$rules = [
    'first_name' => 'required|unique_with:users,last_name,2',
    'last_name' => 'required',
];

To specify a custom column name for the id, pass it like, _(*13)

$rules = [
    'first_name' => 'required|unique_with:users,last_name,2 = custom_id_column',
    'last_name' => 'required',
];

If your id is not numeric, you can tell the validator, _(*14)

$rules = [
    'first_name' => 'required|unique_with:users,last_name,ignore:abc123',
    'last_name' => 'required',
];

You can also set additional clauses. For example, if your model uses soft deleting then you can use the following code to select all existing rows but marked as deleted, _(*15)

$rules = [
    'first_name' => 'required|unique_with:users,last_name,deleted_at,2 = custom_id_column',
    'last_name' => 'required',
];

License

MIT, _(*16)