【Laravel5.4】sometimes validationの動作について

Question

質問

Laravel5.4でsometimes validationをつける際に、以下の3つの場合で動作の違いがあるか確認したく、質問致しました。

1. email => 'sometimes|required|email'
2. email => 'sometimes|email'
3. email => 'email'

sometimes制約の認識としては、与えたinput配列にfield(今回だとemail)があったときだけvalidationが走るというものだと思っています。
しかし、公式ドキュメントを見ると、以下のように sometiems|requied|email というようにrequired制約もついています。requiredは入力にfieldがチェックするものなので、 sometimes がついていれば必要ないように感じます。
また、 sometimes制約もつけなくても(パターン3)場合も、入力に指定したfield(email)がなければvalidationは走らないと思います。

sometimes制約の正しい書き方と、各パターンに動作の違いがあればご教授頂きたいです。
よろしくお願いいたしますm(__)m

$v = Validator::make($data, [
    'email' => 'sometimes|required|email',
]);

補足

実際に以下のメソッドをEloquentに追加して php artisan tinker で、以下の2つを試してみましたが各パターンのValidation結果に違いはありませんでした。

1. 入力にfieldがある場合の3パターン
2. 入力にfieldがない場合の3パターン

  public function validation_test() {
      $inputs =  [
          'id' => 1,
        ];

      $rules = [
          'email' => 'sometimes|required|email',
        ];

      $validator = \Validator::make($inputs, $rules);

      if ($validator->fails()) {
          return $validator->errors()->all();
      } elseif ($validator->passes()) {
          return $this->create($inputs);
      }

  }

Answer 1

確かに、sometimesについては、配列に値が無い場合にvalidateの対象外とします。
一方、emailについては、空文字ではエラーにはなりません。
よって、下記のケースはエラーとはなりません

$inputs =  [
     'id' => 1,
     'email' => ''
];
$rules = [
     'email' => 'sometimes|email',
];

emailフィールドがあったときに入力必須にしたい場合には、'sometimes|required|email'が必要となるのです。

ただ、email => 'sometimes|email'とemail => 'email'については、結果的に同じ動作をすると思います。この様な単純なケースにおいてはsometimesを使うメリットはあまりないと理解しています。

Comments

[uramot]

ご回答ありがとうございます！
email制約だと、空文字だとvalidation通ってしまうので`sometimes|required`とする必要があるんですね。required制約の動作で勘違いしていた部分があったみたいです。ありがとうございます！

また、 `email => sometimes|email` と `email => email` は同じ動作になるのですね。`sometimes` は基本的に `required` とセットで使うという認識で良いですかね。

Answer 2

何が正しいかはどういう動作を期待するかによるのでなんともいえませんが、sometimesはパラメタが存在するときのみチェックをするという指定で、パラメタがなければたとえrequiredが指定されていてもOKになります(requiredより優先します)。

emailパラメタがそもそも存在しない場合、nullの場合、空文字列の場合、正しい場合でそれぞれの条件での結果を表示するプログラムと実行結果を示しますので参考にしてください。

    public static function validation_test() {
        $inputs = [
            'missing' => [],
            'null'    => ['email' => null],
            'empty'   => ['email' => ''],
            'valid'   => ['email' => '[e-mail]'],
        ];

        $rules = [
            'sometimes|required|email',
            'required|email',
            'email',
        ];

        foreach ($rules as $r) {
            printf("%s\n", $r);
            foreach ($inputs as $name => $i) {
                $validator = \Validator::make($i, ['email' => $r]);
                printf(
                    "    %-7s %s\n",
                    $name,
                    $validator->fails()? implode(',', $validator->errors()->all()): 'ok'
                ) ;
            }
            printf("\n");
        }
    }

sometimes|required|email
    missing ok
    null    The email field is required.
    empty   The email field is required.
    valid   ok

required|email
    missing The email field is required.
    null    The email field is required.
    empty   The email field is required.
    valid   ok

email
    missing ok
    null    The email must be a valid email address.
    empty   ok
    valid   ok

Comments

[uramot]

とても丁寧に、テストコードと結果まで添付していただいてありがとうございます！
sometimes|required|email|, |sometimes|email|, |email|でvalidation結果に違いがでるのがひと目でわかりました。ありがとうございますm(__)m