[5.6] Ignore a given model during a unique check.

[Alymosul]

This PR adds the ability to ignore a given model during a unique validation rule check instead of passing the column's value and name to the ignore() method, we can pass the actual model to the ignore and by default the rule will grab the primary key name and value for the model. Also it adds the ability to select a custom column and the corresponding value will be retrieved from the model.

Let's Consider we have a Company model that we need to update it's name and the company names should be unique, therefore the validation rule will be as follows

Currently:

$rules = [
            'name' => [
                'required',
                Rule::unique('companies', 'name')->ignore($this->company->id);
            ],
        ];

// Let's say we need to select a custom idColumn

$rules = [
            'name' => [
                'required',
                Rule::unique('companies', 'name')->ignore($this->company->slug, 'slug');
            ],
        ];

Proposed:

$rules = [
            'name' => [
                'required',
                Rule::unique('companies', 'name')->ignore($this->company);
            ],
        ];

// Let's say we need to select a custom idColumn

$rules = [
            'name' => [
                'required',
                Rule::unique('companies', 'name')->ignore($this->company, 'slug');
            ],
        ];

// Also we can use more expressive method

$rules = [
            'name' => [
                'required',
                Rule::unique('companies', 'name')->ignoreModel($this->company);
            ],
        ];

Note:

this line $this->idColumn = $idColumn?? 'id'; has been added to the ignore() method to avoid breaking old laravel releases.

[taylorotwell]

Can you explain why this is needed?

[Alymosul]

because we removed the default value for the protected $idColumn; and the __toString() need string conversion for the variables

[taylorotwell]

Why?

[Alymosul]

I don't know, it was wrongly added. Sorry for that.

[taylorotwell]

It makes me uncomfortable having to change an old test to add this feature.

[Alymosul]

I think we don't need the default value for the idColumn that's why i had to change the test here, because we really don't need the 'id' since the ignore is NULL. but I can revert this change and still the feature will pass.

[taylorotwell]

OK please don't change that test.

[Alymosul]

Done, Sorry for that 👍