Laravel IN Validation or Validation by ENUM Values

Question

I'm initiating in Laravel. I searched and not found how to validate data with some ENUM values. On below code I need that type must be just DEFAULT or SOCIAL. One or other:

$validator = Validator::make(Input::only(['username', 'password', 'type']), [
    'type' => '', // DEFAULT or SOCIAL values
    'username' => 'required|min:6|max:255',
    'password' => 'required|min:6|max:255'
]);

Is possible?

score 173 · Accepted Answer · edited Dec 22 '21 at 14:25

173

in:DEFAULT,SOCIAL
The field under validation must be included in the given list of values.

not_in:DEFAULT,SOCIAL
The field under validation must not be included in the given list of values.

$validator = Validator::make(Input::only(['username', 'password', 'type']), [
    'type' => 'in:DEFAULT,SOCIAL', // DEFAULT or SOCIAL values
    'username' => 'required|min:6|max:255',
    'password' => 'required|min:6|max:255'
]);

edited Dec 22 '21 at 14:25

desertnaut

57,590
26
140
166

answered Mar 11 '15 at 02:46

Alupotha

9,710
4
47
48

2

how about using values with utf-8 chars ? – mirza Aug 06 '15 at 06:59
1

what about `Default`, `Social`, `DeFauLt`, `social`? – Justin Moh Aug 14 '15 at 09:22
@JustinMoh I belive that in and not_in validations must be the exactly values, for your case regex validation works fine. – Maykonn Mar 15 '16 at 14:09
@JustinMoh you can convert your request input into uppercase and validate. – Alupotha Oct 31 '17 at 23:03

Josh Bonnick · Answer 2 · 2023-02-21T13:39:34.747

65

Laravel 9+

https://laravel.com/docs/10.x/validation#rule-enum

use App\Enums\ServerStatus;
use Illuminate\Validation\Rules\Enum;
 
$request->validate([
    'status' => [new Enum(ServerStatus::class)],
]);

Enum:

namespace App\Enums;

enum ServerStatus: string {
    case ACTIVE = 'active';
    case INACTIVE = 'inactive';
}

Required PHP 8.1+

edited Feb 21 '23 at 13:39

answered Feb 09 '22 at 22:40

Josh Bonnick

2,281
1
10
21

1

please add how should the `ServerStatus` enum look like , is it a php enum or just an array ?! – Yasser CHENIK Feb 15 '22 at 13:21
1

@YasserCHENIK updated my answer to include enum example. – Josh Bonnick Feb 15 '22 at 15:06
Do you also know how to make the enum values case insensitive? – NicoHood May 23 '22 at 11:37
Commenting here to remember everyone to add the Accept: application/json header to your requests so you can receive a 422 error with it's respective message as otherwise you'll get a 404 or the base page. – Leonel Becerra May 19 '23 at 15:04

score 36 · Answer 3 · edited Dec 22 '21 at 14:25

36

The accepted answer is OK, but I want to add how to set the in rule to use existing constants or array of values.

So, if you have:

class MyClass {
  const DEFAULT = 'default';
  const SOCIAL = 'social';
  const WHATEVER = 'whatever';
  ...

You can make a validation rule by using Illuminate\Validation\Rule's in method:

'type' => Rule::in([MyClass::DEFAULT, MyClass::SOCIAL, MyClass::WHATEVER])

Or, if You have those values already grouped in an array, you can do:

class MyClass {
  const DEFAULT = 'default';
  const SOCIAL = 'social';
  const WHATEVER = 'whatever';
  public static $types = [self::DEFAULT, self::SOCIAL, self::WHATEVER];

and then write the rule as:

'type' => Rule::in(MyClass::$types)

edited Dec 22 '21 at 14:25

TylerH

20,799
66
75
101

answered Mar 22 '19 at 10:54

Aleksandar

3,558
1
39
42

where would you create and how would you name MyClass example in a Laravel project? – Marcelo Fonseca Mar 18 '20 at 19:43
2

@MarceloFonseca you could put these fields on a Model class, or separate them into their own class. In OP's example, I guess the separate class could be called `Login` or `LoginType`. [Here (link)](https://stackoverflow.com/a/25705982/2101117) is an example of where and how can you create enums. That might also help :) – Aleksandar Mar 19 '20 at 08:51

Alexander Ramos · Answer 4 · 2021-09-03T07:39:52.930

You can use the Rule class as te documentation indicates. For example, having the following definition in a migration:

$table->enum('letter',['a','b','c']);

Now your rules for your FormRequest should put:

class CheckInRequest extends FormRequest
{ 
    public function authorize()
    {
        return true;
    }


    public function rules()
    {
        return [
            'letter'=>[
                'required',
                 Rule::in(['a', 'b','c']),
             ],
        ];
    }
}

Where Rule::in (['a', 'b', 'c']), must contain the values of your field of type "enun"

This is working fine for me on Laravel 8.x

score 2 · Answer 5 · answered Feb 18 '22 at 05:13

Laravel 9 php8.1

$request->validate([
    'type' => [new Enum(TypeEnum::class)],
]);

Less or Equal php 8

you can own enum

class BaseEnum
{
    /**
     * Returns class constant values
     * @return array
     */
    public static function toArray(): array
    {
        $class = new \ReflectionClass(static::class);

        return array_values($class->getConstants());
    }

    /**
     * @return string
     */
    public function __toString(): string
    {
        return implode(',', static::toArray());
    }
}

Child enum

class TypeEnum extends BaseEnum
{
    public const DEFAULT = 'default';
    public const SOCIAL = 'social';
}

in validation u can use it in two different ways

first

$request->validate([
        'type' => 'in:' . new TypeEnum(),
    ]);

second

use Illuminate\Validation\Rule;

    $request->validate([
                'type' => Rule::in(TypeEnum::toArray())
            ]);

score 0 · Answer 6 · answered Jun 06 '22 at 19:53

0

Laravel

//migration
    $table->enum('type',[true, false])->default(true);

//controller
    $request->validate([
       'type' => ['required','in:true,false']
    ]);

answered Jun 06 '22 at 19:53

ali hassan

321
2
5

Laravel IN Validation or Validation by ENUM Values

6 Answers6

Laravel 9+

Linked