Request on ララジャパン

チェックボックスの入力値 - mergeIfMissing()

Sat, 09 Jul 2022 00:21:25 +0900

以前の投稿「FormRequestで入力値を補正」でチェックボックスがオフのときの値の補正に関して説明しました。今度はFormRequestを使わないときの補正の仕方です。

このような入力画面があるとします。

それを受けるコントローラのメソッドを以下とすると、

...
    public function update(Request $request, Customer $customer)
    {
　　    $validated = $request->validate([
              'active_flag' => ['nullable'],
              'email'       => ['required', 'email', 'unique:customer,email'],
              'name'        => ['required'],
              'name_kana'   => ['required'],
　　　　]);

        dd($validated);
    }
...

このような配列が返ってきます。

[
    'active_flag' => 'Y',
    'email' => 'test@example.com',
    'name'  => 'テスト太郎',
    'name_kana' => 'てすとたろう',
]

しかし、先のチェックボックス「有効」がオフだとすると、

[
    'email' => 'test@example.com',
    'name'  => 'テスト太郎',
    'name_kana' => 'てすとたろう',
]

と、active_flagの項目はリクエストには存在しません。チェックボックスがオフだとブラウザはサーバーに何も返さないからです。

しかし、それをコントローラで判断してDBに無効（この場合N）を保存したいです。

そのような場合は、RequestのメソッドのmergeIfMissing()を使います。オフのときの値を引数として与えます。複数の項目の指定も可能です。

...
    public function update(Request $request, Customer $customer)
    {
        $request->mergeIfMissing(['active_flag' => 'N']); // デフォルトの値を設定！

        $validated = $request->validate([
              'active_flag' => ['required', 'In:Y,N'], // 必須と値を確認！
              'email'       => ['required', 'email', 'unique:customer,email'],
              'name'        => ['required'],
              'name_kana'   => ['required'],
　　　　]);

        dd($validated);
    }
...

値は補正されて、期待通りにNが入ってきます。上のバリデーションルールで見られるように、値が必須であること、値がYあるいはNであることもチェックできます。

[
    'active_flag' => 'N',
    'email' => 'test@example.com',
    'name'  => 'テスト太郎',
    'name_kana' => 'てすとたろう',
]

request()ヘルパーが変？

Sun, 29 Aug 2021 05:37:09 +0900

以前に「ティンカーでリクエスト（Request）」で、ティンカーにおいてRequestのオブジェクトをシミュレートできることを紹介しました。あれから数年、ヘルパー関数のrequest()にもティンカーで値を追加できる技を取得しました。

request()に値がない

まず、以前のティンカーでのRequestオブジェクトの作成をここで再現します。

Psy Shell v0.10.8 (PHP 7.4.21 — cli) by Justin Hileman
>>>  $request = \Illuminate\Http\Request::create('http://localhost', 'GET', ['name' => 'test']);
=> Illuminate\Http\Request {#5238
     +attributes: Symfony\Component\HttpFoundation\ParameterBag {#5234},
     +request: Symfony\Component\HttpFoundation\InputBag {#5236},
     +query: Symfony\Component\HttpFoundation\InputBag {#5235},
     +server: Symfony\Component\HttpFoundation\ServerBag {#5231},
     +files: Symfony\Component\HttpFoundation\FileBag {#5232},
     +cookies: Symfony\Component\HttpFoundation\InputBag {#5233},
     +headers: Symfony\Component\HttpFoundation\HeaderBag {#5230},
   }
>>>  $request->all()
=> [
     "name" => "test",
   ]
>>> $request->name
=> "test"
>>>

そして、このRequestオブジェクトを利用して簡単にバリデーションのテストもできます。

>>> $request->validate(['name' => 'required|alpha'])
=> [
     "name" => "test",
   ]
>>> $request->validate(['name' => 'required|numeric'])
Illuminate\Validation\ValidationException with message 'The given data was invalid.'
>>>

しかし、このオブジェクトでは、ヘルバーを使うと期待した値が返ってきません。

>>> request('name')
=> null　// "test"と返ってきて欲しい！

どうしてでしょう？

グローバルのRequestオブジェクト

request()の定義を見ると、

vendor/laravel/framework/src/Illuminate/Foundation/helpers.php

...
    /**
     * Get an instance of the current request or an input item from the request.
     *
     * @param  array|string|null  $key
     * @param  mixed  $default
     * @return \Illuminate\Http\Request|string|array
     */
    function request($key = null, $default = null)
    {
        if (is_null($key)) {
            return app('request');
        }

        if (is_array($key)) {
            return app('request')->only($key);
        }

        $value = app('request')->__get($key);

        return is_null($value) ? value($default) : $value;
    }
...

app(‘request’)というのがヘルパーで使用しているRequestのオブジェクトのようです。ティンカーでタイプしてみると、

>>> app('request');
=> Illuminate\Http\Request {#77
     +attributes: Symfony\Component\HttpFoundation\ParameterBag {#68},
     +request: Symfony\Component\HttpFoundation\InputBag {#70},
     +query: Symfony\Component\HttpFoundation\InputBag {#65},
     +server: Symfony\Component\HttpFoundation\ServerBag {#69},
     +files: Symfony\Component\HttpFoundation\FileBag {#74},
     +cookies: Symfony\Component\HttpFoundation\InputBag {#73},
     +headers: Symfony\Component\HttpFoundation\HeaderBag {#76},
   }

先に作成したRequestのオブジェクトのIDは、#5238なのにこちらは#77で、Laravelのプログラムの実行（ティンカーの実行）のかなり初期に作成されたオブジェクトということがわかります。そして、そのオブジェクトはLaravelがサービスコンテナーとして管理するグローバルにアクセス可能なRequestのオブジェクトです。

そして、以下のようにこのオブジェクトに値を追加することも可能なのです。

>>> app('request')->all();
=> []
>>> app('request')->merge(['name' => 'test']);
=> Illuminate\Http\Request {#77
     +attributes: Symfony\Component\HttpFoundation\ParameterBag {#68},
     +request: Symfony\Component\HttpFoundation\InputBag {#70},
     +query: Symfony\Component\HttpFoundation\InputBag {#65},
     +server: Symfony\Component\HttpFoundation\ServerBag {#69},
     +files: Symfony\Component\HttpFoundation\FileBag {#74},
     +cookies: Symfony\Component\HttpFoundation\InputBag {#73},
     +headers: Symfony\Component\HttpFoundation\HeaderBag {#76},
   }
>>> app('request')->all();
=> [
     "name" => "test",
   ]
>>> app('request')->name
=> "test"

そして、ヘルパーでも値を取得できるようになります。

>>> request('name')
=> "test"

Laravel 5.6で追加されたバリデーション

Sat, 23 Mar 2019 00:58:11 +0900

私が使用しているLaravelのバージョンは5.5、ついこの前にリリースされたと思いきや、なんと8/30/2017のことらしくもう1年半以上も経過。LTSということで2年間の長期サポートだからのんびりとしていたら、もうこの夏でサポートの期限切れです。キャッチアップ、ということで去年の2月にリリースされた5.6バージョン（しかし、もうサポートされていない）に追加されたバリデーションをチェックします。

これが、5.6のバリデーションの一覧です。ブルーでハイライトしているのが5.5にはなく5.6に追加されたバリデーションです。

追加されたもので、すぐに使えそうなものは、

Greater Than gt Greater Than Or Equal　gte Less Than　lt Less Than Or Equal　lte

早速使ってみましょう。validator()はLaravelのヘルパーですが、こちらも読んでください。

Psy Shell v0.9.9 (PHP 7.1.14 — cli) by Justin Hileman
>>> $input = ['quantity' => 5];
=> [
     "quantity" => 5,
   ]
>>> validator($input, ['quantity' => 'required|integer|gt:4'])->errors()->all();
=> []
>>> validator($input, ['quantity' => 'required|integer|gt:5'])->errors()->all();
=> [
     "The quantity must be greater than 0.",
   ]
>>> validator($input, ['quantity' => 'required|integer|gte:5'])->errors()->all();
=> []
>>> validator($input, ['quantity' => 'required|integer|lt:6'])->errors()->all();
=> []
>>> validator($input, ['quantity' => 'required|integer|lte:5'])->errors()->all();
=> []

ちなみに、これらがない5.5では、以下のようにmin, max, not_inを組み合わせて同じようなバリデーションが可能です。

>>> validator($input, ['quantity' => 'required|integer|min:5'])->errors()->all();
=> []
>>> validator($input, ['quantity' => 'required|integer|min:5|not_in:5'])->errors()->all();
=> [
     "The selected quantity is invalid.",
   ]

しかし、このメッセージでわかりにくいので、

>>> validator($input, ['quantity' => 'required|integer|min:5|not_in:5'], ['not_in' => 'The quantity must be greater than :input.'])->errors()->all();
=> [
     "The quantity must be greater than 5.",
   ]

と、カスタムメッセージを与える必要あります。面倒ですね。

ティンカーでリクエスト（Request）

Sat, 09 Jun 2018 09:00:44 +0900

前回に引き続いてリクエストの話です。ブラウザがないとリクエスト（Request）のオブジェクトが作成できない、とは限りません。Laravelならコマンドラインで作成できます。どうやって？

リクエストオブジェクトの作成

コマンドラインと言えばもちろん、tinkerのことです。以下のように、クラスのcreate()メソッドを使って、リクエストのオブジェクトを作成できます。

Psy Shell v0.9.3 (PHP 7.1.14 — cli) by Justin Hileman

>>> $request = \Illuminate\Http\Request::create('http://localhost', 'GET', ['name' => 'test']);

=> Illuminate\Http\Request {#2324
     ⚠: Symfony\Component\VarDumper\Exception\ThrowingCasterException {#2309
       #message: "Unexpected ErrorException thrown from a caster: Undefined index: ",
     },
     +attributes: Symfony\Component\HttpFoundation\ParameterBag {#2320},
     +request: Symfony\Component\HttpFoundation\ParameterBag {#2322},
     +query: Symfony\Component\HttpFoundation\ParameterBag {#2321},
     +server: Symfony\Component\HttpFoundation\ServerBag {#2317},
     +files: Symfony\Component\HttpFoundation\FileBag {#2318},
     +cookies: Symfony\Component\HttpFoundation\ParameterBag {#2319},
     +headers: Symfony\Component\HttpFoundation\HeaderBag {#2316},
   }

Laravelのリクエストは、Symfonyのクラスがベースになっているようです。createは、Laravelのクラスのメソッドではなく、Symfonyのクラスのメソッドです。参考のために、以下にその定義の一部を掲載します。

SymfonyComponentHttpFoundationRequest.php

    /**
     * Creates a Request based on a given URI and configuration.
     *
     * The information contained in the URI always take precedence
     * over the other information (server and parameters).
     *
     * @param string               $uri        The URI
     * @param string               $method     The HTTP method
     * @param array                $parameters The query (GET) or request (POST) parameters
     * @param array                $cookies    The request cookies ($_COOKIE)
     * @param array                $files      The request files ($_FILES)
     * @param array                $server     The server parameters ($_SERVER)
     * @param string|resource|null $content    The raw body data
     *
     * @return static
     */
    public static function create($uri, $method = 'GET', $parameters = array(), $cookies = array(), $files = array(), $server = array(), $content = null)
    {
    ..

先のtinkerの実行では、create()の3番目のパラメータに、連想配列で値（[’name’ => ’test’]）を渡しました。ということは、以下のtinkerの実行で変数の取り出し可能です。

>>> $request->all();

=> [
     "name" => "test",
   ]

>>> $request->input();

=> [
     "name" => "test",
   ]

>>> $request->name;

=> "test"

>>> $request->input('name');

=> "test"

>>> $request->get('name');

=> "test"
>>>

前回に説明したことが、ここで簡単にシミュレートできるのです。

そして、さらに、こんなこともテストできます。簡単なValidationのテストです。

>>> $request->validate(['name' => 'required']);

=> [
     "name" => "test",
   ]

>>> $request->validate(['name' => 'required|alpha']);

=> [
     "name" => "test",
   ]

>>> $request->validate(['name' => 'alpha']);
=> [
     "name" => "test",
   ]

>>> $request->validate(['name' => 'numeric']);
Illuminate/Validation/ValidationException with message 'The given data was invalid.'
>>>

Validationに成功したら、入力の連想配列を返し、失敗したらValidationExceptionを返します。

tinkerの便利さは、いちいちプログラムを書かずに、ブラウザを立ち上げることなしに、テストできることです。こんな便利なツールを習得せずに、Laravelを語ることはできません。