Validation

Validating a request with admin model rules

Model::validator() builds Laravel validation rules from the fields of the admin model and returns the data mutated the same way as the admin form does it (checkboxes become 0/1, empty strings null, files are uploaded, locale values are cleaned). The rules come from the field definitions, see validation rules.

app/Http/Controllers/CustomerController.php

<?php

namespace App\Http\Controllers;

use App\Models\Customer;

class CustomerController extends Controller
{
    public function register()
    {
        $data = Customer::validator()
            ->only(['username', 'email', 'password'])
            ->merge(['terms' => 'required|accepted'])
            ->validate()
            ->getData();

        return Customer::create($data);
    }
}

validate() throws a validation exception. A JSON request receives the standard 422 response with errors, other requests are redirected back with errors in session. The current request is used by default, pass another one with Customer::validator($request). The same method exists on a model instance, $customer->validator().

Supported methods

`only`

Validates and returns only given fields. A key with rules also merges the rules.

Customer::validator()->only(['username', 'email', 'phone' => 'required'])->validate()->getData();

`merge`

Adds rules. A new key adds a field which is not in the model (it is also returned by getData()), an existing key appends rules to the model rules.

Customer::validator()->merge([
    'terms' => 'required|accepted',
    'phone' => 'required',
])->validate();

`replace`

Replaces the model rules of given fields.

Customer::validator()->replace([
    'username' => 'required|max:10',
])->validate();

`validate`

Validates the request and returns the validator for chaining.

`getData`

Returns validated keys only, mutated by the admin request mutators.

$data = Customer::validator()->validate()->getData();

`get`

Returns one mutated value, with an optional default.

$email = Customer::validator()->validate()->get('email', 'unknown@example.com');

`fill`

Fills the model with validated data, additional attributes can be passed.

$customer = Customer::validator()->validate()->fill(['source' => 'web']);
$customer->save();

`use`

Applies an Admin Request class.

use App\Http\Requests\CustomerRequest;

Customer::validator()->use(CustomerRequest::class)->validate()->getData();

Validating with `validateRequest()`

validateRequest() is a shorter form which validates the current request with the field rules and returns the data mutated the same way as the admin form does.

app/Http/Controllers/ContactController.php

public function send()
{
    $data = Contact::validateRequest([
        'name',
        'email',
        'message',
        'terms' => 'required|accepted', // key => rules replaces the rules of a field or adds a new one
    ]);

    return Contact::create($data);
}

Argument	Description
`$fields`	list of validated keys, a `key => rules` pair replaces or adds rules, `null` validates all fields
`$except`	keys removed from validation
`$mutators`	`false` only validates, no data is returned
`$row`	row passed into `fields($row)`, an existing model uses itself: `$contact->validateRequest()`

Mutated values are merged back into request(). A JSON request receives 422 with errors, other requests are redirected back with errors in session. Translatable fields listed in $fields are validated in every language. The rules of a model are available as an array:

Contact::make()->getValidationRules();   // rules for a new record
$contact->getValidationRules($contact);  // rules for an existing record

Fields without required get nullable, locale fields are validated as name.en (required only in the default language), multiple files as photos.*, and a required file field is optional when the record already has a file. Fields are resolved for the given row only when the model reads it in fields($row), or when one of its modules does, such as the unique rule of a slug column. Override hasRowDependentFields() and return true in a model building its fields per record in another way. One validator instance builds its rules and mutated data once. A change through only(), merge() or replace() builds them again, so the request mutators, including file uploads, run once per state.

Getting started

Upgrade guide

Admin interface

Frontend

Website

Validation

Validating a request with admin model rules

Supported methods

`only`

`merge`

`replace`

`validate`

`getData`

`get`

`fill`

`use`

Validating with `validateRequest()`

​Validating a request with admin model rules

​Supported methods

​only

​merge

​replace

​validate

​getData

​get

​fill

​use

​Validating with validateRequest()

Validating a request with admin model rules

Supported methods

`only`

`merge`

`replace`

`validate`

`getData`

`get`

`fill`

`use`

Validating with `validateRequest()`