L7.x on ララジャパン

EloquentとQuery Builderのvalue()の違い

Tue, 26 Jul 2022 23:31:57 +0900

Eloquentでクエリする際も内部的にはクエリビルダのメソッドをcallしている事が多いので、何も考えずにクエリビルダで出来ていた事をそのままEloquentで実行していたらハマってしまいました、落とし穴に。おかげで「なるほど、そういう事もあるのだな」位の心構えができるようになりました。今回はそんな気づきを与えてくれたvalue()についての解説です。

value()とは？

value()はクエリの最初の結果から特定の項目のみ取得して返してくれる便利なメソッドです。DBからfetchするレコードが１つだと分かっていて、且つ、特定の１項目のみが必要な場合などに重宝します。

例えば、ユーザの名前と生年月日の組み合わせがユニークであり、そのemailを取得したい場合は

$email = DB::table('user')
    ->where('name', '=', '山田太郎')
    ->where('birthday', '=', '1970-01-01')
    ->value('email');
>>> "y.taro@sample.com"

と書けば一発で取得できます。上記はクエリビルダでの取得ですが、Eloquentでも同様にvalue()を使うことが出来ます。

$email = User::query()
    ->where('name', '=', '山田太郎')
    ->where('birthday', '=', '1970-01-01')
    ->value('email');
>>> "y.taro@sample.com"

いずれも実行されるsqlは以下の通り、

select `email` from `member` where `name` = '山田太郎' and `birthday` = '1970-01-01' limit 1;

特定の項目のみselectしつつ、limitで取得する結果を１つに限定している点がポイントです。

こうしてみると、クエリビルダとEloquentのvalue()は一見同じ処理を行っているように見えますね。しかし、次の例では異なる結果を返します。

私がハマった落とし穴

以下ではとあるブログの投稿(post)に紐付いたタグ名(tag.name)を取得しGROUP_CONCATで連結して取得しました。

$tags = DB::table('post')
    ->join('tag', 'post.post_id', '=', 'tag.post_id')
    ->where('post.post_id', '=', 1)
    ->groupBy('post.post_id')
    ->value(DB::raw('GROUP_CONCAT(tag.name)'));
>> "Laravel,PHP,Eloquent"

クエリビルダではカンマで連結されたタグ名が取得できました。 Eloquentではどうでしょうか？

$tags = Post::query()
    ->join('tag', 'post.post_id', '=', 'tag.post_id')
    ->where('post.post_id', '=', 1)
    ->groupBy('post.post_id')
    ->value(DB::raw('GROUP_CONCAT(tag.name)'));
>> null

あれれ、どういう訳かnullが返されました。

ソースを解析

以下はEloquentのvalue()のソースコードです。

vendor/laravel/framework/src/Illuminate/Database/Eloquent/Builder.php

/**
 * Get a single column's value from the first result of a query.
 *
 * @param  string|\Illuminate\Database\Query\Expression  $column
 * @return mixed
 */
public function value($column)
{
    if ($result = $this->first([$column])) {
        return $result->{Str::afterLast($column, '.')};
    }
}

なるほど、first([$column])でクエリ結果を取得し、$columnで指定した値のコロン（’.’）以降をプロパティ名としてアクセスしています。

つまり先ほどの例だと、$columnはGROUP_CONCAT(tag.name)なので、コロン以降はname)となります。従って、Undefined propertyとして処理され、nullとなった訳です。

一方、結果が正しく取得できたクエリビルダはというと、

vendor/laravel/framework/src/Illuminate/Database/Query/Builder.php

/**
 * Get a single column's value from the first result of a query.
 *
 * @param  string  $column
 * @return mixed
 */
public function value($column)
{
    $result = (array) $this->first([$column]);

    return count($result) > 0 ? reset($result) : null;
}

配列に変換した上で、reset()を使って１つ目の結果を取得していました。

回避策

回避策は色々ありそうですが、私の中では生クエリ（DB::raw）とvalue()を併用したい場合は一度selectRaw()などで別名を付けるルールを採用する事にしました。

$tags = Post::query()
    ->join('tag', 'post.post_id', '=', 'tag.post_id')
    ->where('post.post_id', '=', 1)
    ->groupBy('post.post_id')
    ->selectRaw('GROUP_CONCAT(tag.name) AS tag_names')
    ->value('tag_names');
>> "Laravel,PHP,Eloquent"

現場からは以上です。

toArray()でcreated_at,updated_atのフォーマットが変わる

Tue, 28 Jun 2022 09:46:39 +0900

Eloquentモデルを配列に変換して渡す必要がある際にたまに使うtoArray()ですが。先日何気なく使用していて思わぬエラーに遭遇、原因を調べてみると実はLaravel 7.xから変更されていた仕様でした。Upgrade Guideには目を通していたつもりでしたが、どうしてなかなか行き当たりばったりなキャッチアップになってしまう、Lazy Loadingな私です。

$user->toArray()

まず、toArray()を使用していて遭遇したエラーについて説明します。 Laravelインストール後にデフォルトで存在するUserモデルをtoArray()で変換してみましょう。

// factory でダミーレコード生成
>>> $user = User::factory()->create();
=> App\Models\User {#3575
     name: "Mr. Buck Schinner MD",
     email: "waters.montana@example.com",
     email_verified_at: "2022-06-05 04:34:30",
     #password: "$2y$10$92IXUNpkjO0rOQ5byMi.Ye4oKoEa3Ro9llC/.og/at2.uheWG/igi",
     #remember_token: "wp5fKxXY7s",
     updated_at: "2022-06-05 04:34:30",
     created_at: "2022-06-05 04:34:30",
     id: 1,
   }

>>> $user->toArray();
=> [
     "name" => "Mr. Buck Schinner MD",
     "email" => "waters.montana@example.com",
     "email_verified_at" => "2022-06-05T04:34:30.000000Z",
     "updated_at" => "2022-06-05T04:34:30.000000Z",
     "created_at" => "2022-06-05T04:34:30.000000Z",
     "id" => 1,
   ]

お気づきでしょうか？ email_verified_at, updated_at, created_at の日付形式がY-m-d H:i:sからISO-8601に変換されています。

なぜでしょうか？

日付のフォーマット

これはLaravel 7から内部的にCarbonのtoJson()を使用するようになったためのようです。

https://laravel.com/docs/7.x/upgrade#date-serialization

確かに、CarbonでtoJson()を使用するとISO-8601形式で日付が出力されますね。

Carbon::today()->toJson();
=> "2022-06-05T00:00:00.000000Z"

とは言え、全てのdatetimeやtimestamp型の項目がフォーマットされるわけではなく、デフォルトではcreated_atとupdated_atのみです。その他の項目についてはemail_verified_atの様に、$castsにてdatetimeを指定すると同様にISO-8601形式でフォーマットされます。

デフォルトのフォーマットを変更する

今回私が遭遇したケースではcreated_atとupdated_atをY-m-d H:i:sの形式のまま配列に変換する必要がありました。 toArray()で変換する際に日付のフォーマットを指定するにはどうすれば良いでしょう？

$casts

１つはemail_verified_atの様に$castsにて個別に指定する方法です。以下の様に、datetime:に続いて出力したいフォーマットを指定することができます。

app/Models/User.php

...
    /**
     * The attributes that should be cast to native types.
     *
     * @var array
     */
    protected $casts = [
        'email_verified_at' => 'datetime',
        'created_at'        => 'datetime:Y-m-d H:i:s',    // ←日付の形式を指定
        'updated_at'        => 'datetime:Y-m-d H:i:s',    // ←日付の形式を指定
    ];
...

tinkerで出力を確認してみましょう。

>>> $user->toArray();
=> [
     "id" => 1,
     "name" => "Dr. Wanda Gottlieb",
     "email" => "brenda39@example.com",
     "email_verified_at" => "2022-03-09T13:55:28.000000Z",
     "created_at" => "2022-03-09 13:55:28",
     "updated_at" => "2022-03-09 13:55:28",
   ]

正しく反映されていますね。

serializeDate

もう１つはserializeDate()をオーバーライドすることです。このメソッドはModelクラスがuseしているtraitのHasAttributesに定義されており、toArray()実行時に内部的に呼び出されています。このメソッドをオーバーライドすることでcreated_atとupdated_atを含めdatetimeにキャストしている項目のtoArray(), toJson()時のデフォルトのフォーマットを指定できます。フォーマットは以下の様にformat()で指定します。

app/Models/User.php

...
use DateTimeInterface;
...
    /**
     * Prepare a date for array / JSON serialization.
     *
     * @param  \DateTimeInterface  $date
     * @return string
     */
    protected function serializeDate(DateTimeInterface $date)
    {
        return $date->format('Y-m-d H:i:s');
    }
...

因みに、serializeDate()で指定しているのはデフォルトのフォーマットなので、$castsでのフォーマット指定と併用した場合は$casts側の指定が優先されます。以下は併用した例です。

app/Models/User.php

...
    /**
     * The attributes that should be cast to native types.
     *
     * @var array
     */
    protected $casts = [
        'email_verified_at' => 'datetime:Y-m-d',    // 日付のみに指定してみる
    ];
...

toArray()すると、created_at, updated_atはY-m-d H:i:sですが、email_verified_atはY-m-dのみの出力となります。

>>> $user->toArray();
=> [
     "id" => 1,
     "name" => "Dr. Wanda Gottlieb",
     "email" => "brenda39@example.com",
     "email_verified_at" => "2022-03-09",    // Y-m-d のみ
     "created_at" => "2022-03-09 13:55:28",
     "updated_at" => "2022-03-09 13:55:28",
   ]

バリデーション後のRequestの処理

Mon, 20 Jun 2022 06:07:34 +0900

FormRequestのバリデーションを問題なくパスしたら、コントローラで$request->validatedで配列としてフォームの入力値を取得できます。取得後の値は安全なのでそのままDBに保存することも可能です。しかし、その配列から必要のない値を抜いたり、足りない値を追加したりとかの処理はどうするかという説明です。

会員登録のFormRequest

例として会員登録の画面を使います。画面はこんな感じです。

その画面の入力をチェックするFormRequestは以下と定義します。

namespace App\Http\Requests;

use App\Rules\CaptchaRule;
use App\Rules\CustomerPasswordRule;
use Illuminate\Foundation\Http\FormRequest;

class CustomerRequest extends FormRequest
{
    public function rules()
    {
        $rules = [
            'email'                => ['required', 'email', 'unique:customer,email'],
            'password'             => ['required', new CustomerPasswordRule, 'confirmed'],
            'name'                 => ['required'],
            'g-recaptcha-response' => ['required', new CaptchaRule],
        ];

        return $rules;
    }
}

CustomerPasswordRuleやCaptchaRuleは事前に用意したカスタムのバリデーションのクラスです。

CustomerRequestのバリデーションを問題なく通過したら、以下のようにコントローラでDBに保存します。

namespace App\Http\Controllers\User;

use App\Http\Controllers\Controller;
use App\Http\Requests\CustomerRequest;
use App\Models\Customer;
use Illuminate\Foundation\Auth\RegistersUsers;

class RegisterController extends Controller
{
    use RegistersUsers;

...
    /**
     * 会員の登録
     *
     * @param  \App\Http\Requests\CustomerRequest  $request
     * @return \Illuminate\Http\RedirectResponse
     */
    public function register(CustomerRequest $request)
    {
        $validated = $request->validated();

        Customer::create($validated);
        ...
    }
}

ここでのregister()メソッドの$validatedの値の中身を見てみましょう。

$validated = [
  "email" => "test@example.com",
  "password" => "Test1234567890!",
  "name" => "テスト太郎",
  "g-recaptcha-response" => "03AGdBq26f1ycQWiqz2OeBFz....",
]

DBに保存するのに必要なのは、email, password（暗号化する）、nameの３つだけで、キャプチャのg-recaptach-responseは必要でありませんので、先の配列値から抜く必要あります。また、会員が有効かどうかを指定するactive_flagが必要なので、その値を配列に加える必要あります。

このような処理を行うには、Laravelのバージョン8.x以降では、以下のようにvalidated()を使わずに、safe(), merge(), except()を使って可能です。

...
    $input = $request->safe()
        ->merge(['active_flag' => 'Y'])
        ->except(['g-recaptcha-response']);

    Customer::create($input);
...

safeは、バリデーションをパスした値を抽出し、mergeは値を追加、exceptは値を削除です。しかし、mergeとexceptの使用の順番には注意してください。これらを逆にするとエラーとなってしまいます。なぜなら、exceptは配列を返すのでその後にメソッドの連結ができません。

処理の結果の配列は、以下のようになります。

$input = [
  "email" => "test@example.com",
  "password" => "Test1234567890!",
  "name" => "テスト太郎",
  "active_flag" => "Y",
]

よりフレキシブルな処理を望むなら、以下のようにcollect()を通してCollectionのオブジェクトにすることです。

...
    $input = $request->safe()
        ->collect()
        ->except(['g-recaptcha-response'])
        ->merge(['active_flag' => 'Y'])
        ->all();

    Customer::create($input);
...

さて、safe()の対応がないLaravel 7.xではどう対応しましょう。こちらも、配列をCollectionにしてしまえば、問題ありません。

...
    $input = collect($request->validated())
        ->except(['g-recaptcha-response'])
        ->merge(['active_flag' => 'Y']
        ->all();

    Customer::create($input);
...

私としては、Collectionを使用した方が好きです。以下のように、ケースにより配列の中身を変えることも簡単です。

       $input = collect($request->validated())
            ->when(! $request->active_flag, function ($collection) {
                return $collection->put('active_flag', 'N'); // 値がないときはNとする
            })
            ->when(! $request->paymethod_id, function ($collection) {
                $collection->forget([ // 値がないときは、以下の設定は必要ではない
                    'paymethod_id',
                    'card_number',
                    'card_exp',
                    'card_holder',
                ]);

                return $collection;
            })
            ->all();

DNSを使ってメールアドレスをチェック

Sun, 09 Jan 2022 01:43:32 +0900

「お客さんにメールが届かないのでどうかして？」というＣＳからの質問。見てみるとexample@yahoo.comであるところ、example@yahpo.comになっていたりします。たった１文字違いですが、会員登録してもこのためにメールが届かないばかりか、次回からは多分ログインもできません。もちろんお客さんの間違いですが、登録時にこれが通ってしまうというのは問題です。これをどうかしたいです。

緩いメールアドレスのバリデーション

Laravelのデフォルトのメールアドレスのバリデーションemailは、結構緩いです。どれだけ緩いが実例見てみましょう。以下は、tinkerを使って、test@gmailという不正なメールアドレスチェックします。

>>> $v = validator(['email' => 'test@gmail'], ['email' => 'required|email'])
=> Illuminate\Validation\Validator {#3534
     +customMessages: [],
     +fallbackMessages: [],
     +customAttributes: [],
     +customValues: [],
     +excludeUnvalidatedArrayKeys: null,
     +extensions: [],
     +replacers: [],
   }
>>> $v->passes()
=> true

あっさり、通ってしまいます。

また、example.comとかのドメイン名は実在しないのに、これも通ります。

>>> $v = validator(['email' => 'test@example.com'], ['email' => 'required|email'])
...
>>> $v->passes()
=> true

email:dnsの登場

メールアドレスの＠マークの後ろの部分、例えば、test@example.comなら、example.comの部分、はドメイン名と言ってインターネットでは非常に重要なデータなのですが、このドメインが実在するかどうか、そしてメールを受け取るかどうかがわかれば、少なくともメールアドレスのタイポは登録時に警告できますね。

それを利用したのが、email:dnsのバリデーションルールです。早速、tinkerで試してみましょう。

>>> $v = validator(['email' => 'test@gmail'], ['email' => 'required|email:dns'])
...
>>> $v->passes()
=> false

>>> $v = validator(['email' => 'test@example.com'], ['email' => 'required|email:dns'])
...
>>> $v->passes()
=> false

>>> $v = validator(['email' => 'test@yahpo.com'], ['email' => 'required|email:dns'])
...
>>> $v->passes()
=> false

素晴らしいです、みな通りません！

email:dnsの使用において注意が必要なのは、それを利用するには、以下の国際化関数、intlのライブラリが必要です。 https://www.php.net/manual/ja/book.intl.php

dns_get_record()

ちょっとemail:dnsの仕組みを探ってみましょう。Laravelのマニュアルによると、egulias/email-validatorのパッケージを使用しているそうな。そこから関心のコードの一部を掲載します。

https://github.com/egulias/EmailValidator/blob/3.x/src/Validation/DNSCheckValidation.php

...
class DNSCheckValidation implements EmailValidation
{
    /**
     * @var int
     */
    protected const DNS_RECORD_TYPES_TO_CHECK = DNS_MX + DNS_A + DNS_AAAA;

    /**
     * Reserved Top Level DNS Names (https://tools.ietf.org/html/rfc2606#section-2),
     * mDNS and private DNS Namespaces (https://tools.ietf.org/html/rfc6762#appendix-G)
     */
    const RESERVED_DNS_TOP_LEVEL_NAMES = [ //これらのドメイン名はみなエラーとなります
        // Reserved Top Level DNS Names
        'test',
        'example',
        'invalid',
        'localhost',

        // mDNS
        'local',

        // Private DNS Namespaces
        'intranet',
        'internal',
        'private',
        'corp',
        'home',
        'lan',
    ];
   ...

 private function validateDnsRecords($host) : bool
    {
        // A workaround to fix https://bugs.php.net/bug.php?id=73149
        /** @psalm-suppress InvalidArgument */
        set_error_handler(
            static function (int $errorLevel, string $errorMessage): ?bool {
                throw new \RuntimeException("Unable to get DNS record for the host: $errorMessage");
            }
        );

        try {
            // Get all MX, A and AAAA DNS records for host
            $dnsRecords = dns_get_record($host, static::DNS_RECORD_TYPES_TO_CHECK);
        } catch (\RuntimeException $exception) {
            $this->error = new InvalidEmail(new UnableToGetDNSRecord(), '');

            return false;
        } finally {
            restore_error_handler();
        }
...

上の４５行目見てください。dns_get_record()なるphp関数があったのですね。 https://www.php.net/manual/ja/function.dns-get-record.php

上の説明によると、こんなしてドメイン情報取得できるようです。

>>> dns_get_record("yahpo.com", DNS_MX);
=> [
     [
       "host" => "yahpo.com",
       "class" => "IN",
       "ttl" => 0,
       "type" => "MX",
       "pri" => 0,
       "target" => "",
     ],
   ]
>>> dns_get_record("yahoo.com", DNS_MX);
=> [
     [
       "host" => "yahoo.com",
       "class" => "IN",
       "ttl" => 0,
       "type" => "MX",
       "pri" => 1,
       "target" => "mta5.am0.yahoodns.net",
     ],
     [
       "host" => "yahoo.com",
       "class" => "IN",
       "ttl" => 0,
       "type" => "MX",
       "pri" => 1,
       "target" => "mta6.am0.yahoodns.net",
     ],
     [
       "host" => "yahoo.com",
       "class" => "IN",
       "ttl" => 0,
       "type" => "MX",
       "pri" => 1,
       "target" => "mta7.am0.yahoodns.net",
     ],
   ]

最初のタイポのドメイン名のtargetは存在しないけれど、正式なドメインは３つtargetを返しています。Laravelのemail:dnsはこれを利用しているのですね。

最後に

メールのバリデーションには、email:dnsの他にもrfcとかstrictとかspoofとかあります。 emailとemail:rfcは同じです。また、email:rfc,dnsとように合わせての使用も可能です。

あと大事なのは、バリデーションでは必ず弾かれてしまうが、test.@docomo.ne.jpのようにドットが不正な場所にあるにもかかわらず実在するメールアドレスの対応です。docomo.ne.jpやezweb.ne.jpではその不正を許す必要あります。まだ使っている人いるんですよ。

SQL文を画面で入力して安全に実行して結果を返す

Tue, 14 Dec 2021 07:46:54 +0900

Laravelのようなフレームワークが登場する以前は、誰しもSQL文を作成してmysqli_query()のような関数に引数として渡して実行していたものです。QueryBuilderやEloquentのORMなぞ聞いたこともない時代でした。その過去に戻るわけではないですが、それと同じこと、つまりSQL文を管理画面に直接入力して実行できないかと考えた次第です。

こんなものが欲しい

以下の画面のように、SQL文を入力してその実行ボタンを押すと結果を画面で表示してくれるものが欲しいのです。この画面では、テスト１とテスト２の２つサイトがあり、それぞれのサイトで使用されているDBに対してSQL文を実行しています。

なぜこのような機能が欲しいかというと、お客さんのビジネスでは今月の売り上げなどの定型のレポートだけでなく、例えば、ある時期にこの商品を購入したお客さんの中で何人が違う時期（最初の時期以降）で同じ商品を買ったのか、とかアドホックのリクエストが結構あるからです。

また、お客さんだけでなくシステム管理者は特定のDBテーブルのidの最大値が使用DBタイプの最大値に近づいていないか、など定期的に実行するクエリーも必要です。

しかし、これらのためにいちいち画面を伴うコントローラを作成するのは面倒であるし、そのときだけに必要で後には要らなくなることも多々です。それらのときに、上のようにカスタムのSQLを入力するだけで実行でき結果を見れる、さらにクエリと結果を保存し後に必要なときにも実行できる、としたら素晴らしいと思いませんか！

管理画面でSQL文を直接入力して実行するホラー

さて、欲しい機能は素晴らしいのだけれど、直接のSQL文入力・実行でホラーとなる状況はいくつかあります。特に以下の２点。

私の目的はあくまでもクエリーでありSELECTのSQL文だけの実行です。しかし、INSERTやUPDATEさらにDELETEもSQL文なので入力されて実行されたら、完全なホラーです。これらのSQL文が入力させないようにするか、入力しても実行を避ける方法が必要です。

次は、クエリーの実行時間がやたらに長くなりシステムの負荷となることです。入力するクエリーの実行に要する時間は、クエリーが複雑となると実行する前にわかるものではありません。もし、クエリーの実行時間が指定した実行所要時間以上となったら実行を自動的に打ち切りにしたいです。

ということで、これらを避ける対策を前もって考えます。

LaravelでどうSQL文を実行する？

ホラーの対策を考える前に、まず、LaravelでSQL文を実行してみましょう。tinkerで試してみます。

>>> DB::select("select count(*) as '会員数' from users");
=> [
     {#3514
       +"会員数": 2,
     },
   ]

簡単ですね。項目名にもUTF8なら日本語でエイリアスとできます。

しかし、恐ろしいのは先に述べたように、こういうこともできてしまいます。

>>> DB::select("delete from users");
=> []

>>> User::all();
=> Illuminate\Database\Eloquent\Collection {#3529
     all: [],
   }

DBテーブルは空になってしまいました。

DB更新のSQL文の実行を防ぐ

SQL文を簡単に実行できることがわかったところで、ホラーの対策を考えてみます。いくつかあります。

その１

簡単なのはSQL文にinsert, update, deleteなどが含まれていたら、プログラムで実行させない。preg_matchとか使用してバリデーションです。しかし、updated_atとかの項目がSQL文にあったら、それもマッチしてしまうので、updateの前後にスペースがあるかなどのマッチのパターンの調整が必要です。

その２

DBのユーザーを読み込み専用とする。これがベストですがいちいちそのために読み込み専用のDBユーザー作成する必要があります。ホストするプロバイダーによっては読み込み専用と読み書きのユーザーを分けて提供してくれるところもあります。.envあるいはconf/database.phpでの設定に工夫も必要となります。

その３

DBの読み込みセッションを使う。私が使用しているMySQL5.7では以下のようにたとえDBユーザーの権限に書き込みがあっても、以下のような読み込みセッションでDB更新の句クエリーを実行不可とできます。以下のDB::statement('SET SESSION TRANSACTION READ ONLY')の実行後は、レコード削除のSQL文のはエラーとなります。

>>> DB::select('select count(*) from users')
=> [
     {#3436
       +"count(*)": 1,
     },
   ]

>>> DB::statement('SET SESSION TRANSACTION READ ONLY')
=> true

>>> DB::select('delete from users')
Illuminate\Database\QueryException with message 'SQLSTATE[25006]: Read only sql transaction: 1792 Cannot execute statement in a READ ONLY transaction. (SQL: delete from users)'

>>> DB::select('select count(*) from users')
=> [
     {#3441
       +"count(*)": 1,
     },
   ]

クエリーの実行所有時間の制限

こちらは、DBセッションにおける最大実行時間を設定することで、制限をかけることが可能です。以下は、最大実行時間を1000ミリ秒、つまり１秒としました。２秒のスリープの実行では１秒を超えたときにエラーとなります。

>>> DB::statement('SET SESSION MAX_EXECUTION_TIME=1000')
=> true

>>> DB::select('select sleep(1) from users')
=> [
     {#3438
       +"sleep(1)": 0,
     },
   ]

>>> DB::select('select sleep(2) from users')
Illuminate\Database\QueryException with message 'SQLSTATE[HY000]: General error: 3024 Query execution was interrupted, maximum statement execution time exceeded (SQL: select sleep(2) from users)'

最後に

安全にクエリのSQL文の実行の仕方が解ったところで、実行したときにクエリーの実際の所有時間も知りたいですね。それは以下のように、前もってDB::listen()を実行すれば、実行後に取得できます。ここでも時間単位はミリ秒です。

>>> $time = 0
=> 0

>>> DB::listen(function($query) use (&$time) { $time = $query->time; })
=> null

>>> DB::select('select count(*) from users')
=> [
     {#3438
       +"count(*)": 1,
     },
   ]

>>> $time
=> 0.48

HTTPテストでURLに日本語が含まれている場合の意図せぬ挙動

Mon, 06 Dec 2021 12:01:33 +0900

LaravelではFeatureテストが簡単に行えるように、便利なテスト用メソッドが用意されています。今回はそちらを使っていてハマってしまった意図せぬ挙動について紹介します。

HTTPテスト

例えば特定のURLにリクエストを投げ、正しいレスポンスが返されるか？などのFeatureテストをする際に、Laravelでは以下のようなテストが書けます。

tests/Feature/ExampleTest.php

<?php

namespace Tests\Feature;

use Illuminate\Foundation\Testing\WithoutMiddleware;
use Tests\TestCase;

class ExampleTest extends TestCase
{
    public function test_a_basic_request()
    {
        $response = $this->get('/'); // HTTPリクエストをシミュレート

        $response->assertStatus(200); // レスポンスのステータスコードテスト

        $response->assertSee('Laravel'); // レスポンスに指定した文字列が含まれているかテスト
    }
}

上のテストでは/にGETリクエストを投げ、リクエストが正常に処理されたかステータスコード200をチェック、そして返されたレスポンスにLaravelという文字列が含まれているかをテストします。

インストール直後の状態では/にアクセスすると以下のページを返しますので、テストは成功するはずです。

URLに日本語が含まれている場合の挙動

さて、ここからが本題です。私がハマったのはURLに日本語が含まれている場合のテストです。 他の開発者のwindows環境ではパスするテストが、私のmacOS環境では必ず失敗してしまう、 という状況が発生しました。

どんなテストかを説明する為に例を用意しました。以下のようなページがあるとします。

入力した検索ワードをそのまま出力するシンプルなページです。

viewはこんな感じ。

resources/views/search.blade.php

<!DOCTYPE html>
<html lang="en">
<head>
    <title>Search</title>
</head>
<body>
    <form action="/search" method="get">
        <input type="text" name="word" value="">
        <input type="submit" value="検索">
    </form>

    <h1>{{ $word }}</h1>
</body>
</html>

routeはこんな感じ。

routes/web.php

<?php

use Illuminate\Http\Request;
use Illuminate\Support\Facades\Route;

Route::get('/search', function(Request $request) {
    $word = $request->get('word', '');

    return view('search', compact('word'));
});

前項のExampleTestをこのページに関するテストに書き換えてみましょう。

tests/Feature/ExampleTest.php

<?php

namespace Tests\Feature;

use Illuminate\Foundation\Testing\RefreshDatabase;
use Tests\TestCase;

class ExampleTest extends TestCase
{

    public function test_search_page()
    {
        $response = $this->get('/search?word=ほげ');

        $response->assertStatus(200);

        $response->assertSee('ほげ');
    }
}

“ほげ"というワードで検索した場合をシミュレートする為、/search?word=ほげにリクエストを投げ、レスポンスに文字列「ほげ」が含まれているかテストしています。

テストを実行してみましょう。

vendor/bin/phpunit --filter ExampleTest

PHPUnit 9.5.10 by Sebastian Bergmann and contributors.

.F                                                                  2 / 2 (100%)

Time: 00:00.138, Memory: 20.00 MB

There was 1 failure:

1) Tests\Feature\ExampleTest::test_search_page
Failed asserting that '<!DOCTYPE html>\n

~~省略~~

    <h1></h1>\n
</body>\n
</html>' contains "ほげ".

レスポンスに「ほげ」が含まれていない、との事でテストが失敗してしまいました。確かに、レスポンス内で検索ワードが表示される箇所が

    <h1></h1>\n

となっています。

ちなみに、検索文字列を「hoge」にした場合はパスします。

~~~
    public function test_search_page()
    {
        $response = $this->get('/search?word=hoge'); // hoge に変更

        $response->assertStatus(200);

        $response->assertSee('hoge'); // hoge に変更
    }
~~~

vendor/bin/phpunit --filter ExampleTest
PHPUnit 9.5.10 by Sebastian Bergmann and contributors.

..                                                                  2 / 2 (100%)

Time: 00:00.138, Memory: 20.00 MB

OK (2 tests, 3 assertions)

なぜでしょう？

parse_url()のバグ

$this->get()のソースを解析してみると、 vendor/symfony/http-foundation/Request.php 355行目のparse_url()にてURLからパースしたクエリ文字列が文字化けしていました。

以下はtinkerで同じコードを実行した際の結果です。

parse_url('http://127.0.0.1:8000/search?word=ほげ');
=> [
     "scheme" => "http",
     "host" => "127.0.0.1",
     "port" => 8000,
     "path" => "/search",
     "query" => b"word=ã_»ã__",
   ]

文字化けしていますね。ググってみるとGitHubで以下のIssueを見つけました。

UTF-8 URIs are broken by parse_url when locale is set

parse_url()はplatform(macなど)やlocaleの設定によってパースした文字列が壊れる場合があるとのこと。2010年から報告されているこちらのPHPのバグのようです。

urlencode()で解決

回避策として予め日本語部分をurlencode()でエンコードすれば良さそうです。 ExampleTestを以下のように修正しました。

tests/Feature/ExampleTest.php

~~~
    public function test_search_page()
    {
        $word = urlencode('ほげ');  // 予めURLエンコード

        $response = $this->get('/search?word='.$word);

        $response->assertStatus(200);

        $response->assertSee('ほげ');
    }
~~~

テストが通るようになりました。

vendor/bin/phpunit --filter ExampleTest
PHPUnit 9.5.10 by Sebastian Bergmann and contributors.

..                                                                  2 / 2 (100%)

Time: 00:00.136, Memory: 20.00 MB

OK (2 tests, 3 assertions)

まとめ

HTTPテストで日本語を含むURLにリクエストを投げる際は、日本語部分をURLエンコードするのが良さそうです。

アクセサを無視して値を取得する

Sat, 13 Nov 2021 22:46:26 +0900

DBから取得した値を自動で加工してくれる便利な機能のアクセサですが、時としてアクセサを無視してDBから取得した素の値が欲しいケースがあります。そんな時に使える方法を３つ紹介します。

どういうケース？

例えば、公式ドキュメントの「アクセサの定義」には例として以下のコードが紹介されています。

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    /**
     * ユーザーのファーストネームを取得
     *
     * @param  string  $value
     * @return string
     */
    public function getFirstNameAttribute($value)
    {
        return ucfirst($value);
    }
}

そして、定義したアクセサにより名前の出力は頭文字が大文字となります。

$user->first_name;    // DBに保存されている素の値は"hikaru"
>> "Hikaru"

今回はこのようにアクセサを定義したものの、例外的にDBに保存されている素の値である"hikaru"が欲しくなった、という時に使える方法の解説です。

1. $attributes

まず１つ目に、アクセサを定義したクラス内で使える方法です。DBから取得した素の値は$attributesというprotectedプロパティに格納されているため、Modelクラス内からアクセス可能です。例えば前項のUserクラスにgetPlainFirstName()を追加してみましょう。

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    /**
     * ユーザーのファーストネームを取得
     *
     * @param  string  $value
     * @return string
     */
    public function getFirstNameAttribute($value)
    {
        return ucfirst($value);
    }

    public function getPlainFirstName()
    {
        return $this->attributes['first_name'];
    }
}

メソッドを呼び出すと素の値が取得できます。

$user->getPlainFirstName();
>> "hikaru"

因みに、$attributesはvendor/laravel/framework/src/Illuminate/Database/Eloquent/Concerns/HasAttributes.phpにて定義されています。

2. getRawOriginal()

続いて、Userクラス外から素の値にアクセスする方法として、getRawOriginal()が使えます。

$user->getRawOriginal('first_name');
>> "hikaru"

１点注意が必要なのは、このメソッドは$originalというプロパティから値を取得しています。$originalにはDBから取得した時点の値を保持する配列が格納されており、getDirty()などで変更が加わった項目を判別する際などに使われています。

つまり、DBから取得した後に変更した値は取得できません。

$user->first_name = 'kenji';    // 名前を"hikaru"から"kenji"に変更
$user->getRawOriginal('first_name');    // $originalから値を取得するので"hikaru"のまま
>> "hikaru"

こちらのメソッドもHasAttributes.phpに定義されているのでソースを確認してみてください。

3. getAttributes()

最後に紹介するgetAttributes()は$attributesを返すメソッドです。Userクラス外からアクセスでき、DBから取得した後に値を変更しても変更後の値が取得できます。getRawOriginal()とは異なり引数でキーを指定できない（$attributesそのものを返す）為、取得後に項目を指定する必要があります。

$user->getAttributes()['first_name'];
>> "hikaru"

$user->first_name = "kenji";
$user->getAttributes()['first_name'];    // 変更後の値が取得できる
>> "kenji"

まとめ

以上、アクセサを無視してDBから取得した素の値を取得する方法３つの紹介でした。紹介しておいてなのですが、アクセサを無視しなければならない箇所がいくつもある場合は今回紹介した方法で置き換えるよりも、本当にそのアクセサが必要なのか？見直す方が良いかと思います。

そうだ、Laravel Excelを使ってみよう（６）顔写真付き名簿を作成しよう

Thu, 11 Nov 2021 12:36:08 +0900

今回は前回紹介した画像挿入を応用して顔写真付き名簿を作成してみましょう。

顔写真付き名簿を作る

例えば、以下のように行ごとにA列に顔写真とB列に名前を出力したいとします。

今回はNameListExportというクラスで実装していきますので予め以下のコマンドで生成して下さい。

php artisan make:export NameListExport

また、エクセルに出力する画像データはpublic/img配下にあるとします。

データに紐付いた画像の挿入

前回の画像挿入と異なり、今回はB列に出力する名前に応じてA列の顔写真が決まります。つまり、名前情報と顔写真（正確にはその画像ファイルパス）が紐付いています。実際の状況ではそれらはDBなどから取得するかと思いますが、今回はcollectionで$membersという変数を用意します。

まず、NameListExportを以下のように実装しました。$membersはコンストラクタにて外部から渡し、プロパティにセットしています。collection()内で取得すれば良いのでは？と思うかもしれませんが、そうするとdrawings()内で参照することができません。なぜなら、drawings()がcollection()より先に処理されるからです。(詳しくは vendor/maatwebsite/excel/src/Sheet.php のexport()をご確認下さい。)

app/Exports/NameListExport.php

<?php

namespace App\Exports;

use Maatwebsite\Excel\Concerns\Exportable;
use Maatwebsite\Excel\Concerns\FromCollection;
use Maatwebsite\Excel\Concerns\WithDrawings;
use Maatwebsite\Excel\Concerns\WithHeadings;
use Maatwebsite\Excel\Concerns\WithMapping;
use \PhpOffice\PhpSpreadsheet\Worksheet\Drawing;

class NameListExport implements FromCollection, WithHeadings, WithDrawings, WithMapping
{
    use Exportable;

    protected $members;

    public function __construct($members)
    {
        $this->members = $members;
    }

    public function headings():array
    {
        return [
            '顔写真', '名前',
        ];
    }

    public function map($member):array
    {
        return ['', $member['name']];   // A列は画像を出力するので空文字にしておく
    }

    public function collection()
    {
        return $this->members;
    }

    public function drawings()
    {
        $drawings = [];

        $rowNum = 2;    // 1行目はヘッダ行なので画像出力は２行目から

        foreach ($this->members as $member) {
            $drawing = new Drawing;
            $drawing->setPath($member['file']);
            $drawing->setCoordinates('A'.$rowNum);
            $drawing->setWidthAndHeight(60, 60);   // 画像サイズ調整
            $drawings[] = $drawing;

            $rowNum++;
        }
        
        return $drawings;
    }
}

それではtinkerで出力してみましょう。

$members = collect([
    ['name' => 'ミケ', 'file' => public_path('img/mike.jpg')],
    ['name' => '小虎', 'file' => public_path('img/kotora.jpg')],
    ['name' => 'おこげ', 'file' => public_path('img/okoge.jpg')],
    ['name' => 'くろ', 'file' => public_path('img/kuro.jpg')],
]);
use App\Exports\NameListExport;
(new NameListExport($members))->store('name_list.xlsx');

出力結果が以下になりました。（セルの幅と高さを調整してます）

あれ、名前の行がズレてしまいました。

どうやら$drawing->setCoordinates()で２〜５行目に画像をセットしたことで、データを出力する際の開始行がズレてしまったようです。

この件についてGithub上でDiscussionされていましたが、Laravel Excelの開発側としてはそこはPhpSpreadsheet側のロジックなのでどうにもできないとのこと。。。。

AfterSheetイベントで画像挿入

最終的に力技ですが、Laravel Excelのdrawings()は使用せず、AfterSheetイベント（シート作成プロセスの最後に呼ばれるイベント）にて画像をセットするようにしました。これならデータ→画像の順に挿入されるのでデータの開始行がズレません。

NameListExportを以下のように編集しました。WithDrawingの代わりにWithEventsをimplementしています。drawings()は中身はそのままですがgetDrawings()に変更し、registerEvents()内から呼び出すようにしました。そして、取得した$drawingsをAfterSheet内でWorkSheetにセットしています。

app/Exports/NameListExport.php

<?php

namespace App\Exports;

use Maatwebsite\Excel\Events\AfterSheet;
use Maatwebsite\Excel\Concerns\Exportable;
use Maatwebsite\Excel\Concerns\WithEvents;
use Maatwebsite\Excel\Concerns\WithMapping;
use Maatwebsite\Excel\Concerns\WithHeadings;
use Maatwebsite\Excel\Concerns\FromCollection;
use \PhpOffice\PhpSpreadsheet\Worksheet\Drawing;

class NameListExport implements FromCollection, WithHeadings, WithMapping, WithEvents
{
    use Exportable;

    protected $members;
 
    public function __construct($members)
    {
        $this->members = $members;
    }

    public function headings():array
    {
        return [
            '顔写真', '名前',
        ];
    }

    public function map($member):array
    {
        return ['', $member['name']];   // A列は画像を出力するので空文字にしておく
    }

    public function collection()
    {
        return $this->members;
    }

    public function getDrawings()
    {
        $drawings = [];

        $rowNum = 2;    // 1行目はヘッダ行なので画像出力は２行目から

        foreach ($this->members as $member) {
            $drawing = new Drawing;
            $drawing->setPath($member['file']);
            $drawing->setCoordinates('A'.$rowNum);
            $drawing->setWidthAndHeight(60, 60);
            $drawings[] = $drawing;

            $rowNum++;
        }
        
        return $drawings;
    }

    public function registerEvents(): array
    {
        $drawings = $this->getDrawings();

        return [
            AfterSheet::class => function (AfterSheet $event) use ($drawings) {
                $workSheet = $event->sheet->getDelegate();

                // 画像挿入処理
                foreach ($drawings as $drawing) {
                    $drawing->setWorkSheet($workSheet);
                }
            }
        ];
    }
}

再度tinkerで出力すると行ズレが無い期待通りの出力が得られるはずです。

まとめ

画像挿入に関しては正直Laravel ExcelのWithDrawingsを使うメリットがあまり感じられませんでした。Laravel Excel側でやってくれるのはWorkSheetへのセットだけですし、それもデータの挿入と併用すると行ズレ問題が発生してしまいます。

今回色々調べていて実感したのはLaravel ExcelはあくまでPhpShreadsheetのwrapperなので、Laravel Excel側でうまく処理できないケースについてはWithEventsなどを使って直接PhpSpreadsheet側で処理してしまうのが良さそうです。

Laravel 8.x更新で変わったこと（３）factoryがクラス化される

Fri, 05 Nov 2021 11:22:00 +0900

さらに引き続いて、最新のバージョンのLaravel 8.xの話です。今回はfactoryの話です。

結構変わりました。これもL7.xと比較してみましょう。

L7.xでは、namespaceがありません。

app/database/factories/UserFactory.php

/** @var \Illuminate\Database\Eloquent\Factory $factory */

use App\User;
use Faker\Generator as Faker;
use Illuminate\Support\Str;

/*
|--------------------------------------------------------------------------
| Model Factories
|--------------------------------------------------------------------------
|
| This directory should contain each of the model factory definitions for
| your application. Factories provide a convenient way to generate new
| model instances for testing / seeding your application's database.
|
*/

$factory->define(User::class, function (Faker $faker) {
    return [
        'name' => $faker->name,
        'email' => $faker->unique()->safeEmail,
        'email_verified_at' => now(),
        'password' => '$2y$10$92IXUNpkjO0rOQ5byMi.Ye4oKoEa3Ro9llC/.og/at2.uheWG/igi', // password
        'remember_token' => Str::random(10),
    ];
});

L8.xでは、以下のようにnamespaceが入り、Factoryを継承したクラスとなりました。

app/database/factories/UserFactory.php

namespace Database\Factories;

use App\Models\User;
use Illuminate\Database\Eloquent\Factories\Factory;
use Illuminate\Support\Str;

class UserFactory extends Factory
{
    /**
     * The name of the factory's corresponding model.
     *
     * @var string
     */
    protected $model = User::class;

    /**
     * Define the model's default state.
     *
     * @return array
     */
    public function definition()
    {
        return [
            'name' => $this->faker->name(),
            'email' => $this->faker->unique()->safeEmail(),
            'email_verified_at' => now(),
            'password' => '$2y$10$92IXUNpkjO0rOQ5byMi.Ye4oKoEa3Ro9llC/.og/at2.uheWG/igi', // password
            'remember_token' => Str::random(10),
        ];
    }

    /**
     * Indicate that the model's email address should be unverified.
     *
     * @return \Illuminate\Database\Eloquent\Factories\Factory
     */
    public function unverified()
    {
        return $this->state(function (array $attributes) {
            return [
                'email_verified_at' => null,
            ];
        });
    }
}

使用の方は、

L7.xでは、以下のようにクラスのないphp関数だったのが、

factory(App\User::class, 50)->create(); // Userのレコードを50作成

L8.xでは、

User::factory()->count(50)->create();

クラスメソッドとなります。

User::factory()として使えるのは、以下のようにUserモデルにおいてHasFactoryのトレイトを使用しているからです。

app/Models/User.php

namespace App\Models;

use Illuminate\Contracts\Auth\MustVerifyEmail;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;
use Laravel\Sanctum\HasApiTokens;

class User extends Authenticatable
{
    use HasApiTokens, HasFactory, Notifiable;
..

最後に、これもLaravel ShiftのアップグレードサービスですべてのFactoryの定義の変換とモデルのクラスの定義にuse HasFactory;を追加してくれるところまで自動変換してくれます。

Laravel 8.x更新で変わったこと（２）Route関連の変更

Wed, 03 Nov 2021 12:00:43 +0900

引き続いて、Laravel 8.x更新で変わったことです。今回はRoute関連の話です。

Laravel 8.x以前では、routes/web.phpの中身はこんな感じでした。

routes/web.php

Route::namespace('Auth')->middleware('guest')->group(function () {

    // Authentication Routes...
    Route::get('', 'LoginController@showLoginForm');
    Route::get('login', 'LoginController@showLoginForm')->name('login');
    Route::post('login', 'LoginController@login')->name('login-post');

    // Password Reset Routes...
    Route::get('password/reset', 'ForgotPasswordController@showLinkRequestForm')->name('password.forgot');
    Route::post('password/email', 'ForgotPasswordController@sendResetLinkEmail')->name('password.email');
    Route::get('password/reset/{token}', 'ResetPasswordController@showResetForm')->name('password.reset');
    Route::post('password/reset', 'ResetPasswordController@reset')->name('password.reset-post');
});

これが、Laravel 8.xでは、

routes/web.php

use App\Http\Controllers\Admin;
use App\Http\Controllers\Auth;
use App\Http\Controllers\User;
use Illuminate\Support\Facades\Route;

Route::middleware('guest')->group(function () {

    // Authentication Routes...
    Route::get('', [Auth\LoginController::class, 'showLoginForm']);
    Route::get('login', [Auth\LoginController::class, 'showLoginForm'])->name('login');
    Route::post('login', [Auth\LoginController::class, 'login'])->name('login-post');

    // Password Reset Routes...
    Route::get('password/reset', [Auth\ForgotPasswordController::class, 'showLinkRequestForm'])->name('password.forgot');
    Route::post('password/email', [Auth\ForgotPasswordController::class, 'sendResetLinkEmail'])->name('password.email');
    Route::get('password/reset/{token}', [Auth\ResetPasswordController::class, 'showResetForm'])->name('password.reset');
    Route::post('password/reset', [Auth\ResetPasswordController::class, 'reset'])->name('password.reset-post');

});

となります。

何が変わったかというと、今までのコントローラクラス名＠メソッド名（例：‘LoginController@showLoginForm’）が、コントローラクラスパスとメソッド名の配列（[Auth\LoginController::class, ‘showLoginForm’]）となりました。

この変更が動作するためには、RouteServiceProvider.phpのファイルの編集も必要です。 L7.xのバージョンでは、以下のように$namespaceがありますが、

app/Providers/RouteServiceProvider.php

namespace App\Providers;

use Illuminate\Foundation\Support\Providers\RouteServiceProvider as ServiceProvider;
use Illuminate\Support\Facades\Route;

class RouteServiceProvider extends ServiceProvider
{
    /**
     * This namespace is applied to your controller routes.
     *
     * In addition, it is set as the URL generator's root namespace.
     *
     * @var string
     */
    protected $namespace = 'App\Http\Controllers';

...
    /**
     * Define the "web" routes for the application.
     *
     * These routes all receive session state, CSRF protection, etc.
     *
     * @return void
     */
    protected function mapWebRoutes()
    {
        Route::middleware('web')
            ->namespace($this->namespace)
            ->group(base_path('routes/web.php'));
    }

    /**
     * Define the "api" routes for the application.
     *
     * These routes are typically stateless.
     *
     * @return void
     */
    protected function mapApiRoutes()
    {
        Route::prefix('api')
            ->middleware('api')
            ->namespace($this->namespace)
            ->group(base_path('routes/api.php'));
    }
}

L8.xのバージョンでは、それを削除します。mapWebRoute()とmapApiRoute()からもnamespace()を削除します。

app/Providers/RouteServiceProvider.php

namespace App\Providers;

use Illuminate\Foundation\Support\Providers\RouteServiceProvider as ServiceProvider;
use Illuminate\Support\Facades\Route;

class RouteServiceProvider extends ServiceProvider
{

...
    /**
     * Define the "web" routes for the application.
     *
     * These routes all receive session state, CSRF protection, etc.
     *
     * @return void
     */
    protected function mapWebRoutes()
    {
        Route::middleware('web')
            ->group(base_path('routes/web.php'));
    }

    /**
     * Define the "api" routes for the application.
     *
     * These routes are typically stateless.
     *
     * @return void
     */
    protected function mapApiRoutes()
    {
        Route::prefix('api')
            ->middleware('api')
            ->group(base_path('routes/api.php'));
    }
}

さて、上の変更によりプログラムの実行が速くなったとかのメリットはないと思いますが、この形式になることにより改善されたのは、vscodeのようなエディターにおいてweb.phpのファイル内から簡単にコントローラクラスの定義にジャンプできることです。エディターあるいはエディターのプラグインがクラスを認識できるようになったためです。

とは言え、このコード変更を手動でやるのはとても面倒ですね。私の大きいプロジェクトでrouteがたくさんあり、242箇所も変更が必要な部分があります。このようなときには、Laravel Shiftのサービスを使用することを勧めます。以前に、ここで紹介していますが、あれから数年、サイトのデザインとか変わっていますが基本的には同じサービスです。

最後に、上で編集したweb.phpやRouteServiceProvider.phpを何も編集せずにしておくことも可能です。それでも問題なくL8.xで動作します。

Laravel 8.x更新で変わったこと（１）メンテナンス中のアクセス

Sun, 31 Oct 2021 12:48:59 +0900

Laravel 7.xから8.xに更新して変わったことを紹介していきます。最初は、メンテナンスモードに関して。

Laravel 7.xのメンテナンスモードに関して書いたのは、たった１年前のことです。メンテナンス画面：php artisan up & downでは、

Laravelの経験が長くなると、つまり初期のバージョンから使用していると、昔のやり方しか知らずに過ごしていることがあります。... ということでやり方学びなおします

なんて書いていましたが、Laravel 8.xの更新でまたもや学びなおしです。

php artisan downのコマンドはそのままですが、それに追加するオプションが変わりました。

まず、比較してみましょう。

Laravel 7.xにおいて、

$ php artisan down --help

を実行すると、以下のようのなオプションがあります。英語のヘルプは日本語に私が訳しています。

Usage:
  down [options]

Options:
      --message[=MESSAGE]  メンテナンス画面に表示するメッセージ
      --retry[=RETRY]      HTTPヘッダーのRetry-Afterの秒数を設定
      --allow[=ALLOW]      メンテナンスモードでもアクセスできるIPアドレスを指定

同じコマンドラインをLaravel 8.xで実行すると、

Usage:
  down [options]

Options:
      --redirect[=REDIRECT]  メンテナンス中は指定のURLに皆リダイレクト<strong>
      --render[=RENDER]      メンテナンス中に表示する画面を指定
      --retry[=RETRY]        HTTPヘッダーのRetry-Afterの秒数を設定
      --refresh[=REFRESH]    HTTPヘッダーのRefreshの秒数を設定
      --secret[=SECRET]      メンテンナンスをバイパスするシークレットコードを指定
      --status[=STATUS]      メンテナンス中に返すHTTPのステータスコードを指定（デフォルト503）

オプションの数が増えただけでなく、–messageとか–allowとかが無くなってしまいました。

これは問題です。　–allowなしにどうやって開発者あるいは関係者だけがメンテナンス中のサイトにアクセスできるのでしょうか？

Laravel 8.xはそれを、–secretのオプションで解決します。実行は、例えば

$ php artisan down --secret=secret-code

としてメンテンナンスに入り、ブラウザーで以下のURLでアクセスすると、あたかもメンテナンスなしの状態で画面にアクセスできます。

https://example.com/secret-code

これはとても素晴らしいです。今まで自宅のIPが変わったりしていちいち調べて–allowにIPアドレスを指定していましたが、その必要がなくなります。

仕組みとしては、いたって簡単で上のようにシークレットコードでアクセスしたら、larave_maintenanceというクッキーにその値を暗号化して入れて、それが正しいかをチェックしているようです。

もちろん、先の例のようにsecret-codeではあまりにも簡単すぎるので実際には以下のようにtinkerで値を作成することを勧めます。

>>> Str::random()
=> "mdcSOnkB5fT2rGAC"
>>> (string) Str::uuid()
=> "fe3a8010-bdda-4972-a0bb-ab96c17841a6"
>>>

FormRequestでオーソリ（認可）

Sun, 24 Oct 2021 02:23:14 +0900

FormRequestの話はいつも入力値のバリデーションが中心ですが、入力値とは関係ないアクセスのオーソリ（認可）もFormRequest内で設定可能です。その説明のための簡単な例として、登録したユーザーが自分の名前などのプロフィールを編集するするときに、最後の編集から24時間経過しないと次の変更ができない、というのはどうでしょう。

まず、FormRequestをaritisanの実行で作成します。

$ php artisan make:request UserEditRequest

以下のようにオーソリのための関数、authorize()を定義します。

app/Http/Request/UserEditRequest.php

namespace App\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;

class UserEditRequest extends FormRequest
{
    /**
     * Determine if the user is authorized to make this request.
     *
     * @return bool
     */
    public function authorize()
    {
        $user = auth()->user();

        // レコードの更新日と現在の差分を時間で計算
        $diff = Carbon::parse($user->updated_at)->diffInHours(Carbon::now());

        return ($diff > 24); //差分が24時間超ならＯＫ、そうでないならアクセス不可
    }

    /**
     * Get the validation rules that apply to the request.
     *
     * @return array
     */
    public function rules()
    {
        return [
            'name'  => 'required',
        ];
    }
}

次に、編集画面のコントローラで先のFormRequestを以下のように使用して、

namespace App\Http\Controllers;

use App\Http\Requests\UserEditRequest;

class UserController extends Controller
{
    /**
     * Create a new controller instance.
     *
     * @return void
     */
    public function __construct()
    {
        $this->middleware('auth');
    }

    /**
     * Show the form for editing the specified resource.
     *
     * @return \Illuminate\Http\Response
     */
    public function edit()
    {
        $user = auth()->user();

        return view('edit');
    }

    /**
     * Update the specified resource in storage.
     *
     * @param  \App\Http\Requests\UserEditRequest $request
     * @return \Illuminate\Http\Response
     */
    public function update(UserEditRequest $request) //　ここでFormRequestを使用
    {
        $user = auth()->user();        
        
        $user->update($request->validated());

        return redirect()->route('home');
    }
}

過去24時間内にすでにレコードを変更したという仮定で、編集画面の保存ボタンを押すと以下のように403の画面に遷移します。

しかしこれでは、どうしてエラーとなったかユーザーには謎ですね。拒否された理由のメッセージを表示したいです。

以下のように、FormRequestのfailedAuthorization()を使えば、

app/Http/Requests/UserEditRequest.php

...
    /**
     * Handle a failed authorization attempt.
     *
     * @return void
     *
     * @throws \Illuminate\Auth\Access\AuthorizationException
     */
    protected function failedAuthorization()
    {
        throw new AuthorizationException('最後の編集から２４時間経過しないと編集可能となりません');
    }
...

今度は親切なメッセージのエラー表示となります。

そうだ、Laravel Excelを使ってみよう（５）画像を挿入する

Mon, 18 Oct 2021 03:41:05 +0900

以前ご紹介したLaravel Excelの続きです。今回はExcelシートに画像を挿入する方法についてご紹介いたします。

WithDrawings

公式ドキュメントに画像を挿入する手順について説明がありますのでそちらを参考に進めて行きます。

まず、挿入する画像をpublic/img配下に配置します。ファイル名はとりあえずmike.jpgとしました。適当な画像が無ければ以下のサンプル画像を使って頂いても構いませんよ！

次に、Exportクラスを作成します、今回はImageExportとしました。

php artisan make:export ImageExport

次に、ImageExportクラスにてWithDrawingsをimplementし、drawings()を実装します。drawings()内で使うDrawingクラスはPhpSpreadsheetのクラスなのでそちらをuseするのも忘れずに。

app/Exports/ImageExport.php

namespace App\Exports;

use Maatwebsite\Excel\Concerns\Exportable;
use Maatwebsite\Excel\Concerns\WithDrawings;
use PhpOffice\PhpSpreadsheet\Worksheet\Drawing;

class ImageExport implements WithDrawings
{
    use Exportable;

    public function drawings()
    {
        $drawing = new Drawing();
        $drawing->setPath(public_path('/img/mike.jpg'));    // 画像のパス指定
        $drawing->setCoordinates('A1');     // 出力先のセルを指定
        
        return $drawing;
    }
}

一度、tinkerから出力してみましょう。以下を実行すると storage/app/test.xlsx が出力されるはずです。

use App\Exports\ImageExport;
(new ImageExport)->store('test.xlsx');
=> true

出力されたファイルはこんな感じです。setCoordinates()で指定した通り、画像の左上がセルのA1に揃えられています。

因みにドキュメントにもある通り、複数の画像を出力する際はdrawings()からDrawingインスタンスの配列をreturnします。試しにA1とC1にそれぞれ同じ画像を出力してみましょう。

app/Exports/ImageExport.php

...
    public function drawings()
    {
        $drawing1 = new Drawing();
        $drawing1->setPath(public_path('/img/mike.jpg'));
        $drawing1->setCoordinates('A1');

        $drawing2 = new Drawing();
        $drawing2->setPath(public_path('/img/mike.jpg'));
        $drawing2->setCoordinates('C1');
        
        return [$drawing1, $drawing2];
    }
...

出力は以下のようになります。

画像の幅や高さを変更する

前項で出力した画像は元の画像のサイズのまま出力されています。出力する画像の幅や高さを変更したい場合はsetWidth(),setHeight()が使えます。drawings()を編集して高さを２倍にした画像、幅を２倍にした画像をそれぞれ出力してみましょう。

app/Exports/ImageExport.php

...
    public function drawings()
    {
        // 元のサイズ
        $drawing1 = new Drawing();
        $drawing1->setPath(public_path('/img/mike.jpg'));
        $drawing1->setCoordinates('A1');

        // 高さ２倍
        $drawing2 = new Drawing();
        $drawing2->setPath(public_path('/img/mike.jpg'));
        $drawing2->setCoordinates('C1');
        $drawing2->setHeight($drawing1->getHeight() * 2);

        // 幅２倍
        $drawing3 = new Drawing();
        $drawing3->setPath(public_path('/img/mike.jpg'));
        $drawing3->setCoordinates('G1');
        $drawing3->setWidth($drawing1->getWidth() * 2);
         
        return [$drawing1, $drawing2, $drawing3];
    }
...

出力は以下になりました。

あれ、同じサイズになりましたね、もしかして元のアスペクト比のままサイズ変更される？

どうやらそのようです。 Drawingの親クラスであるBaseDrawingクラス(vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Worksheet/BaseDrawing.php)を確認するとsetWidth(), setHeight()にて、resizeProportionalがtrueなら元のアスペクト比を維持しています。そして、デフォルトのresizeProportionalはtrueです。

もし、アスペクト比を無視して幅や高さを変更したい場合は、

...
        // 高さ２倍
        $drawing2 = new Drawing();
        $drawing2->setPath(public_path('/img/mike.jpg'));
        $drawing2->setCoordinates('C1');
        $drawing2->setResizeProportional(false); //アスペクト比を無視
        $drawing2->setHeight($drawing1->getHeight() * 2);

        // 幅２倍
        $drawing3 = new Drawing();
        $drawing3->setPath(public_path('/img/mike.jpg'));
        $drawing3->setCoordinates('G1');
        $drawing3->setResizeProportional(false); //アスペクト比を無視
        $drawing3->setWidth($drawing1->getWidth() * 2);
...

とすれば良いですね。出力は以下になりました。

BaseDrawingクラス を確認していると他にも便利そうなメソッドがありました。例えば、setWidthAndHeight()は指定した幅と高さに収まるように画像をリサイズしてくれます。画像をセル内に収めたい場合などに使えそうですね！

Laravel Collection（８） filterの代わりにwhere

Sun, 10 Oct 2021 02:43:23 +0900

「Laravel Collection（２） Collectionを返すメソッド」ではfilterメソッドを紹介しました。今度はfilterメソッドのように条件でCollectionを絞るwhereメソッドの話です。EloquentやSQL文で慣れているならwhereの方がわかりやすいかもしれません。

データの準備

用意するデータは、Laravel Collection（１）１つの値を返すメソッド　をもとに、以下のDBレコードがすでに作成されていると仮定します。

mysql> select id, name, birth_date from users;
+----+------------------+------------+
| id | name             | birth_date |
+----+------------------+------------+
|  1 | 石田 裕美子      | 1991-05-26 |
|  2 | 佐藤 香織        | 2002-01-12 |
|  3 | 杉山 明美        | 2000-03-13 |
+----+------------------+------------+
3 rows in set (0.00 sec)

今回は女の人だけになりました。

where

まず、filter()を使った例です。

>>> User::all()->filter(function ($user) {
        return $user->birth_date < '2000-01-01';
    })

=> Illuminate\Database\Eloquent\Collection {#4317
     all: [
       App\User {#4260
         id: 1,
         name: "石田 裕美子",
         email: "sasaki.naoko@example.net",
         email_verified_at: "2021-10-07 02:41:15",
         #password: "$2y$10$53mZGiOMkJEVm1VDij642eWGi.i4/bWt3fElQjQvp86dfG/9MK5mW",
         #remember_token: "fCSd0AlA84",
         birth_date: "1991-05-26",
         created_at: "2021-10-07 02:41:16",
         updated_at: "2021-10-07 02:41:16",
       },
     ],
   }

これと同じ処理をwhere()で行うと、

>>> User::all()->where('birth_date', '<', '2000-01-01')

=> Illuminate\Database\Eloquent\Collection {#3393
     all: [
       App\User {#4105
         id: 1,
         name: "石田 裕美子",
         email: "sasaki.naoko@example.net",
         email_verified_at: "2021-10-07 02:41:15",
         #password: "$2y$10$53mZGiOMkJEVm1VDij642eWGi.i4/bWt3fElQjQvp86dfG/9MK5mW",
         #remember_token: "fCSd0AlA84",
         birth_date: "1991-05-26",
         created_at: "2021-10-07 02:41:16",
         updated_at: "2021-10-07 02:41:16",
       },
     ],
   }

短くてわかりやすいです。

今度はwhere()を２つ繋げます。

>>> User::all()->where('birth_date', '>=', '1990-01-01')
   ->where('birth_date', '<=', '2000-01-01')

=> Illuminate\Database\Eloquent\Collection {#4171
     all: [
       App\User {#3376
         id: 1,
         name: "石田 裕美子",
         email: "sasaki.naoko@example.net",
         email_verified_at: "2021-10-07 02:41:15",
         #password: "$2y$10$53mZGiOMkJEVm1VDij642eWGi.i4/bWt3fElQjQvp86dfG/9MK5mW",
         #remember_token: "fCSd0AlA84",
         birth_date: "1991-05-26",
         created_at: "2021-10-07 02:41:16",
         updated_at: "2021-10-07 02:41:16",
       },
     ],
   }

これは、Laravel Collection（２） Collectionを返すメソッド　で掲載したfilter()を使用した以下とまったく同じ処理なことわかりますか？

>>> User::all()->filter(function ($user) {
        if ($user->birth_date > '2000-01-01') return false;
        if ($user->birth_date < '1990-01-01') return false;
        return true;
    })

whereBetween()というメソッドもありますよ。これを使えばもっと短くなります。

>>> User::all()->whereBetween('birth_date', ['1990-01-01', '2000-01-01'])

=> Illuminate\Database\Eloquent\Collection {#3383
     all: [
       App\User {#3412
         id: 1,
         name: "石田 裕美子",
         email: "sasaki.naoko@example.net",
         email_verified_at: "2021-10-07 02:41:15",
         #password: "$2y$10$53mZGiOMkJEVm1VDij642eWGi.i4/bWt3fElQjQvp86dfG/9MK5mW",
         #remember_token: "fCSd0AlA84",
         birth_date: "1991-05-26",
         created_at: "2021-10-07 02:41:16",
         updated_at: "2021-10-07 02:41:16",
       },
     ],
   }

対象のレコードを条件で絞るという点では、CollectionのwhereメソッドはEloquentやDBクエリのwhereメソッドと同じようなメソッドです。しかし両者のwhereメソッドはどこが違うのでしょうか。

EloquentとCollectionでのwhereメソッドの違い

この違いを理解するには、裏で実行されているSQL文を見る必要があります。注意：以下のtinkerで使用されているsql()はユーザー定義です。こちらを参照してください。

まず、Eloquentのクエリでのwhereの実行です。

>>> User::where('birth_date', '<', '2000-01-01')->get()

=> Illuminate\Database\Eloquent\Collection {#4172
     all: [
       App\User {#4104
         id: 1,
         name: "石田 裕美子",
         email: "sasaki.naoko@example.net",
         email_verified_at: "2021-10-07 02:41:15",
         #password: "$2y$10$53mZGiOMkJEVm1VDij642eWGi.i4/bWt3fElQjQvp86dfG/9MK5mW",
         #remember_token: "fCSd0AlA84",
         birth_date: "1991-05-26",
         created_at: "2021-10-07 02:41:16",
         updated_at: "2021-10-07 02:41:16",
       },
     ],
   }
>>> sql()
=> [
     [
       "query" => "select * from `users` where `birth_date` < ?",
       "bindings" => [
         "2000-01-01",
       ],
       "time" => 5.02,
     ],
   ]

SQL文にはしっかりSQLのwhere節が含まれています。つまりDBレベルで条件で絞っています。

次に、Collectionでのwhere()の実行です。

>>> User::all()->where('birth_date', '<', '2000-01-01')

=> Illuminate\Database\Eloquent\Collection {#3393
     all: [
       App\User {#4105
         id: 1,
         name: "石田 裕美子",
         email: "sasaki.naoko@example.net",
         email_verified_at: "2021-10-07 02:41:15",
         #password: "$2y$10$53mZGiOMkJEVm1VDij642eWGi.i4/bWt3fElQjQvp86dfG/9MK5mW",
         #remember_token: "fCSd0AlA84",
         birth_date: "1991-05-26",
         created_at: "2021-10-07 02:41:16",
         updated_at: "2021-10-07 02:41:16",
       },
     ],
   }
>>> sql()
=> [
     [
       "query" => "select * from `users`",
       "bindings" => [],
       "time" => 4.45,
     ],
   ]
>>>

こちらのSQL文にはwhere節は含まれておらず、DBのusersテーブルからすべてのレコードを取得しています。そしてその中から条件に適うレコードをプログラムで抽出しています。今回はDBには３つしかレコードがありませんが、これが何千ともあるならそれらすべてをメモリに保持することになるのでリソースの無駄遣いとなり、さらにはパフォーマンスの低下ともなります。

となると、いつEloquentのクエリでwhere()を使うか、いつCollectionでwhere()を使うかを十分注意すること重要になります。Eloquent、つまりDBレベルでできるだけ取得するレコードを絞って、その結果のCollectionにおいてさらにいろいろな条件で絞るとかの場合にCollectionのwhereメソッドが使われるのが適切です。

配列値の入力のためのFormRequest（２）エラーを見やすく

Sun, 12 Sep 2021 12:42:49 +0900

前回は１行１項目で３行の入力フォームの話でした。今回は難度をアップして１行３項目で３行の入力フォームの話です。

複数行・複数項目の入力フォーム

今回のフォームはこんな感じです。前回より複雑でしょう。

コントローラは、前回と同様ですが、FormRequestはItemsRequestとします。

app/Controllers/Form2Controller.php

namespace App\Http\Controllers;

use App\Http\Requests\ItemsRequest;
use Illuminate\Http\Request;

class Form2Controller extends Controller
{
    /**
     * Show the form for creating a new resource.
     *
     * @return \Illuminate\Http\Response
     */
    public function create()
    {
         return view('form2');
    }

    /**
     * Store a newly created resource in storage.
     *
     * @param  App\Http\Requests\ItemsRequest  $request
     * @return \Illuminate\Http\Response
     */
    public function store(ItemsRequest $request)
    {
       ddd($request->validated());
    }
}

ブレードは、

resources/views/form2.blade.php

...
<div class="container-fluid">
  <div class="row">
    <div class="col-md-12 col-lg-12 mt-2">
      <div class="card card-primary">

        <div class="card-header">
          <h3 class="card-title">複数行のフォーム</h3>
        </div>

        <form method="POST" action="{{ route('form2.store') }}" class="form-horizontal" novalidate="">
          @csrf
          <div class="card-body">
            @error('names')
              <div class="invalid-feedback d-block">{{ $message }}</div>
            @enderror
            <div class="table-responsive">
              <table class="table table-bordered table-hover table-sm">
                <thead>
                  <tr>
                    <th>アイテム名</th>
                    <th class="col-2">価格</th>
                    <th class="col-1">個数</th>
                  </tr>
                </thead>
                <tbody>

                  @for ($i = 0; $i < 3; $i++)
                    <tr>
                      <td>
                        <input class="form-control" maxlength="255" name="names[]" type="text" value="{{ old('names.'.$i) }}">
                        @error('names.'.$i)
                          <span class="invalid-feedback d-block">{{ $message }}</span>
                        @enderror
                      </td>
                      <td>
                        <input class="form-control" maxlength="10" name="prices[]" type="text" value="{{ old('prices.'.$i) }}">
                        @error('prices.'.$i)
                          <span class="invalid-feedback d-block">{{ $message }}</span>
                        @enderror
                      </td>
                      <td>
                        <input class="form-control" maxlength="5" name="quantities[]" type="text" value="{{ old('quantities.'.$i) }}">
                        @error('quantities.'.$i)
                        <span class="invalid-feedback d-block">{{ $message }}</span>
                        @enderror
                      </td>
                    </tr>

                  @endfor
                </tbody>
              </table>
            </div>
          </div>

          <div class="card-footer">
            <button class="btn btn-primary float-right mr-2" type="submit">保存</button>
          </div>
        </form>
      </div><!-- card -->
    </div>
  </div><!-- row -->
</div>
...

FormRequestは、

app/Http/Requests/ItemsRequest.php

namespace App\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;
use Illuminate\Contracts\Validation\Validator;
use Illuminate\Validation\ValidationException;

class ItemsRequest extends FormRequest
{
    protected function prepareForValidation()
    {
        $names = $prices = $quantities = [];

        // nullを削除するために入力データを作成しなおす
        foreach($this->names as $i => $name) {
            if ($name === null) {
                continue;
            }

            array_push($names, $name);
            array_push($prices, $this->prices[$i]);
            array_push($quantities, $this->quantities[$i]);
        }

        $this->merge([
            'names'      => $names,
            'prices'     => $prices,
            'quantities' => $quantities,
        ]);
    }

    /**
     * Get the validation rules that apply to the request.
     *
     * @return array
     */
    public function rules()
    {
        return [
            'names'        => 'required|array', // 必ず１行の入力が必要
            'names.*'      => 'nullable|string',
            'prices.*'     => 'required_with:names.*|integer',
            'quantities.*' => 'required_with:names.*|integer|min:1',
        ];
    }

    public function attributes()
    {
        return [
            'names.*'      => 'アイテム名',
            'prices.*'     => '価格',
            'quantities.*' => '個数',
        ];
    }

    public function messages()
    {
        return [
            'names.required'             => '必ず１つの入力が必要です',
            'prices.*.required_with'     => '「アイテム名」が入力されているときは「価格」は必須です.',
            'prices.*.integer'           => '「価格」は整数の入力が必要です.',
            'quantities.*.required_with' => '「アイテム名」が入力されているときは「個数」は必須です.',
            'quantities.*.integer'       => '「個数」は整数の入力が必要です.',
            'quantities.*.min:1'         => '「個数」は最低１です.',
        ];
    }
}

エラーの出力はこんな感じです。

エラーの出力を見やすくする

先のエラーの出力、個数や価格の列の幅が短いので醜いですね。

考えついたのは、エラーのテキストを一緒にして１行すべてを使って表示しては。ということで、エラーを加工が必要です。Laravelにはしっかりそのための関数もあるのです。

ItemRequest.phpに以下のように、failedValidation()なる関数を追加します。

app/Http/Requests/ItemsRequest.php

namespace App\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;
use Illuminate\Contracts\Validation\Validator;
use Illuminate\Validation\ValidationException;

class ItemsRequest extends FormRequest
{
...
    /**
     * Override the parent function
     *
     * @param  \Illuminate\Contracts\Validation\Validator  $validator
     * @return void
     *
     * @throws \Illuminate\Validation\ValidationException
     */
    protected function failedValidation(Validator $validator)
    {
        $errorsPerRow = [];

        foreach ($validator->errors()->getMessages() as $field => $messages) {
            $i = explode('.', $field)[1] ?? null; // 例えば、name.1なら1を取り出す

            $errorsPerRow['row.'.$i][] = $messages[0]; // 各行でのすべてのエラーを配列に
        }

        foreach ($errorsPerRow as $key => $messages) {
            $validator->errors()->add($key, implode(' ', $messages)); //　各行でのエラーを１つにまとめる
        }

        throw (new ValidationException($validator))
            ->errorBag($this->errorBag)
            ->redirectTo($this->getRedirectUrl());
    }
}

上の関数は、バリデーションが失敗したときにコールされる関数で、関数内で、各行のすべての項目のエラーを合わせて、row.0などのようなキーにエラーメッセージを割り当てて、新たなエラーを作成します。

そしてそれを、ブレードで以下のように出力できるようにします。

...
        <form method="POST" action="{{ route('form2.store') }}" class="form-horizontal" novalidate="">
          @csrf
          <div class="card-body">
            @error('names')
              <div class="invalid-feedback d-block">{{ $message }}</div>
            @enderror
            <div class="table-responsive">
              <table class="table table-bordered table-hover table-sm">
                <thead>
                  <tr>
                    <th>アイテム名</th>
                    <th class="col-2">価格</th>
                    <th class="col-1">個数</th>
                  </tr>
                </thead>
                <tbody>

                  @for ($i = 0; $i < 3; $i++)
                    <tr>
                      <td>
                        <input class="form-control" maxlength="255" name="names[]" type="text" value="{{ old('names.'.$i) }}">
                       </td>
                      <td>
                        <input class="form-control" maxlength="10" name="prices[]" type="text" value="{{ old('prices.'.$i) }}">
                       </td>
                      <td>
                        <input class="form-control" maxlength="5" name="quantities[]" type="text" value="{{ old('quantities.'.$i) }}">
                       </td>
                    </tr>
                    @error('row.'.$i)
                    <tr>
                      <td colspan="3">
                        <span class="invalid-feedback d-block">{{ $message }}</span>
                      </td>
                    </tr>
                    @enderror
                  @endfor
                </tbody>
              </table>
            </div>
          </div>

          <div class="card-footer">
            <button class="btn btn-primary float-right mr-2" type="submit">保存</button>
          </div>
        </form>
...

各項目のエラー表示を削除して、 @error(‘row.’.$i)で行ごとのエラーの表示としています。

結果は以下のように表示が改善されたエラー出力となります。

最後に

いろいろな形態の入力フォームがあるなか、前回も今回も追加専用のフォームの話でしたが、もちろんコードを変更すれば編集のフォームともなります。

配列値の入力のためのFormRequest

Tue, 07 Sep 2021 07:25:55 +0900

配列値の入力、つまり複数行に同じ入力項目を持つフォームの話です。お客様の登録などのフォームとは違って、バリデーションや画面でのエラーの表示など複雑な部分が多いです。しかし、コントローラで対応するより、FormRequestを使うとすっきりしたコードとなります。

配列値の入力フォーム

各行の入力項目が１つのケースから作成してみます。以下のような画面です。行数は固定で、最大３つまでのメールアドレスの入力が可能です。

コントローラのコードは、極力シンプルにして、投稿が成功したらバリデートした値を出力します。

app/Http/Controllers/FormController.php

namespace App\Http\Controllers;

use App\Http\Requests\EmailsRequest;
use Illuminate\Http\Request;

class FormController extends Controller
{
    /**
     * Show the form for creating a new resource.
     *
     * @return \Illuminate\Http\Response
     */
    public function create()
    {
         return view('form');
    }

    /**
     * Store a newly created resource in storage.
     *
     * @param  App\Http\Requests\EmailsRequest  $request
     * @return \Illuminate\Http\Response
     */
    public function store(EmailsRequest $request)
    {
       ddd($request->validated());
    }
}

ブレードは、

resources/views/form.blade.php

...
<div class="container-fluid">
  <div class="row">
    <div class="col-md-12 col-lg-12 mt-2">
      <div class="card card-primary">

        <div class="card-header">
          <h3 class="card-title">複数行のフォーム</h3>
        </div>

        <form method="POST" action="{{ route('form.store') }}" class="form-horizontal" novalidate="">
          @csrf
          <div class="card-body">
            @error('emails')
              <div class="invalid-feedback d-block">{{ $message }}</div>
            @enderror            
            <div class="table-responsive">
              <table class="table table-bordered table-hover table-sm">
                <thead>
                  <tr>
                    <th>メールアドレス</th>
                  </tr>
                </thead>
                <tbody>
                  @for ($i = 0; $i < 3; $i++)
                  <tr>
                    <td>
                      <input class="form-control" maxlength="255" name="emails[]" type="text" value="{{ old('emails.'.$i) }}">
                      @error('emails.'.$i)
                        <span class="invalid-feedback d-block">{{ $message }}</span>
                      @enderror
                    </td>
                   </tr>
                  @endfor
                </tbody>
              </table>
            </div>
          </div>

          <div class="card-footer">
            <button class="btn btn-primary float-right mr-2" type="submit">保存</button>
          </div>
        </form>
      </div><!-- card -->
    </div>
  </div><!-- row -->
</div>
...

そして、FormRequestは、

app/Http/Requests/EmailsRequest.php

namespace App\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;

class EmaisRequest extends FormRequest
{
    /**
     * Get the validation rules that apply to the request.
     *
     * @return array
     */
    public function rules()
    {
        return [
            'emails.*' => 'nullable|email|distinct', // nullableとしているのは空行を許すため
        ];
    }

    public function messages()
    {
        return [
            'emails.*.email'    => '不正なメールです',
            'emails.*.distinct' => '重複の入力があります'
        ];
    }
}

実際に入力するとエラーはこんな感じで出力されます。

そしてバリデートされた値はこんな感じです。

しかし、これではDBに保存するときにいちいちnullを外す必要ありますね。これもFormRequestで処理したいです。

入力値の加工

FormRequestで入力値を加工するには、以下のようにprepareForValidation()を追加して処理します。

app/Http/Requests/EmailsRequest.php

...
class EmailsRequest extends FormRequest
{
    protected function prepareForValidation()
    {
        $emails = collect($this->emails)
            ->filter(function ($email) {
                return $email !== null; //ここでnull値を削除
            })->all();

        $this->merge([
            'emails' => $emails,
        ]);
    }

    /**
     * Get the validation rules that apply to the request.
     *
     * @return array
     */
    public function rules()
    {
        return [
            'emails'   => 'required|array', //入力を必須とする
            'emails.*' => 'nullable|email|distinct',
        ];
    }

    public function messages()
    {
        return [
            'emails.required'   => '必ず１つの入力が必要です',
            'emails.*.email'    => '不正なメールです',
            'emails.*.distinct' => '重複の入力があります'
        ];
    }
}

最低１つの入力を条件とするために、‘emails’ => ‘required|array’, もrules()も追加しています。

さて、先の投稿でバリデートされたデータは、今度は以下のようにnullの値はなくなりました。

そして、何も入力がなく投稿された場合は以下のようなエラーとなります。

ちなみに、最低２つの入力を条件としたいときは、ルールを、‘emails’ => ‘required|array|min:2’, とすればよいです。

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"

from句のサブクエリ

Tue, 03 Aug 2021 23:53:37 +0900

集計用のコマンドを書いていてクエリビルダでfrom句にサブクエリを使いたいケースが発生しました。公式ドキュメントを見てもwhere句かjoin句でのサブクエリしか書かれていません。恐らくこうやるのでは？と、試してみたら期待通りに動いてしまい、結局、不安になってソースを確認したのでその共有です。

from句のサブクエリが必要なケースとは？

例えばECサイトにおける顧客分析で注文回数別にユーザ数を算出する場合を考えてみましょう。

以下のような注文テーブルがDBにあったとして、ユーザが商品を注文する度にこのテーブルにレコードが挿入されます。

そして、以下のようなデータを出力したいとします。

１回購入したユーザは60人、２回購入したユーザは50人、３回購入したユーザは10人、、、といった具合です。

これを出力する為のsql文は以下になります。

select
    invoice_count,
    count(user_id) as user_count
from (
    select
        user_id,
        count(invoice_id) as invoice_count
    from invoices
    group by user_id
) as invoices_by_user
group by invoice_count;

from句にユーザごとの購入回数を取得するサブクエリを指定する必要があり、これをどうやってクエリビルダで組み立てるか？が今回のゴールです。

※次項から解説になりますが、手を動かしながら確認したい方は記事の最後のおまけ、検証データ準備をご参照下さい。

DB::table($subQuery)

冒頭にて触れた通り、公式ドキュメントに載っているのはwhere句やjoin句にsubQueryを指定する方法です。いずれもClosureを指定して実現しています。ということは、table()に同様にClosureを渡せば良いのでは？、と思いやってみました。

まず、$subQueryという変数にClosureを格納します。Closureの引数にクエリビルダを指定し、サブクエリにて実行したいクエリを定義します。

$subQuery = function ($query) {
    $query->from('invoices')
        ->selectRaw('user_id, count(invoice_id) as invoice_count')
        ->groupBy('user_id');
};

次に、それをtable()の引数に指定してみます。

$query = DB::table($subQuery)
    ->selectRaw('invoice_count, count(user_id) as user_count')
    ->groupBy('invoice_count');

最後に、toSql()でクエリを確認してみましょう。（見辛いので改行しています）

>>> $query->toSql();
=> "select invoice_count, count(user_id) as user_count 
    from (
        select user_id, count(invoice_id) as invoice_count 
        from `invoices` 
        group by `user_id`
    ) as `` 
　　　　　　　　group by `invoice_count`"

予想通り(?)、from句のサブクエリを指定することが出来ました。しかし、よく見てみるとサブクエリのエイリアスが空文字(``)になってしまっています。ここで私はこれが正しい使い方なのか不安になり、table()を解析することにしました。

ソース確認

まず、DBファサードを見てみます。すると、Docコメントにてtableメソッドについて記述されています。

vendor/laravel/framework/src/Illuminate/Support/Facades/DB.php

namespace Illuminate\Support\Facades;

/**
 * @method static \Illuminate\Database\ConnectionInterface connection(string $name = null)
 * @method static \Illuminate\Database\Query\Builder table(string $table, string $as = null)   <- ココ
...

第二引数にstring $asを取っているので、エイリアスはそこに指定すれば良さそうですね。せっかくなので、メソッドを見てみます。メソッドは下記のどちらかに定義されているようです。

vendor/laravel/framework/src/Illuminate/Support/Facades/DB.php

...
 * @see \Illuminate\Database\DatabaseManager
 * @see \Illuminate\Database\Connection
...

確認したところ、\Illuminate\Database\Connectionにありました。

vendor/laravel/framework/src/Illuminate/Database/Connection.php

   /**
     * Begin a fluent query against a database table.
     *
     * @param  \Closure|\Illuminate\Database\Query\Builder|string  $table
     * @param  string|null  $as
     * @return \Illuminate\Database\Query\Builder
     */
    public function table($table, $as = null)
    {
        return $this->query()->from($table, $as);
    }

なるほど、第一引数の$tableにはstring以外に、Closureやクエリビルダも渡すことができるみたいです。そして、内部的にはfrom()を呼び出しています。from()はどうなっているのでしょうか？

vendor/laravel/framework/src/Illuminate/Database/Query/Builder.php

    /**
     * Set the table which the query is targeting.
     *
     * @param  \Closure|\Illuminate\Database\Query\Builder|string  $table
     * @param  string|null  $as
     * @return $this
     */
    public function from($table, $as = null)
    {
        if ($this->isQueryable($table)) {
            return $this->fromSub($table, $as);
        }

        $this->from = $as ? "{$table} as {$as}" : $table;

        return $this;
    }

なるほどなるほど、$tableがClosureやクエリビルダであればisQueryable()がtrueとなりfromSub()を呼び出すようです。join句にサブクエリを指定するメソッドがjoinSub()なので、from句ならfromSubというわけですね。

まとめ

クエリビルダでサブクエリを指定するには以下のいずれかの方法で実現できます。

// tableメソッドで指定
DB::table($subQuery, $as)->...;

// fromメソッドで指定
DB::query()->from($subQuery, $as)->...;

// fromSubで指定
DB::query()->fromSub($subQuery, $as)->...;

上記の$subQueryは、ClosureでもクエリビルダでもOKです。以下はクエリビルダで指定してみた例です。

$subQuery = DB::table('invoices')
        ->selectRaw('user_id, count(invoice_id) as invoice_count')
        ->groupBy('user_id');

$query = DB::table($subQuery, 'sub')    // エイリアスをsubとしてみました。
    ->selectRaw('invoice_count, count(user_id) as user_count')
    ->groupBy('invoice_count');

$query->toSql();

=> "select invoice_count, count(user_id) as user_count 
    from (
        select user_id, count(invoice_id) as invoice_count 
        from `invoices` group by `user_id`
    ) as `sub`     // as sub になりました。
    group by `invoice_count`"

たまにドキュメントにて網羅されていないメソッドなどがありますが、そんな時は少しソースを覗いてみると良いかもしれませんね。

おまけ、検証データ

実際にデータを入れて手を動かしながら確認してみたい方は以下の手順でデータを用意できます。 Laravel 7.xのインストールにてDBのセットアップまで完了している状態からの手順となります。

Model、migrationファイル、Factoryクラス作成

php artisan make:model Invoice -m -f

invoicesのmigrationファイルを編集します。使用するのはinvoice_idとmember_idのみなので、そちらを追加。

database/migrations/2021_07_28_035716_create_invoices_table.php

/**
 * Run the migrations.
 *
 * @return void
 */
public function up()
{
    Schema::create('invoices', function (Blueprint $table) {
        $table->id('invoice_id');
        $table->integer('user_id')->default(0);
        $table->timestamps();
    });
}
...

DBに反映。

php artisan migrate

Seederで検証用データを作成。今回はinvoicesテーブルしか使わないので、わざわざ専用のSeederクラスを作成せず、DatabaseSeeder.phpのrun()に直接記述しました。

database/seeds/DatabaseSeeder.php

use App\Invoice;
use Illuminate\Database\Seeder;

class DatabaseSeeder extends Seeder
{
    /**
     * Seed the application's database.
     *
     * @return void
     */
    public function run()
    {
        $params = [];

        for ($i=0; $i<100; $i++) {

            // user_id毎に 0~10 のランダムな数の注文レコードを作成する
            for ($j=0; $j < rand(0, 10); $j++) { 
                $params[] = [
                    'user_id' => $i,
                ];
            }
        }

        Invoice::insert($params);
    }
}

ユーザ毎に購入回数をばらつかせたいのでrand()を使用して０から１０の注文レコードを、１００ユーザ分用意するようにしました。また、データの挿入が速く終わるように、以前bulk insertで大量のデータをDBに登録するで紹介した方法を採っています。

seederを実行して、DBにレコードを挿入。

php artisan db:seed

mysql上で登録されたデータを確認してみます。冒頭の、from句のサブクエリが必要なケースとは？で示したクエリを実行してみましょう。

+---------------+------------+
| invoice_count | user_count |
+---------------+------------+
|             1 |         21 |
|             2 |         14 |
|             3 |         21 |
|             4 |         13 |
|             5 |         14 |
|             6 |          4 |
|             7 |          5 |
+---------------+------------+
7 rows in set (0.01 sec)

いい感じにバラけていますね！検証用データの準備は以上です。

Laravel Collection（７）よく使うgroupBy

Sun, 25 Jul 2021 02:18:40 +0900

Collectionの中でとても好きなメソッドは、groupBy()です。Laravelが存在しなかった時代ではよくDBクエリから返ってくる１次元の配列をグループ化するため、汚いコードを書いて２次元の配列に変換していたものです。しかし、CollectionのgroupByがあるとコードがシンプルで綺麗に書けること書けること。

このような画面が欲しい

以下のようなデータがDBにあると仮定して、

mysql> select id, name, gender from users;
+----+---------------+-----------+
| id | name          | gender    |
+----+---------------+-----------+
|  1 | 山田 千代     | 無回答    |
|  2 | 佐藤 健一     | 男        |
|  3 | 加藤 篤司     | 無回答    |
|  4 | 山口 花子     | 女        |
+----+---------------+-----------+
4 rows in set (0.01 sec)

このデータを性別でグループ化して、以下の画面の表示となるようにしたいのです。

DBレベルでのデータのグループ化

DBレベルでは、データをグループ化して例えば性別（gender）ごとのユーザー数とかを以下のように取得できます。

>>> User::groupBy('gender')->selectRaw('gender, count(*)')->get();
=> Illuminate\Database\Eloquent\Collection {#3422
     all: [
       App\User {#4345
         gender: "女",
         count(*): 1,
       },
       App\User {#4348
         gender: "無回答",
         count(*): 2,
       },
       App\User {#4349
         gender: "男",
         count(*): 1,
       },
     ],
   }

ちなみに実行されたSQL文は、

>>> sql()
=> [
     [
       "query" => "select gender, count(*) from `users` group by `gender`",
       "bindings" => [],
       "time" => 0.56,
     ],
   ]

しかしこれでは先の欲しい画面のデータを表示するには、さらにそれぞれの性別において個々のDBレコードの情報取得が必要となります。つまり、以下のようなSQLの実行が３回必要となります。

>>> User::where('gender', '=', '男')->get();
=> Illuminate\Database\Eloquent\Collection {#4345
     all: [
       App\User {#4348
         id: 2,
         name: "佐藤 健一",
         gender: "男",
...
       },
     ],
   }

しかし、これではトータル４回のSQL文の実行となってしまい効率的でありません。

Collectionでのグループ化

今度は、DBからレコードを全部取得してからデータをグループ化します。

>>> User::all()->groupBy('gender');
=> Illuminate\Database\Eloquent\Collection {#4336
     all: [
       "無回答" => Illuminate\Database\Eloquent\Collection {#4120
         all: [
           App\User {#3392
             id: 1,
             name: "山田 千代",
...
           },
           App\User {#4361
             id: 3,
             name: "加藤 篤司",
 ...
           },
         ],
       },
       "男" => Illuminate\Database\Eloquent\Collection {#4345
         all: [
           App\User {#4188
             id: 2,
             name: "佐藤 健一",
...
           },
         ],
       },
       "女" => Illuminate\Database\Eloquent\Collection {#4276
         all: [
           App\User {#3403
             id: 4,
             name: "山口 花子",
...
           },
         ],
       },
     ],
   }

DBレベルのグループ化と違って、DBから取得した後にCollectionのgroupBy()を適用なので、データをグループ化するだけでなく個々のデータもコレクションにキープしてくれます。そして、実行されたSQL文をチェックしてみると以下のように１つのみです。

>>> sql()
=> [
     [
       "query" => "select * from `users`",
       "bindings" => [],
       "time" => 0.51,
     ],
   ]

コントローラの作成

CollectionのgroupByを使用して必要な構造データを取得できたところで、コントローラを作成です。

app/Http/Controlles/UserController.php

namespace App\Http\Controllers;

use App\User;

class UserController extends Controller
{
    /**
     * Display a listing of the resource.
     *
     * @return \Illuminate\Http\Response
     */
    public function index()
    {
        return view('users')
            ->with(['genders' => User::all()->groupBy('gender')]);
    }
}

ブレードは以下のように、２つのループ（@foreach）を使い、グループのキーである性別と個々のレコードを分けて表示します。

resources/views/users.blade.php

@section('content')
<div class="container">
    <div class="row justify-content-center">
        <div class="col-md-8">
            <div class="card">
                <div class="card-header">ユーザー性別分け</div>
                <div class="card-body">
                    <table class="table">
                        <thead>
                            <tr>
                                <td class="col-1"></td>
                                <td class="col-1">ID</td>
                                <td>名前</td>
                            </tr>
                        </thead>
                        <tbody>
                        @foreach($genders as $gender => $users)
                            <tr>
                                <td colspan="3">{{ $gender }}</td>
                            </tr>
                            @foreach($users as $user)
                                <tr>
                                    <td></td>
                                    <td class="text-right">{{ $user->id }}</td>
                                    <td>{{ $user->name }}</td>
                                </tr>
                            @endforeach
                        @endforeach
                        </tbody>
                    </table>
                </div>
            </div>
        </div>
    </div>
</div>
@endsection

これでめでたし欲しかった画面の完成です。

Laravel Collection（６）複数のキーでソート

Mon, 12 Jul 2021 00:00:42 +0900

前回に続き、Collectionのsortメソッドについて解説していきます。今回は複数の項目を使ったソートについてです。

前回同様、以下のサンプルデータを使いますのでコピペして手を動かしつつ読み進めていただけると幸いです。

// 再掲
$houses = collect([
    ['id' => 1, 'price' => 3000, 'size' => 100, 'age' => 20, 'station_distance' => 0.6],
    ['id' => 10, 'price' => 3000, 'size' => 70, 'age' => 3, 'station_distance' => 1.1],
    ['id' => 23, 'price' => 1600, 'size' => 60, 'age' => 13],
    ['id' => 3, 'price' => 1600, 'size' => 50, 'age' => 11, 'station_distance' => 2.0],
]);

複数の項目によるソート

前回は物件情報を例にsort, sortBy, sortKeysを使い、広さや築年数など１つの項目をピックアップして並び替える方法について解説しました。しかし、時としてある項目で並び替えた後に値が同じであるならば、別の項目によって並び替えたいケースがあります。

例えば、物件情報を価格の安い順に並び替えた後、同じ価格の物件が複数あるならそれらを築年数が浅い順に並び替えたい、などの場合です。このような複雑な並び替えは、sort()の引数に比較ロジックをcallback関数で指定します。

sort($callback)

Laravel公式のドキュメントにはsort()にcallback関数を渡す場合について、実例が載っていませんが、

If your sorting needs are more advanced, you may pass a callback to sort with your own algorithm. Refer to the PHP documentation on uasort, which is what the collection's sort method calls under the hood.

と書かれています。ので、PHPのuasortのドキュメントを確認しましょう。そちらの例1 基本的な uasort() の例にてcallback関数の例が示されています。

<?php
// 比較用の関数
function cmp($a, $b) {
    if ($a == $b) {
        return 0;
    }
    return ($a < $b) ? -1 : 1;
}

なるほど、$aと$bを引数に取り大小を比較する関数ですね。$a < $b なら１、$a > $b なら−１、$a = $b なら０が返されます。

例を参考に、まずは価格（昇順）で並び替えるcallback関数を書いてみましょう。

>>> function cmpPrice($a, $b) {
        if ($a['price'] == $b['price']) {
            return 0;
        }
 
        return ($a['price'] < $b['price']) ? -1 : 1;
    }

そして、それをsort()に指定してみましょう。

>>> $houses->sort('cmpPrice');
=> Illuminate\Support\Collection {#3397
     all: [
       2 => [
         "id" => 23,
         "price" => 1600,
         "size" => 60,
         "age" => 13,
       ],
       3 => [
         "id" => 3,
         "price" => 1600,
         "size" => 50,
         "age" => 11,
         "station_distance" => 2.0,
       ],
       0 => [
         "id" => 1,
         "price" => 3000,
         "size" => 100,
         "age" => 20,
         "station_distance" => 0.6,
       ],
       1 => [
         "id" => 10,
         "price" => 3000,
         "size" => 70,
         "age" => 3,
         "station_distance" => 1.1,
       ],
     ],
   }

価格が安い順にソートされましたね。正しくソートされているか不安な場合は前回紹介したsortBy()を使って確認してみましょう。

>>> $houses->sort('cmpPrice') == $houses->sortBy('price');
=> true

因みに、cmpPriceは昇順にソートされますが、

return ($a['price'] < $b['price']) ? -1 : 1;

この部分を

return ($a['price'] < $b['price']) ? 1 : -1;

とプラスマイナスを逆にすれば、降順にする事もできます。

続いて、価格が同じだった場合に築年数で比較するロジックを追加してみましょう。価格の比較では名前付き関数を用意しましたが、次のコードではsort()内で無名関数で指定しています。laravelではこちらが一般的です。コードは以下のようになります。

>>> $houses->sort(function ($a, $b) {
        if ($a['price'] == $b['price']) {
            if ($a['age'] == $b['age']) {
                return 0;
            }
    
            return ($a['age'] < $b['age']) ? -1 : 1;
        }
    
        return ($a['price'] < $b['price']) ? -1 : 1;
    });
=> Illuminate\Support\Collection {#3397
     all: [
       3 => [
         "id" => 3,
         "price" => 1600,
         "size" => 50,
         "age" => 11,
         "station_distance" => 2.0,
       ],
       2 => [
         "id" => 23,
         "price" => 1600,
         "size" => 60,
         "age" => 13,
       ],
       1 => [
         "id" => 10,
         "price" => 3000,
         "size" => 70,
         "age" => 3,
         "station_distance" => 1.1,
       ],
       0 => [
         "id" => 1,
         "price" => 3000,
         "size" => 100,
         "age" => 20,
         "station_distance" => 0.6,
       ],
     ],
   }

価格だけで並び替えた際と見比べてください、同じ価格の場合に築浅順に並び替えられていますね。

今回は価格と築年数のみを考慮しましたが、同様に比較ロジックを追加していけば更に細かく並び順を指定できます。しかし、上記のコードではifの入れ子が増え、とても読み辛いコードになってしまいます。でも安心して下さい、次に紹介する宇宙船演算子とエルビス演算子の合せ技でとてもスッキリさせることができます！

宇宙船演算子(<=>)とエルビス演算子(?:)の合せ技

２つの演算子について軽くおさらいしておきましょう。

宇宙船演算子

宇宙演算子はPHP7から追加された比較演算子で以下のように記述します。

$a <=> $b;

$aと$bを比較し、$a > $bなら１、$a = $bなら0、 $a < $bなら-1を返します。

お気づきかと思いますが、まさに前項で作成したcallback関数と同じ結果を返してくれます。

それにしても面白い名前ですね。初めてこの演算子を見た時は、使い方よりもまず名前の由来を検索してしまいました。諸説色々あるみたいですが、中でもStar Warsのダースベーダー専用タイファイターに似ている！というのが有力なのだとか。。。気になる人はググってみて下さい！

エルビス演算子

もう１つキーとなるのがエルビス演算子です。こちらはPHP5.3からあるので馴染みのある演算子かと思います。

$a ?: $b;

$aがtrueなら$aを返し、falseなら$bを返します。

エルビス演算子の由来は、歌手のエルヴィス・プレスリーの顔文字だそうです。。。どこが？っとなりますが、確かにハテナマークがリーゼントに見えなくも無いかも・・・。私はよくNULL合体演算子と混同してしまうのですが、こちらも名前の由来を知ってから忘れなくなりました。

宇宙船演算子とエルビス演算子を組み合わせると前項のコードは以下のように書き換えられます。

>>> $houses->sort(function ($a, $b) {
        return $a['price'] <=> $b['price']
            ?: $a['age'] <=> $b['age'];
    });

とてもスッキリしましたね！価格が同じ場合は $a[‘price’] <=> $b[‘price’]の結果が0となり、booleanに変換するとfalseなのでエルビス演算子により築年数の比較に進む、というわけです。

さらに築年数が同じなら広さ、広さが同じなら駅からの距離、と並び替えたい場合は以下のように２行加えるだけです。

 
>>> $houses->sort(function ($a, $b) {
        return $a['price'] <=> $b['price']
            ?: $a['age'] <=> $b['age']
            ?: ($a['size'] <=> $b['size']) * -1
            ?: ($a['station_distance'] <=> $b['station_distance']) * -1;
    });

簡単ですね！

sizeとstation_distanceは降順に並び替えたいので-1を掛けています、ご注意を。

Laravel8のsortBy()

ここまでLaravel7を前提に複数の項目で並び替える方法を紹介してきました。しかし実はこれ、Laravel8ではsortBy()でもっと簡単に同じことができます。

公式ドキュメントを見ると、sortBy()に並べ替える属性と目的の並べ替えの方向で構成される配列が指定できる旨が書いてあります。よって、Laravel8では以下で同じことが出来ます。

$houses->sortBy([
    ['price', 'asc'],
    ['age', 'asc'],
    ['size', 'desc'],
    ['station_distance', 'desc'],
]);

こちらの方が分かりやすいですね、Laravel8にアップグレードした際はこちらを使っていきたいと思います。

Laravel Collection（５）ソート

Sun, 04 Jul 2021 11:45:47 +0900

そろそろ引っ越しをしようかと思い、毎日物件情報サイトを物色しているhikaruです。

物件選びは価格や広さ、築年数、その他様々な側面から比較していく必要があるのでなかなか骨の折れる作業ですね。物件情報がCollectionにまとめられていればサクッと私好み順に並び替えられるのに、としみじみCollectionのありがたみを実感している今日このごろです。

ということで、今回はCollectionのありがたいsort関連のメソッド３つ、sort, sortBy, sortKeysについて解説したいと思います。

サンプルデータ

以降の解説にて使う物件情報を

物件ID
価格(万円)
広さ(㎡)
築年数
駅までの距離(km)

としてコレクションにまとめました、コピペして活用してくださいね。

$houses = collect([
    ['id' => 1, 'price' => 3000, 'size' => 100, 'age' => 20, 'station_distance' => 0.6],
    ['id' => 10, 'price' => 3000, 'size' => 70, 'age' => 3, 'station_distance' => 1.1],
    ['id' => 23, 'price' => 1600, 'size' => 60, 'age' => 13],
    ['id' => 3, 'price' => 1600, 'size' => 50, 'age' => 11, 'station_distance' => 2.0],
]);

sort()

sortメソッドは一次元なコレクションデータを並び替えるのに使用します、例えば築年数を抽出して浅い順に並び替えてみましょう。

>>> $houses->pluck('age', 'id')->sort();
=> Illuminate\Support\Collection {#3330
     all: [
       10 => 3,
       3 => 11,
       23 => 13,
       1 => 20,
     ],
   }

特定の項目を抽出するのはpluckメソッドでしたね、khino氏がLaravel Collection（２） Collectionを返すメソッドで解説しているので忘れてしまった人は復習しておきましょう。

実行結果を見ると、小さい値から大きい値へ順に並び変えられているのが分かります。小から大へ並び変える事を昇順と言います。逆に大から小へ並び替える事を降順と言います。降順に並び替えるにはsortDescメソッドを使います。

>>> $houses->pluck('age', 'id')->sortDesc();
=> Illuminate\Support\Collection {#3396
     all: [
       1 => 20,
       23 => 13,
       3 => 11,
       10 => 3,
     ],
   }

また、この後説明するsortByもsortKeysも末尾にDescを付ける事で降順となります。覚えやすいですね！

sortBy()

sortByは指定した引数の項目によって並び替えるメソッドです。例えば、$housesを狭い順に並び替えてみましょう。

>>> $houses->sortBy('size')
=> Illuminate\Support\Collection {#3404
     all: [
       3 => [
         "id" => 3,
         "price" => 1600,
         "size" => 50,
         "age" => 11,
         "station_distance" => 2.0,
       ],
       2 => [
         "id" => 23,
         "price" => 1600,
         "size" => 60,
         "age" => 13,
       ],
       1 => [
         "id" => 10,
         "price" => 3000,
         "size" => 70,
         "age" => 3,
         "station_distance" => 1.1,
       ],
       0 => [
         "id" => 1,
         "price" => 3000,
         "size" => 100,
         "age" => 20,
         "station_distance" => 0.6,
       ],
     ],
   }

ところで、引数で指定した項目がセットされていない場合はどうなるのでしょう？station_distanceで並び替えてみましょう。

>>> $houses->sortBy('station_distance');
=> Illuminate\Support\Collection {#3406
     all: [
       2 => [
         "id" => 23,
         "price" => 1600,
         "size" => 60,
         "age" => 13,
       ],
       0 => [
         "id" => 1,
         "price" => 3000,
         "size" => 100,
         "age" => 20,
         "station_distance" => 0.6,
       ],
       1 => [
         "id" => 10,
         "price" => 3000,
         "size" => 70,
         "age" => 3,
         "station_distance" => 1.1,
       ],
       3 => [
         "id" => 3,
         "price" => 1600,
         "size" => 50,
         "age" => 11,
         "station_distance" => 2.0,
       ],
     ],
   }

station_distanceがセットされていない要素が先頭に来ました。セットされていない要素は0と同じ扱いなのでしょうか？いえ、そうではありません。セットされていない値はnullとして扱われているのです。そして、マイナス値を含めてソートした場合も先頭にきます。以下のように１次元コレクションで確認すると分かりやすいです。

>>> $col = collect([1, null, -1]);
=> Illuminate\Support\Collection {#3388
     all: [
       1,
       null,
       -1,
     ],
   }
>>> $col->sort()
=> Illuminate\Support\Collection {#3406
     all: [
       1 => null,
       2 => -1,
       0 => 1,
     ],
   }
>>> $col->sortDesc()
=> Illuminate\Support\Collection {#3398
     all: [
       0 => 1,
       2 => -1,
       1 => null,
     ],
   }

これは配列のsort関数と同じ仕様です。nullとは値を持たない事を表現する型の唯一の値であり、他の型（boolean, int, float, stringなど）が混在する配列においては、昇順では先頭に、降順では末尾に並び替えされるのです。

sortKeys()

最後にCollectionのキーによってソートするsortKeysについて見てみましょう。$housesをidをキーにしてソートしてみましょう。特定の項目をkeyに指定するにはkeyByメソッドを使います。

>>> $houses->keyBy('id')->sortKeys()
=> Illuminate\Support\Collection {#3414
     all: [
       1 => [
         "id" => 1,
         "price" => 3000,
         "size" => 100,
         "age" => 20,
         "station_distance" => 0.6,
       ],
       3 => [
         "id" => 3,
         "price" => 1600,
         "size" => 50,
         "age" => 11,
         "station_distance" => 2.0,
       ],
       10 => [
         "id" => 10,
         "price" => 3000,
         "size" => 70,
         "age" => 3,
         "station_distance" => 1.1,
       ],
       23 => [
         "id" => 23,
         "price" => 1600,
         "size" => 60,
         "age" => 13,
       ],
     ],
   }

まとめ

以上がCollectionの基本的なsort系メソッドの使い方になります。次回は一歩踏み込んだソートについて解説していきたいと思います。

Laravel Collection（４）合計の計算

Mon, 28 Jun 2021 22:49:23 +0900

Collectionを使っての合計の計算は簡単です。例えば、注文の総個数の計算は$collection->sum(‘quantity’)です。金額と個数の掛け算で総合計金額の計算はどうでしょう。直感的に$collection->sum(‘price*quantity’)では、と思いますがそれはうまくいきません。さて、どう計算するのでしょう？

データの準備

準備として、まず以下migrationファイルを作成して、DBテーブルを作成します。

database/migrations/2021_06_26_164123_create_order_items_table.php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

class CreateOrderItemsTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::create('order_items', function (Blueprint $table) {
            $table->id();
            $table->unsignedBigInteger('order_id')->index();
            $table->string('name');
            $table->decimal('price', 8, 0);
            $table->unsignedInteger('quantity');
            $table->timestamps();
        });
    }

    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        Schema::dropIfExists('order_items');
    }
}

今度は、factoryの作成です。

database/factories/OrderItemFactory.php

/** @var \Illuminate\Database\Eloquent\Factory $factory */

use App\OrderItem;
use Faker\Generator as Faker;
use Illuminate\Support\Str;

$factory->define(OrderItem::class, function (Faker $faker) {
    return [
        'order_id' => $faker->numberBetween(1, 3),
        'name' => Str::upper($faker->word()),
        'price' => $faker->numberBetween(100, 1000),
        'quantity' => $faker->numberBetween(1, 10),
    ];
});

さて、次にtinkerでサンプルデータを作成します。

>>> factory(App\OrderItem::class, 9)->create();
=> Illuminate\Database\Eloquent\Collection {#4246
     all: [
       App\OrderItem {#4247
         id: 1,
         order_id: 1,
         name: "BEATAE",
         price: "924",
         quantity: 10,
         created_at: "2021-06-26 19:58:26",
         updated_at: "2021-06-26 19:58:26",
       },
       App\OrderItem {#4248
         id: 2,
         order_id: 1,
...

作成されたデータをmysqlで閲覧するとこんな感じです。

mysql> select id, order_id, price, quantity from order_items where order_id = 1;
+----+----------+-------+----------+
| id | order_id | price | quantity |
+----+----------+-------+----------+
|  1 |        1 |   924 |       10 |
|  2 |        1 |   157 |        8 |
|  3 |        1 |   294 |        7 |
|  4 |        1 |   839 |        2 |
|  6 |        1 |   450 |        6 |
|  8 |        1 |   310 |        9 |
+----+----------+-------+----------+

ちなみに、sqlでは先の合計金額の計算は、

mysql> select sum(price * quantity) from order_items where order_id = 1;
+-----------------------+
| sum(price * quantity) |
+-----------------------+
|                 19722 |
+-----------------------+

と簡単に計算できます。

合計金額の計算

データが揃ったところでCollectionを利用して計算です。最初に、Eloquentで注文番号１のアイテムのCollectionを作成します。

>>> use App\OrdreItem;
>>> $items = OrderItem::where('order_id', '=', 1)->get();
=> Illuminate\Database\Eloquent\Collection {#3317
     all: [
       App\OrderItem {#4249
         id: 1,
         order_id: 1,
         name: "BEATAE",
         price: "924",
         quantity: 10,
         created_at: "2021-06-26 19:58:26",
         updated_at: "2021-06-26 19:58:26",
       },
       App\OrderItem {#4103
         id: 2,
         order_id: 1,
...

試しに、先の間違った合計金額の計算を実行してみましょうか。さて、どうなるか。

>>> >>> $items->sum('price*quantity');
=> 0

もちろん、sum()の引数は項目名を指定しなければならないので、‘price*quantity’ような項目名はありもしないので合計はゼロです。

正しい方法としては、map()とsum()の２つの関数を利用します。それぞれのアイテムの合計金額のCollectionを作成してその和を計算です。

>>> $items->map(function($item) { return $item->price * $item->quantity; })->sum();
=> 19722

ちょっと長くなったけれどわかりやすい計算です。

この他には、reduce()を使用した計算もあります。

>>> $items->reduce(function($carry, $item) { return $carry + $item->price * $item->quantity;}, 0);
=> 19722

reduce()で使われる$carryは第２の引数として与えらた値（この場合ゼロ）を初期値としてループの中で計算（金額ｘ個数）した値を前回の$carryに足していきます。こちらの方法も悪くはないですね。前のmapに比べては余計なCollectionを作成しない分だけ効率かもしれません。

bulk insertをtransaction処理にする

Sat, 19 Jun 2021 03:00:16 +0900

以前投稿したbulk insertで大量のデータをDBに登録するの記事では10万レコードの挿入をbulk insertで行い、通常のinsertと比べてどれだけ速くなるのか検証しました。結果は一目瞭然で、大量のレコードをDBに登録する際には強力な武器になる事が分かりました。

しかし、前回のコードを実際の運用で使うには１つ問題があります。それはbulk insertの途中でエラーが発生した場合、DBに中途半端にレコードが残ってしまうという問題です。今回はこの問題を解決するために、前回のコードをtransactionに入れ、エラーが発生した際にロールバックされるように改修します。そして、transaction処理にする事でパフォーマンスにどのような影響があるか検証してみます。

エラー発生時の挙動

改修を始める前にまずは途中でエラーが発生し処理が異常終了してしまった場合の挙動を確認してみましょう。前回の記事で作成したUsersSeederを以下のように編集し、9999件目のレコード挿入でわざと重複エラーを発生させてみましょう。

database/seeds/UsersSeeder.php

use App\User;
use Faker\Factory as Faker;
use Illuminate\Database\Seeder;

class UsersSeeder extends Seeder
{
    /**
     * Run the database seeds.
     *
     * @return void
     */
    public function run()
    {
        $faker = Faker::create('ja_JP');

        $params = [];

        for ($i=0; $i < 100000; $i++) {
            $email = "test{$i}@example.com"; 

            // 9999件目でemailが重複
            if ($i == 9999) {
                $email = "test1@example.com";
            }

            $params[] = [ 
                'name' => $faker->name(),
                'email' => $email,
                'password' => 'testtest',
            ];

            if (count($params) >= 1000) {
                User::insert($params);
                $params = [];
            }
        }
    }
}

seederを実行すると以下のように重複エラーが発生するはずです。

% php artisan db:seed
Seeding: UsersSeeder

   Illuminate\Database\QueryException  : SQLSTATE[23000]: Integrity constraint violation: 1062 Duplicate entry 'test1@example.com' for key 'users_email_unique' (SQL: insert into `users` (`email`, `name`, `password`) values ...

この時点でDB上のレコード件数を確認してみると。。。

mysql> select count(*) from users;
+----------+
| count(*) |
+----------+
|     9000 |
+----------+
1 row in set (0.01 sec)

9999件目でエラーが発生し、処理がabortされたので最後の999件は登録されませんでしたが、それまでの9000件のレコードが登録されたままの中途半端な状態になっています。前回の記事ではseederの実行前にtruncateメソッドを実行し、テーブルを空にしていたため、再度seederを実行しても問題ありませんでした。しかし、エラーにより処理が途中で強制終了されたのであれば、失敗した中途半端な状態は残さず、実行前の状態に戻るのが望ましいです。

transaction処理の実装

それではtransaction処理を実装し、エラー発生時にロールバックするように修正してみましょう。Laravelでは以下のようにDBファサードを使うとtransaction処理が簡単に実装できます。

// transaction開始
DB::beginTransaction();

try {

    // 何かしらのDB操作...

    // transactionコミット
    DB::commit();
} catch (\Throwable $th) {

    // ロールバック
    DB::rollBack();
}

修正を加えたコードが以下になります。

database/seeds/UsersSeeder.php

use App\User;
use Faker\Factory as Faker;
use Illuminate\Database\Seeder;
use Illuminate\Support\Facades\DB;

class UsersSeeder extends Seeder
{
    /**
     * Run the database seeds.
     *
     * @return void
     */
    public function run()
    {
        DB::beginTransaction();

        try {
            $this->insertDummies();

            DB::commit();
        } catch (\Throwable $th) {
            DB::rollBack();

            throw new Exception('failed seeding User, so rolled back.');
        }
    }

    private function insertDummies()
    {
        $faker = Faker::create('ja_JP');

        $params = [];

        for ($i=0; $i < 100000; $i++) {

            $email = "test{$i}@example.com";

            // 9999件目でemailが重複
            if ($i == 9999) {
                $email = "test1@example.com";
            }

            $params[] = [
                'name'  => $faker->name(),
                'email' => $email,
                'password' => 'testtest',
            ];

            if (count($params) >= 1000) {
                User::insert($params);
                $params = [];
            }
        }
    }
}

runメソッドが冗長になってしまう為、レコード作成処理をinsertDummiesメソッドに切り出しました。レコード作成処理の途中でエラーが発生した場合はDB::rollback()によってinsertDummiesメソッド実行前に巻き戻されるはずです。

再度、seederを実行してみましょう。

% php artisan db:seed
Seeding: UsersSeeder

   Exception  : failed seeding User, so rolled back.
...

Errorが発生し期待通りロールバックされました。DB側を確認してみましょう。

mysql> select count(*) from users;
+----------+
| count(*) |
+----------+
|        0 |
+----------+
1 row in set (0.00 sec)

実行前の状態に戻されていますね。

処理速度に影響は？

通常のinsert処理からbulk insertに切り替える事の最大のメリットはその速さでしたが、transaction処理に切り替える事で何か影響は在るでしょうか？チェックしてみましょう。

insertDummiesメソッド内のエラーを発生させていた以下の行を削除し、正常終了するように直します。

database/seeds/UsersSeeder.php

...
            // 9999件目でemailが重複
            if ($i == 9999) {
                $email = "test1@example.com";
            }
...

再度、seederを実行してみましょう。

% php artisan db:seed
Seeding: UsersSeeder
Seeded:  UsersSeeder (6.87 seconds)
Database seeding completed successfully.

約6.9秒、transaction無しの状態で約5.8秒だったので約１秒遅くなりましたが、気にするほどでは無さそうですね。

Laravel Collection（３）カスタムメソッド

Sun, 13 Jun 2021 09:23:55 +0900

前回においてCollectionのeach()でUserのオブジェクトにageの属性を追加する処理をしましたが、今回はこれを発展させて、UserのCollectionにカスタムメソッドを追加します。

目的

例えば、いつも大人（２０歳以上）だけのユーザーを対象にした処理を行いたいとします。 DBから取得したレコードにおいては、birth_dateの属性があるので現時点での大人だけのレコードは、以下のようにfilter()を利用して、

User::all()->filter(function ($user) {
    return $user->isAdult();
})

のような処理をすれば大人だけのレコード取得が可能です。

上で使用されているisAdult()は以下のように定義します。歳の計算は、アクセッサ getAgeAttributeで行います。

app/User.php

namespace App;

use Carbon\Carbon;
use Illuminate\Contracts\Auth\MustVerifyEmail;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;

class User extends Authenticatable
{
    use Notifiable;
...
    public function getAgeAttribute()
    {
        return Carbon::parse($this->birth_date)->age;
    }

    public function isAdult()
    {
        return $this->age >= 20;
    }
}

さて、これで実際に先ほどのコードをtinkerで実行すると、

>>> User::all()->filter(function ($user) {
        return $user->isAdult();
});

=> Illuminate\Database\Eloquent\Collection {#4179
     all: [
       0 => App\User {#3306
         id: 1,
         name: "坂本 充",
         email: "nishida@example.net",
         email_verified_at: "2021-05-30 21:55:14",
         #password: "$2y$10$snEjTmJvBDu3uxd1bz0QDupihJA3zjvEH5J0pm/aLHG4UvpSfJe/q",
         #remember_token: "j8hPjp8ob7",
         birth_date: "1997-03-02",
         created_at: "2021-05-30 21:55:14",
         updated_at: "2021-05-30 21:55:14",
       },
       2 => App\User {#3986
         id: 3,
         name: "近藤 知実",
         email: "atsushi.ito@example.net",
         email_verified_at: "2021-05-30 21:55:14",
         #password: "$2y$10$A7xldQvOiCfUOyNS57EEYu2/s77a70BPmGoOjzDSgTmveeRlcAD8.",
         #remember_token: "qOFWQFb5ER",
         birth_date: "1972-09-14",
         created_at: "2021-05-30 21:55:14",
         updated_at: "2021-05-30 21:55:14",
       },
     ],
   }

と大人だけのレコードを返してくれます。

さらに、コールバックの定義も必要なしに、以下のようにfilterをあたかも属性のようにしての使用も可能です。短縮されていいですね。

>>> User::all()->filter->isAdult()

=> Illuminate\Database\Eloquent\Collection {#3299
     all: [
       0 => App\User {#4238
         id: 1,
         name: "坂本 充",
         email: "nishida@example.net",
         email_verified_at: "2021-05-30 21:55:14",
         #password: "$2y$10$snEjTmJvBDu3uxd1bz0QDupihJA3zjvEH5J0pm/aLHG4UvpSfJe/q",
         #remember_token: "j8hPjp8ob7",
         birth_date: "1997-03-02",
         created_at: "2021-05-30 21:55:14",
         updated_at: "2021-05-30 21:55:14",
       },
       2 => App\User {#4240
         id: 3,
         name: "近藤 知実",
         email: "atsushi.ito@example.net",
         email_verified_at: "2021-05-30 21:55:14",
         #password: "$2y$10$A7xldQvOiCfUOyNS57EEYu2/s77a70BPmGoOjzDSgTmveeRlcAD8.",
         #remember_token: "qOFWQFb5ER",
         birth_date: "1972-09-14",
         created_at: "2021-05-30 21:55:14",
         updated_at: "2021-05-30 21:55:14",
       },
     ],
   }
>>>

しかし、凄いことに、これをさらに進めて、以下のようにCollectionのカスタムメソッドの作成してUserのCollectionに適用することも可能なのです。

User::all()->adults()

まず、Collectionを継承したクラスを作成して、adults()のカスタムメソッドを定義します。

app/Collections/UserCollection.php

namespace App\Collections;

use Illuminate\Database\Eloquent\Collection;

class UserCollection extends Collection
{
    public function adults()
    {
        return $this->filter->isAdult();
    }
}

そして、そのカスタムクラスをモデルのクラス（User）のnewCollection()のメソッドで返り値とします。

app/User.php

namespace App;

use App\Collections\UserCollection;
use Carbon\Carbon;
use Illuminate\Contracts\Auth\MustVerifyEmail;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;

class User extends Authenticatable
{
    use Notifiable;
...
    public function getAgeAttribute()
    {
        return Carbon::parse($this->birth_date)->age;
    }

    public function isAdult()
    {
        return $this->age >= 20;
    }

    public function newCollection(array $models = [])
    {
        return new UserCollection($models);
    }
}

実行してみましょう。

>>> User::all()->adults();

=> App\Collections\UserCollection {#3305
     all: [
       0 => App\User {#4024
         id: 1,
         name: "坂本 充",
         email: "nishida@example.net",
         email_verified_at: "2021-05-30 21:55:14",
         #password: "$2y$10$snEjTmJvBDu3uxd1bz0QDupihJA3zjvEH5J0pm/aLHG4UvpSfJe/q",
         #remember_token: "j8hPjp8ob7",
         birth_date: "1997-03-02",
         created_at: "2021-05-30 21:55:14",
         updated_at: "2021-05-30 21:55:14",
       },
       2 => App\User {#3986
         id: 3,
         name: "近藤 知実",
         email: "atsushi.ito@example.net",
         email_verified_at: "2021-05-30 21:55:14",
         #password: "$2y$10$A7xldQvOiCfUOyNS57EEYu2/s77a70BPmGoOjzDSgTmveeRlcAD8.",
         #remember_token: "qOFWQFb5ER",
         birth_date: "1972-09-14",
         created_at: "2021-05-30 21:55:14",
         updated_at: "2021-05-30 21:55:14",
       },
     ],
   }

同じ結果となりました。コードが短くなっただけでなくわかりやすくもなりました。

最後に注意としてですが、今回の例はレコード数がとても多いときはパフォーマンスの点からすると非常に悪い例です。すべてのDBレコードを取得してコードにおいて抽出を行うわけですゆえに。パフォーマンスを考えるとDBのSQLレベルにおいて大人の条件を入れて実行すべきです。

Laravel Collection（２） Collectionを返すメソッド

Sun, 06 Jun 2021 04:47:59 +0900

前回は、１つの値を返すCollectionのメソッドを紹介しましたが、今度はCollectionを返すメソッドの紹介です。まさにこれが実践でよく使われるものです。

レコード

まずは、前回と同様に、以下の３レコードのみがusersのDBテーブルに存在するとの仮定です。

mysql> select id, name, birth_date from users;
+----+---------------+------------+
| id | name          | birth_date |
+----+---------------+------------+
|  1 | 坂本 充       | 1997-03-02 |
|  2 | 藤本 和也     | 2005-10-03 |
|  3 | 近藤 知実     | 1972-09-14 |
+----+---------------+------------+
3 rows in set (0.00 sec)

指定した項目値の抽出

pluck()

このメソッドは、引数として与えた項目名の値をCollectionとして返します。

>>> User::all()->pluck('birth_date')

=> Illuminate\Support\Collection {#3302
     all: [
       "1997-03-02",
       "2005-10-03",
       "1972-09-14",
     ],
   }

引数として２つの項目名を与えると、後者をキーとした連想配列のCollectionを返します。

>>> User::all()->pluck('name', 'id')

=> Illuminate\Support\Collection {#4258
     all: [
       1 => "坂本 充",
       2 => "藤本 和也",
       3 => "近藤 知実",
     ],
   }

複数の項目値を抽出するには、

map()

を使用します。

>>> User::all()->map(function ($user) {
        return $user->only(['id', 'name', 'birth_date']);
    })

=> Illuminate\Support\Collection {#4090
     all: [
       [
         "id" => 1,
         "name" => "坂本 充",
         "birth_date" => "1997-03-02",
       ],
       [
         "id" => 2,
         "name" => "藤本 和也",
         "birth_date" => "2005-10-03",
       ],
       [
         "id" => 3,
         "name" => "近藤 知実",
         "birth_date" => "1972-09-14",
       ],
     ],
   }

条件に合うレコードを抽出

filter()

このメソッドは、Collectionから条件に合う必要なレコードだけを抽出します。

>>> User::all()->filter(function ($user) {
        return $user->birth_date < '1990-01-01';
    })

=> Illuminate\Database\Eloquent\Collection {#4025
     all: [
       2 => App\User {#4179
         id: 3,
         name: "近藤 知実",
         email: "atsushi.ito@example.net",
         email_verified_at: "2021-05-30 21:55:14",
         #password: "$2y$10$A7xldQvOiCfUOyNS57EEYu2/s77a70BPmGoOjzDSgTmveeRlcAD8.",
         #remember_token: "qOFWQFb5ER",
         birth_date: "1972-09-14",
         created_at: "2021-05-30 21:55:14",
         updated_at: "2021-05-30 21:55:14",
       },
     ],
   }

条件を少し複雑にすると、

>>> User::all()->filter(function ($user) {
        if ($user->birth_date > '2000-01-01') return false;
        if ($user->birth_date < '1990-01-01') return false;
        return true;
    })

=> Illuminate\Database\Eloquent\Collection {#4249
     all: [
       App\User {#4246
         id: 1,
         name: "坂本 充",
         email: "nishida@example.net",
         email_verified_at: "2021-05-30 21:55:14",
         #password: "$2y$10$snEjTmJvBDu3uxd1bz0QDupihJA3zjvEH5J0pm/aLHG4UvpSfJe/q",
         #remember_token: "j8hPjp8ob7",
         birth_date: "1997-03-02",
         created_at: "2021-05-30 21:55:14",
         updated_at: "2021-05-30 21:55:14",
       },
     ],
   }

というように、1990-01-01と2000-01-01の間に生まれたユーザーだけの取得も可能です。

ちなみに、reject()はfilter()の逆で、上と同じ結果が欲しいなら、以下のようtrue, falseがすべて逆になります。

>>> User::all()->reject(function ($user) {
        if ($user->birth_date > '2000-01-01') return true;
        if ($user->birth_date < '1990-01-01') return true;
        return false;
    })

それぞれのレコード（Userのオブジェクト）で属性処理

each()

このメソッドはまさに、よく使う以下のforeach()の関数のようなもので取得したそれぞれのDBレコードにおいて、属性の処理が可能です。

foreach($rows as $row) {
...
}

例えば、以下のようにUserのオブジェクトにageの属性を追加することができます。

>>> use Carbon\Carbon;

>>> User::all()->each(function ($user) {
        $user->age = Carbon::parse($user->birth_date)->age;
    })

=> Illuminate\Database\Eloquent\Collection {#3986
     all: [
       App\User {#4234
         id: 1,
         name: "坂本 充",
         email: "nishida@example.net",
         email_verified_at: "2021-05-30 21:55:14",
         #password: "$2y$10$snEjTmJvBDu3uxd1bz0QDupihJA3zjvEH5J0pm/aLHG4UvpSfJe/q",
         #remember_token: "j8hPjp8ob7",
         birth_date: "1997-03-02",
         created_at: "2021-05-30 21:55:14",
         updated_at: "2021-05-30 21:55:14",
         age: 24,
       },
       App\User {#4238
         id: 2,
         name: "藤本 和也",
         email: "yoshida.kana@example.com",
         email_verified_at: "2021-05-30 21:55:14",
         #password: "$2y$10$QiozldxVUo3LLj347mqHxeoDh5TEcjddDwc6vN8Pv5b4kPgPUgjri",
         #remember_token: "frW94QFFZh",
         birth_date: "2005-10-03",
         created_at: "2021-05-30 21:55:14",
         updated_at: "2021-05-30 21:55:14",
         age: 15,
       },
       App\User {#4180
         id: 3,
         name: "近藤 知実",
         email: "atsushi.ito@example.net",
         email_verified_at: "2021-05-30 21:55:14",
         #password: "$2y$10$A7xldQvOiCfUOyNS57EEYu2/s77a70BPmGoOjzDSgTmveeRlcAD8.",
         #remember_token: "qOFWQFb5ER",
         birth_date: "1972-09-14",
         created_at: "2021-05-30 21:55:14",
         updated_at: "2021-05-30 21:55:14",
         age: 48,
       },
     ],
   }

Laravel Collection（１）１つの値を返すメソッド

Mon, 31 May 2021 07:54:21 +0900

Laravelをフレームワークとして使う１つの魅力は、Collectionにあります。Eloquentでデータベースから取得した後のレコード処理がとてもエレガントにわかりやく書くことができます。というものの、Laravelのマニュアルに出てくるCollectionの例は配列ベースをcollect()したものばかりで物足りません。ということで、ここでCollectionの紹介を兼ねてDBからの取得にCollectionのメソッドを適用する例を掲載します。

準備

まずは、DBレコード取得ための準備から。

ここでで作成したLaravelのプロジェクトをもとにします。

そこで使用されている、DBテーブルにある項目を追加したいので、まずはmigrationを作成します。

$ php artisan make:migration add_new_fields_to_users_table --table=users

Created Migration: 2021_05_30_213829_add_new_fields_to_users_table

以下のようにusersのDBテーブルにbirth_date、つまり誕生日の項目を追加します。

database/migrations/2021_05_24_022418_add_new_fields_to_users_table.php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

class AddNewFieldsToUsersTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::table('users', function (Blueprint $table) {
            $table->date('birth_date')->nullable()->after('remember_token');
        });
    }

    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        Schema::table('users', function (Blueprint $table) {
            $table->dropColumn('birth_date');
        });
    }
}

そして、migrationを実行してDBに項目を追加します。

$ php artisan migrate

Migrating: 2021_05_30_213829_add_new_fields_to_users_table
Migrated:  2021_05_30_213829_add_new_fields_to_users_table (0.09 seconds)

次に、factoryで自動データ作成のために項目を追加します。

database/factories/UserFactory.php

...
$factory->define(User::class, function (Faker $faker) {
    return [
        'name' => $faker->name(),
        'email' => $faker->unique()->safeEmail(),
        'email_verified_at' => now(),
        'password' => Hash::make('password'),
        'remember_token' => Str::random(10),
        'birth_date' => $faker->date(),
    ];
});

tinkerでdate_birthを追加したusersのレコードを３つ作成します。

>>> User::truncate()

=> Illuminate\Database\Eloquent\Builder {#3302}

>>> factory(\App\User::class, 3)->create()

=> Illuminate\Database\Eloquent\Collection {#4258
     all: [
       App\User {#4254
         name: "坂本 充",
         email: "nishida@example.net",
         email_verified_at: "2021-05-30 21:55:14",
         #password: "$2y$10$snEjTmJvBDu3uxd1bz0QDupihJA3zjvEH5J0pm/aLHG4UvpSfJe/q",
         #remember_token: "j8hPjp8ob7",
         birth_date: "1997-03-02",
         updated_at: "2021-05-30 21:55:14",
         created_at: "2021-05-30 21:55:14",
         id: 1,
       },
       App\User {#4252
         name: "藤本 和也",
         email: "yoshida.kana@example.com",
         email_verified_at: "2021-05-30 21:55:14",
         #password: "$2y$10$QiozldxVUo3LLj347mqHxeoDh5TEcjddDwc6vN8Pv5b4kPgPUgjri",
         #remember_token: "frW94QFFZh",
         birth_date: "2005-10-03",
         updated_at: "2021-05-30 21:55:14",
         created_at: "2021-05-30 21:55:14",
         id: 2,
       },
       App\User {#4251
         name: "近藤 知実",
         email: "atsushi.ito@example.net",
         email_verified_at: "2021-05-30 21:55:14",
         #password: "$2y$10$A7xldQvOiCfUOyNS57EEYu2/s77a70BPmGoOjzDSgTmveeRlcAD8.",
         #remember_token: "qOFWQFb5ER",
         birth_date: "1972-09-14",
         updated_at: "2021-05-30 21:55:14",
         created_at: "2021-05-30 21:55:14",
         id: 3,
       },
     ],
   }

Collectionから１つの値を返すメソッド

DBレコードが揃ったところで、CollectionのメソッドをEloquentで取得したCollectionに適用です。今回は、１つの値だけを返す簡単なメソッドの紹介をします。

まずは、Collectionのレコード数が必要なら以下のようにcount()をチェーンして返すことできます。

>>> User::all()->count()

=> 3

>>> User::where('id', '>', 1)->get()->count()

=> 2

ここDB処理でも同じことできますけれど、それに関しては「Eloquentでカウントするときの注意」で説明しています。

次の例ではmax()、min()はそれぞれ最大値と最小値を返してくれます。この手の集計関数は他にも、avg()、median()、reduce()、sum()もあります。

>>> User::all()->max('birth_date')

=> "2005-10-03"

>>> User::all()->min('birth_date')

=> "1972-09-14"

次の例はブーリアン値を返すメソッドです。

contains()は、含んでいるならブーリアン値のtrueを返します。

>>> User::all()->contains(function($item) {
        return $item->birth_date === '2005-10-03';
    })

=> true

また、EloquentのモデルのUserのプライマリキーを引数として渡すこともできます。これは通常のCollectionには適用不可でEloquentのCollectionのみに使用できるメソッドです。

>>> User::all()->contains(3)

=> true

>>> User::all()->contains(4)

=> false

ブーリアン値を返すものには以下の空判定のメソッドもありますね。

>>> User::all()->isEmpty()

=> false

>>> User::all()->isNotEmpty()

=> true

次の例はオブジェクトを返すメソッドです。

以下のように、最初と最後のレコードのオブジェクトを返すことが可能です。

>>> User::all()->first()

=> App\User {#4254
     id: 1,
     name: "坂本 充",
     email: "nishida@example.net",
     email_verified_at: "2021-05-30 21:55:14",
     #password: "$2y$10$snEjTmJvBDu3uxd1bz0QDupihJA3zjvEH5J0pm/aLHG4UvpSfJe/q",
     #remember_token: "j8hPjp8ob7",
     birth_date: "1997-03-02",
     created_at: "2021-05-30 21:55:14",
     updated_at: "2021-05-30 21:55:14",
   }

>>> User::all()->last()

=> App\User {#4260
     id: 3,
     name: "近藤 知実",
     email: "atsushi.ito@example.net",
     email_verified_at: "2021-05-30 21:55:14",
     #password: "$2y$10$A7xldQvOiCfUOyNS57EEYu2/s77a70BPmGoOjzDSgTmveeRlcAD8.",
     #remember_token: "qOFWQFb5ER",
     birth_date: "1972-09-14",
     created_at: "2021-05-30 21:55:14",
     updated_at: "2021-05-30 21:55:14",
   }

次回は、Collectionを返すメソッドを紹介します。

bulk insertで大量のデータをDBに登録する

Mon, 03 May 2021 01:55:23 +0900

毎日走らせているcronのジョブの１つが、なかなか時間が掛かるのでどうにか改善できないかと悩んでいました。DBへデータを挿入する箇所で時間が掛かっており、コードを確認するとforループで１レコードずつinsert処理を行っていました。bulk insertするように改修したところ、劇的に処理時間が短くなりました。今回はそんな妙薬、bulk insertについてです。

Bulk insertとは？

bulk insertとはDBにレコードを保存する際に、複数のレコードを１クエリでまとめて挿入する方法です。１レコードずつクエリを発行するよりも効率的で高速です。

Laravelでは以下のようにクエリビルダのinsertメソッドを使い実装します。

DB::table('users')->insert([
    ['name' => 'John', 'email' => 'john@example.com', 'password' => 'testtest'],
    ['name' => 'Ben', 'email' => 'ben@example.com', 'password' => 'testtest'],
    ['name' => 'Tyler', 'email' => 'tyler@example.com', 'password' => 'testtest'],
]);

１レコードずつ挿入した場合とbulk insertを使った場合でどれ位処理時間が異なるのでしょうか？seederでusersテーブルに10万件のダミーレコードを登録するケースで比較してみます。

１レコードずつinsertする場合

※Laravelインストール後、DB接続設定やmigration実行完了時点の状態から進めています。

まずはseederを用意します。以下のコマンドでUsersSeederを作成してください。

php artisan make:seeder UsersSeeder

作成されたUsersSeederクラスを以下の様に編集します。

database/seeds/UsersSeeder.php

use App\User;
use Faker\Factory as Faker;
use Illuminate\Database\Seeder;
use Illuminate\Support\Facades\Hash;

class UsersSeeder extends Seeder
{
    /**
     * Run the database seeds.
     *
     * @return void
     */
    public function run()
    {
        $faker = Faker::create('ja_JP');

        for ($i=0; $i < 100000; $i++) { 
            $param = [ 
                'name' => $faker->name(),
                'email' => "test{$i}@example.com",
                'password' => 'testtest',
            ];
            User::create($param);
        }
    }
}

上記のコードではforループ内でcreateメソッドを呼んでおり、10万回ループ毎にDBにレコードが挿入されます。

emailにはループカウンターの$iが使用されています、これはusersテーブルに挿入する際にemailがユニークである必要があるためです。fakerのuniqueメソッドを使えばユニークなemailを生成することが出来ますが、10万件となると重複が発生し失敗してしまいます。

seederを追加したら以下のコマンドでcomposerのオートローダを再生成し、UsersSeederが読み込まれるようにしましょう。

$ composer dump-autoload

DatabaseSeeder.php も編集し、db:seedでUsersSeederを呼び出すようにします。コマンド実行毎にusersテーブルをtruncateメソッドで初期化し、挿入するemailが重複しないようにしています。

database/seeds/DatabaseSeeder.php

use Illuminate\Database\Seeder;
use Illuminate\Support\Facades\DB;

class DatabaseSeeder extends Seeder
{
    /**
     * Seed the application's database. 
     * 
     * @return void 
     */ 
    public function run()
    { 
        DB::table('users')->truncate();
        $this->call(UsersSeeder::class);
    }
}

これで準備が出来ました、db:seedコマンドを実行してみましょう。

$ php artisan db:seed
Seeding: UsersSeeder
Seeded: UsersSeeder (157.48 seconds)
Database seeding completed successfully.

上記はM1 MacBookAirでの実行で、約２分半掛かりました。また、Windows + VirtualBoxの仮想環境では約２０分掛かっていました。記事の内容とは関係無いですが、Appleシリコン速いですね！

bulk insertの場合

次に、UsersSeederを編集してbulk insertにしてみましょう。bulk insertにするには一度、挿入するデータを連想配列で用意し、insertメソッドに渡します。

database/seeds/UsersSeeder.php

...
public function run()
{ 
    $faker = Faker::create('ja_JP');

    $params = [];

    for ($i=0; $i < 100000; $i++) { 
        $params[] = [ 
            'name' => $faker->name(),
            'email' => "test{$i}@example.com",
            'password' => 'testtest',
        ];
    } 

    User::insert($params);
}

db:seedを実行してみましょう。

$ php artisan db:seed 
Seeding: UsersSeeder
PHP Fatal error: Allowed memory size of 134217728 bytes exhausted (tried to allocate 4194312 bytes) in ...

流石に10万件のデータを一つの変数に格納するとメモリの使用上限に達し、エラーが発生してしまいました。（memory_limitは初期設定の128MBです）

ini_set()でmemory_limitを上げても良いですが、一体どれだけメモリを食うのか分かりません。1000件毎にinsertメソッドを実行、$paramsを初期化し、メモリ使用量を抑える事にしました。以下が修正を加えたコードです。

database/seeds/UsersSeeder.php

...
public function run()
{ 
    $faker = Faker::create('ja_JP');

    $params = [];

    for ($i=0; $i < 100000; $i++) { 
        $params[] = [ 
            'name' => $faker->name(),
            'email' => "test{$i}@example.com",
            'password' => 'testtest',
        ];

        if (count($params) >= 1000) {
            User::insert($params);
            $params = [];
        }
    } 
}

蛇足ですが、こちらの記事、High-speed inserts with MySQLにて

It takes around 1,000 inserts per query to reach the maximum throughput

と言及されているように、bulk insertの場合は１クエリ辺り1000件のインサートが最も効率が良いらしいです。

再度、db:seedを実行してみましょう。

$ php artisan db:seed
Seeding: UsersSeeder
Seeded:  UsersSeeder (5.8 seconds)
Database seeding completed successfully.

約２分半掛かっていたのが、約６秒です。約２０分掛かっていた Windows + VirtualBox の環境でも約６秒でした。すごい差です！

created_at, updated_atは自動入力されない

一点注意が必要なのは、bulk insertではModelクラスにて$timestampsをtrueに設定していても、created_atやupdated_atは自動入力されません。なぜならinsertメソッドはEloquent側ではなく、クエリビルダ側のメソッドだからです。したがって、insertするパラメタに明示的に含める必要があります。

まとめ

大量のレコードを挿入する場合、１レコードずつではなく、bulk insertで一括挿入することでとても速く処理できます。これは逆にDBへのクエリ発行がプログラムにおいて如何に重い処理か、という事を示しています。普段コードを書く際にも無駄なクエリを発行していないか気をつけねば、と思った次第です。

Laravelでログファイルの作成（３）コマンドログファイル自動ネーミング

Mon, 26 Apr 2021 00:00:32 +0900

Artisanコマンドはコマンドラインで手動で実行するだけでなく、クロンジョブでの実行でも使用します。時間を設定して自動的に実行されるゆえに、実際に実行されたのか、どれだけ時間かかったのか、いくつのレコードを処理したのかなどをログに記録しておきたいです。そして、わかりやすいようにコマンドごとに違うログファイルを作成したいです。となると、config/logging.phpでそれぞれのコマンドのチャンネルを作成することになるのでしょうか？　つまり５０個コマンドあれば５０個のチャンネルの作成です。それは面倒だな、ということで良いアイデアを思いつきました。

要は、コマンドごとにログファイル名を変えれば良いことなので、前回の月次ごとのログの作成をベースとして変更します。

まず、config/logging.phpに新しいチャンネルcliを追加します。

config/logging.php

...
   'channels' => [
...
        'monthly' => [
            'driver' => 'daily', // use RotatingHandler
            'tap' => [App\Logging\MonthlyFileNameForRotatingHandler::class],
            'path' => storage_path('logs/laravel.log'),
            'level' => 'info',
            'permission' => 0666,
            'days' => 12, // １２ヶ月でローテーション
        ],

        'cli' => [
            'driver' => 'daily', // use RotatingHandler
            'tap' => [App\Logging\CommandFileNameForRotatingHandler::class],
            'path' => storage_path('logs/cli.log'),
            'level' => 'info',
            'permission' => 0666,
            'days' => 12, // １２ヶ月でローテーション
        ],
...

前回のmonthlyのチャンネルの設定と比較すると、変わっているのはtapで指定したクラス名とpathのログファイル名だけです。

そして、以下の新規のクラスの定義は、これまた前回のMonthlyFileNameForRotatingHandlerクラスとほとんど変わりません。

app/Logging/CommandFileNameForRotatingHandler.php

namespace App\Logging;

class CommandFileNameForRotatingHandler
{
    /**
     * Customize the given logger instance.
     *
     * @param  \Illuminate\Log\Logger  $logger
     * @return void
     */
    public function __invoke($logger)
    {
        foreach ($logger->getHandlers() as $handler) {
       	    $name = $_SERVER['argv'][1]; //実行されるArtisanのコマンド名を取得して、以下でそれを使用
            $handler->setFilenameFormat("{filename}-$name-{date}", 'Y-m');
        }
    }
}

変更した部分は、ファイル名の作成の部分だけです。そして、この設定により以下のようなコマンドラインを実行するなら、

$ php artisan command:log

作成されるログファイル名は、cli-command:log-2021-04.logのようになります。

違うコマンドを実行するなら、

$ php artisan task:something

ログファイル名は、cli-task:something-2021-04.logとなります。

もちろんArtisanのコマンドでは以下の例のように、Logの関数のコールが必要です。

app/Console/Commands/LogCommand.php

namespace App\Console\Commands;

use Illuminate\Console\Command;
use Illuminate\Support\Facades\Log;

class LogCommand extends Command
{
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'command:log {action} {--option=}';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Command description';

    /**
     * Create a new command instance.
     *
     * @return void
     */
    public function __construct()
    {
        parent::__construct();
    }

    /**
     * Execute the console command.
     *
     * @return int
     */
    public function handle()
    {
        Log::channel('cli')->info('start', $_SERVER['argv']); // ここでcliのチャンネルを使用してコール

        return 0;
    }
}

上のコマンドを実行すると、cli-command:log-2021-04.logの中身は、以下のようになります。 info()の２番目の引数には配列を渡すことが可能です。ここではコマンドラインの引数を記録します。

$ php artisan command:log run --option=x
$ cat storage/logs/cli-command:log-2021-04.log
[2021-04-24 23:45:46] local.INFO: start ["artisan","command:log","run","--option=x"]

→ ログに関しての他の記事

LaravelでLogファイルの作成（２）ログファイルをローテーション

Mon, 19 Apr 2021 00:00:25 +0900

デフォルトのインストールでは、laravel.logは日次ではローテーションされません。つまり一生同じファイルにエラーなどが記録され続けます。それが嫌ならどうしましょう？

日次でローテーション

これは次のファイルの変更で簡単に設定可能です。

config/logging.php

...
   'channels' => [
        'stack' => [
            'driver' => 'stack',
            'channels' => ['daily'], // これをsingleからdailyに変換
            'ignore_exceptions' => false,
        ],

        'single' => [
            'driver' => 'single',
            'path' => storage_path('logs/laravel.log'),
            'level' => 'debug',
        ],

        'daily' => [
            'driver' => 'daily',
            'path' => storage_path('logs/laravel.log'),
            'level' => 'debug',
            'days' => 14, // 14日でローテーション
        ],
...

こうすると、作成されるファイルは、laravel.logから、laravel-YYYY-MM-DD.logの形式に変わります。

$ ls -l 
-rw-r--r-- 1 kenji kenji    51 Apr  9 14:51 laravel-2021-04-09.log
-rw-r--r-- 1 kenji kenji 18525 Apr  3 13:14 laravel.log

そして14日経過したら、それ以前に作成されたログファイルは削除されます。つまりファイルのローテーションが実行されます。

月次でローテーション

さて、日次のローテーションではあまりにも頻繁過ぎると思うなら、今度は月次に変更してみましょう。

これはちょっと準備が要ります。デフォルトやマニュアルには直接の例がないのでちょっと調査必要でしたが可能です。

まず、以下のファイルを作成します。

app/Logging/MonthlyFileNameForRotatingHandler.php

namespace App\Logging;

class MonthlyFileNameForRotatingHandler
{
    /**
     * Customize the given logger instance.
     *
     * @param  \Illuminate\Log\Logger  $logger
     * @return void
     */
    public function __invoke($logger)
    {
        foreach ($logger->getHandlers() as $handler) {
            $handler->setFilenameFormat('{filename}-{date}', 'Y-m');
        }
    }
}

それから、以下のように新規のチャンネルmonthlyの作成が必要です。

config/logging.php

...
   'channels' => [
        'stack' => [
            'driver' => 'stack',
            'channels' => ['monthly'], // これをmonthlyに変換
            'ignore_exceptions' => false,
        ],
...
        'monthly' => [
            'driver' => 'daily', // use RotatingHandler
            'tap' => [App\Logging\MonthlyFileNameForRotatingHandler::class],
            'path' => storage_path('logs/laravel.log'),
            'level' => 'info',
            'permission' => 0666,
            'days' => 12, // １２ヶ月でローテーション
        ],
...

この設定をすると、今度はファイル名はlaravel-YYYY-MM.logの形式に変わります。以下のように。

$ ls -l
-rw-r--r-- 1 kenji kenji 143 Apr  9 14:55 laravel-2021-04-09.log
-rw-rw-rw- 1 kenji kenji  45 Apr  9 15:12 laravel-2021-04.log

月次なのに‘days’ => 12とちょっと設定が変ですが、ローテーションの仕組みはそこで指定した数のファイルをキープして他のファイルは削除するというものなので、この場合は12日ではなく12ヶ月となります。ちなみに、どのファイルが削除されるかはファイルの日付ではなくファイル名順で決まるのでローテーションのテストをするならダミーのファイルを作成してテスト可能です。

最後に、ファイルのローテーションが要らないなら、そこには0と指定してください。永遠に作成された月次のファイルが残り続けます。

→ ログに関しての他の記事

そうだ、Laravel Excelを使ってみよう（４）保存先の指定

Mon, 12 Apr 2021 00:00:55 +0900

そうだ、そうだ、Laravel Excelを使ってみよう（３）日付のフォーマットの続きです。

ファイルの保存先を指定する

デフォルトの保存先

前回までエクスポートしたファイルは storage/app 配下に出力されました。この出力先はconfig/filesystems.phpのdefaultに指定されたdiskに基づいています。初期設定ではdefaultにlocalが指定されており、localの設定を確認するとrootにstorage/appが指定されていますね。

...
'default' => env('FILESYSTEM_DRIVER', 'local'),
...
'disks' => [
    'local' => [
        'driver' => 'local',
        'root' => storage_path('app'),
    ],
...

デフォルトの保存先がどこの設定を参照しているのか確認できたところで本題、エクスポートの保存先を変更してみます。

相対パスで指定する

もし、storage/app/public 配下にエクスポートしたい場合は以下のように、storeメソッドの第２引数に相対パスを指定することで変更できます。

Psy Shell v0.10.6 (PHP 7.2.34 — cli) by Justin Hileman
>>> use App\Exports\PurchaseHistoryExport;
>>> Excel::store(new PurchaseHistoryExport, 'public/purchase_history.xlsx');
=> true

storage/app 以外のディレクトリ、例えば storage/exports などに出力したい場合はどうでしょうか？試しに相対パスで指定してみます。

>>> Excel::store(new PurchaseHistoryExport, '../exports/purchase_history.xlsx');
LogicException with message 'Path is outside of the defined root, path: [../exports/purchase_history.xlsx]'

エラーが出力されてしまいました。

冒頭で触れた通り、config/filesystems.php のdefaultに指定されたdisk（初期設定ではlocal）に基づいています。よって、そのrootである storage/app 外のパスは指定できないみたいです。

では、どうするか？

Diskで指定する

diskの設定を追加しstoreメソッドに渡すことで、出力先のディレクトリを自由に変更できます。公式ドキュメントだとStoring exports on disk のCustom disks欄に説明が記載されてます。

まず、config/filesystems.php のdisksに設定を追加します。

config/filesystems.php

'disks' => [
    ...
    'exports' => [
        'driver' => 'local',
        'root' => storage_path('exports'), // ←出力先のディレクトリパスを指定
    ],
],

そして、storeメソッドの第三引数に追加した設定のkeyを指定します。configに追加した設定を読み込ませるために、tinkerの再起動が必要ですのでご注意を！

Psy Shell v0.10.6 (PHP 7.2.34 — cli) by Justin Hileman
>>> use App\Exports\PurchaseHistoryExport;
>>> Excel::store(new PurchaseHistoryExport, 'purchase_history.xlsx', 'exports');
=> true

storage/exports/purchase_history.xlsx にエクスポートされたはずです。

まとめ

色々な分野でデータ活用が見直されている昨今、出力するデータも多岐に渡ると思います。とはいえ、出力先毎にdisk設定を追加していくとconfig/filesystems.phpが肥大化してしまい、管理しずらくなります。よって、disk設定と相対パス指定の両方をバランスよく組み合わせて運用していくのが良さそうです。

余談

当初、出力先を変更する方法について理解が進まず、ドキュメントとにらめっこしたり、ソースを追ってみたりしてました。最終的にGitHub上の過去のIssueから相対パスで指定できることを知り、diskの設定追加が必要なケースについても把握できました。このパッケージはGitHub上でのやり取りが盛んに行われているので行き詰まった時は是非そちらを参照してみて下さい。

GitHub: https://github.com/maatwebsite/Laravel-Excel

LaravelでLogファイルの作成（１）laravel.logでないファイルに記録

Mon, 05 Apr 2021 00:00:17 +0900

ログファイルを作成するのは、デバッグのためや後のチェックに使われるために実行の記録を残すなど、いろいろな目的で使われます。Laravelでは、laravel.logというファイルがデフォルトでstorage/logsに作成されて、そこでいろいろな情報を記録するのに使われます。しかし、特定のプログラムの実行でlaravel.logではないファイルにログを残したいときはどうしましょう？

Laravelではこれはいたって簡単。

まず、config/logging.phpのファイルをエディターで開いて、以下のようにcustomのチャンネルを追加します。

config/logging.php

...
    'channels' => [
        'stack' => [
            'driver' => 'stack',
            'channels' => ['single'],
            'ignore_exceptions' => false,
        ],

        'single' => [
            'driver' => 'single',
            'path' => storage_path('logs/laravel.log'),
            'level' => 'debug',
        ],
...
       'custom' => [
            'driver' => 'single',
            'path' => storage_path('logs/custom.log'),
            'level' => 'info',
            'permission' => 0666,
        ],
    ],
];

そして、tinkerでログを書き込みます。

>>> Log::channel('custom')->info('テストだよ');
=> null

以下のように、custom.logのファイルが作成されています。上の設定ではパーミッションがlaravel.logと異なることに注意してください。デフォルトではpermissionは0644ですが上の設定では0666として誰もが読み書き自由となっています。

$ ls -l storage/logs
-rw-rw-rw- 1 kenji kenji    52 Apr  3 14:17 custom.log
-rw-r--r-- 1 kenji kenji 18525 Apr  3 13:14 laravel.log

そしてファイルの中身は、

$ cat storage/logs/custom.log
[2021-04-03 21:17:05] local.INFO: テストだよ

ちゃんと書き込まれていますね。

もう１つテストです。今度は、info()でなくdebug()の関数を使います。

>>> Log::channel('custom')->debug('デバッグだよ')
=> null

ファイルの中身をチェックすると、

$ cat storage/logs/custom.log
[2021-04-03 21:17:05] local.INFO: テストだよ

書き込みがありません。これは、設定でlevelをinfoと設定したためです。infoの下のレベルであるdebugでは書き込みが起こらないのです。

ちなみに以下がレベルのランクです。

Log::emergency($message);
Log::alert($message);
Log::critical($message);
Log::error($message);
Log::warning($message);
Log::notice($message);
Log::info($message);
Log::debug($message);

→ ログに関しての他の記事

そうだ、Laravel Excelを使ってみよう（３）日付のフォーマット

Thu, 01 Apr 2021 05:14:43 +0900

そうだ、そうだ、Laravel Excelを使ってみよう（２）ヘッダ, map()の続きです。

日付のフォーマット

注文の多いマーケッターさんなら、日付の表示を「YYYY/MM/DD」に変更して欲しい、と言うかもしれません。やってみましょう。

前回エクスポートしたファイルを見てみると作成日欄は「標準」となっており「日付」ではありません。

カラムの形式を「日付」に変えた上で「YYYY/MM/DD」で表示させます。

カラムの形式を指定するにはWithColumnFormattingをimplementし、columnFormatsメソッドを追加します。

app/Exports/PurchaseHistoryExport.php

...
use Maatwebsite\Excel\Concerns\WithColumnFormatting;
use PhpOffice\PhpSpreadsheet\Style\NumberFormat;

class PurchaseHistoryExport implements FromCollection, WithHeadings, WithStrictNullComparison, WithMapping, WithColumnFormatting
{
    ...
    /**
     * @return array
     */
    public function columnFormats() :array
    {
        return [
            'B' => NumberFormat::FORMAT_DATE_YYYYMMDDSLASH,
        ];
    }
    ...

NumberFormatクラスに指定可能なフォーマットが定数で定義されているので適当なものを選びます。日付に関しては以下のフォーマットが定義されていました。今回は’YYYY/MM/DD’としたいので、FORMAT_DATE_YYYYMMDDSLASHを選択しました。

vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Style/NumberFormat.php

const FORMAT_DATE_YYYYMMDD2 = 'yyyy-mm-dd';
const FORMAT_DATE_YYYYMMDD = 'yyyy-mm-dd';
const FORMAT_DATE_DDMMYYYY = 'dd/mm/yyyy';
const FORMAT_DATE_DMYSLASH = 'd/m/yy';
const FORMAT_DATE_DMYMINUS = 'd-m-yy';
const FORMAT_DATE_DMMINUS = 'd-m';
const FORMAT_DATE_MYMINUS = 'm-yy';
const FORMAT_DATE_XLSX14 = 'mm-dd-yy';
const FORMAT_DATE_XLSX15 = 'd-mmm-yy';
const FORMAT_DATE_XLSX16 = 'd-mmm';
const FORMAT_DATE_XLSX17 = 'mmm-yy';
const FORMAT_DATE_XLSX22 = 'm/d/yy h:mm';
const FORMAT_DATE_DATETIME = 'd/m/yy h:mm';
const FORMAT_DATE_TIME1 = 'h:mm AM/PM';
const FORMAT_DATE_TIME2 = 'h:mm:ss AM/PM';
const FORMAT_DATE_TIME3 = 'h:mm';
const FORMAT_DATE_TIME4 = 'h:mm:ss';
const FORMAT_DATE_TIME5 = 'mm:ss';
const FORMAT_DATE_TIME6 = 'h:mm:ss';
const FORMAT_DATE_TIME7 = 'i:s.S';
const FORMAT_DATE_TIME8 = 'h:mm:ss;@';
const FORMAT_DATE_YYYYMMDDSLASH = 'yyyy/mm/dd;@';

一旦、tinkerからエクスポートしてみます。

Psy Shell v0.10.6 (PHP 7.2.34 — cli) by Justin Hileman
>>> use App\Exports\PurchaseHistoryExport;
>>> Excel::store(new PurchaseHistoryExport, 'purchase_history.xlsx');
=> true

するとカラムの表示形式が「標準」から「日付」変わりました。

しかし、セルの表示形式は「2021-03-15 09:42:24」のままです。どうすれば良いでしょうか？

シリアル値に変換

公式ドキュメントを確認すると、日付に関してPhpSpreadsheetパッケージのDate::dateTimeToExcel()を利用するように推奨されています。このメソッドはPHPのDateTimeオブジェクトをExcelのシリアル値に変換するメソッドです。なるほど、日付を正しくフォーマットするためには一度シリアル値に変換してエクスポートする必要があるようです。

シリアル値はExcel上で日時を管理するデータ形式です。１９００年１月１日を１とみなし、そこから何日目か？によって日付を管理しています（つまり、Excel版のtimestampですね）。例えば、Excelでセルに数字の２を入力して表示形式を「標準」から「日付」に変更してみて下さい。すると、「1900/1/2」と表示されるはずです。１９００年１月１日から２日目だからです。尚、時刻に関しては小数点以下で表現しています。

話を元に戻して、mapメソッドを以下の様に修正しました。

PhpOffice\PhpSpreadsheetパッケージからDateクラスをuseしています。このパッケージはLaravel Excelをインストールした際に一緒に入っています。（余談ですが、そもそもLaravel Excel自体がこのパッケージをLaravel用に使いやすくしたラッパーパッケージなのだそうです。）

app/Exports/PurchaseHistoryExport.php

...
use PhpOffice\PhpSpreadsheet\Shared\Date;
...
/**
 * @param PurchaseHistory $row
 * @return array
 */
public function map($row) :array
{
    return [
        $row->id,
        Date::dateTimeToExcel($row->created_at), // <-修正箇所
        $row->user_id,
        $row->product_name,
        $row->price * $row->quantity, // 合計金額
    ];
}
...

再度tinkerからエクスポートして確認すると、「作成日」欄が「YYYY/MM/DD」の形式になりました。表示上は年月日のみですが、内部的にシリアル値で管理されているのでセルを選択すると時刻まで確認できます。良さそうですね！

そうだ、Laravel Excelを使ってみよう（２）ヘッダ, map()

Mon, 29 Mar 2021 00:00:48 +0900

前回の記事、そうだ、そうだ、Laravel Excelを使ってみよう（１）セットアップの続きです。

ヘッダ行を追加

前回出力したファイル storage/app/purchase_history.xlsx を見るとデータのみが出力されていて、各列が何を示すのか分かりません。ヘッダ行を追加して分かりやすくします。WithHeadingsインタフェースを追加し、以下のメソッドをExportクラスに追加します。WithHeadingsインタフェースの制約により、戻り値の型をarrayに指定する必要があるのでご注意を。

app/Exports/PurchaseHistoryExport.php

...
use Maatwebsite\Excel\Concerns\WithHeadings;

class PurchaseHistoryExport implements FromCollection, WithHeadings
{
    /**
     * @return array
     */
    public function headings() :array
    {
        return [
            'ID', '作成日', '更新日', 'user_id', '商品名', '単価', '数量'
        ];
    }
 ...

再度tinkerから出力するとヘッダ行が追加されました。

こちら出力して気づいたのですが、「数量」列に空欄になっているセルがありますね。なんでしょう？tinkerで該当のレコードを確認してみます。

Psy Shell v0.10.6 (PHP 7.2.34 — cli) by Justin Hileman
>>> App\PurchaseHistory::find(7);
=> App\PurchaseHistory {#4090
     id: 7,
     created_at: "2021-03-15 09:45:05",
     updated_at: "2021-03-15 09:45:05",
     user_id: 42426926,
     product_name: "provident",
     price: 5352,
     quantity: 0,
   }

なるほど、quantity: 0になっている箇所が空欄になっているのですね。Laravel Excelではデフォルトでは0をエクスポートするとnull扱いされ空のセルとなります。0を0として出力したい場合はWithStrictNullComparisonインタフェースをimplementする必要があります。

app/Exports/PurchaseHistoryExport.php

...
use Maatwebsite\Excel\Concerns\WithStrictNullComparison;

class PurchaseHistoryExport implements FromCollection, WithHeadings, WithStrictNullComparison
{
...

再度エクスポートすると空欄だったセルに０が挿入されています

ここまででお気づきかもしれませんが、Laravel Excelの実装は基本的にインタフェース（公式ドキュメントではConcernと呼ばれている）を追加していきます。必要なものを必要な時にだけ、最小限の拡張で実装できるのでコードをシンプルに保つことができそうです。

行ごとの処理を追加

前項まではDBから取得したデータをそのまま出力していましたが、「更新日・単価・数量」は不要、代わりに「合計金額」を出力して欲しい、と依頼されたとします。行ごとの処理を追加して出力内容を修正してみましょう。（この程度であれば、collectionメソッド側でDBから取得する際のクエリを修正した方が効率的ですが、例の為に敢えて行ごとの処理として実装します。）

エクスポートする項目が変わるのでヘッダ行の設定を先に修正します。

app/Exports/PurchaseHistoryExport.php

public function headings() :array
{
    return [
        'ID', '作成日', 'user_id', '商品名', '合計金額',
    ];
}

次に、行ごとの処理を追加します。行ごとの処理はWithMappingインタフェースをimplementし、mapメソッドを追加して実装です。合計金額は単価 x 数量としました。

app/Exports/PurchaseHistoryExport.php

...
use Maatwebsite\Excel\Concerns\WithMapping;

class PurchaseHistoryExport implements FromCollection, WithHeadings, WithStrictNullComparison, WithMapping
{
...

    /**
     * @param PurchaseHistory $row
     * @return array
     */
    public function map($row) :array
    {
        return [
            $row->id,
            $row->created_at,
            $row->user_id,
            $row->product_name,
            $row->price * $row->quantity, // 合計金額
        ];
    }
...

エクスポートは以下になりました。

更に続きます。

そうだ、Laravel Excelを使ってみよう（１）セットアップ

Thu, 25 Mar 2021 03:08:05 +0900

集計データをcsvにエクスポートする処理をLaravel Excelを使って置き換える機会があったので備忘録としてまとめてみます。Laravel Excelとはcsvやxlsxファイルなどへのデータのエクスポート、インポートがお手軽に実現できるパッケージです。

公式ページに色々利点が列挙されていますが、今回の導入で期待しているのは以下の３点です。

1 データをxlsxファイルにエクスポート 2 chunk処理によるエクスポート処理のパフォーマンスアップ 3 整理整頓されたクラスセットによりコードの見通しがよくなる

まずはインストールから。

環境

macOS Big Sur バージョン 11.1
PHP 7.4.15
Laravel Framework 7.30.4

新規プロジェクトが作成されている状態

installation

公式ドキュメントに沿ってパッケージをインストールします。

予めRequirementsを確認し、PHPのextensionなど入っていないものが有れば必要に応じて入れて下さい。私の環境ではgdのみ入っていなかったので以下の手順で入れました。(phpbrewを使っています)

brew install gd
phpbrew ext install gd

それではLaravel Excelをインストールします。

composer require maatwebsite/excel

2021/02/24時点では3.1.27が入りました。

購入履歴をエクスポートしてみる

どのECサイトでも顧客動向を把握するために、商品の購入履歴を分析すると思います。マーケの人からそれに必要なデータをExcelで開ける形式で下さい、と依頼されたとしましょう。そんな時、従来であればBOMや文字コードを気にかけつつ、fputcsvなどでcsvファイルに出力していました。Laravel Excelを使えば直接xlsxファイルで出力できるので、それらの煩わしさから解放されそうです。

例えば以下のようなテーブルからデータをエクスポートするとします。

ダミーデータの準備

まずはモデルを作成、migartionファイルと後ほどダミーデータを生成するのでfactoryもオプションで指定して作成しておきます。

php artisan make:model -fm PurchaseHistory

migrationファイルは以下のようにしました。

public function up()
{
    Schema::create('purchase_histories', function (Blueprint $table) {
        $table->id();
        $table->timestamps();
        $table->integer('user_id')->default(0);
        $table->string('product_name')->default('');
        $table->integer('price')->default(0);
        $table->smallInteger('quantity')->default(0);
    });
}

migrateします。

php artisan migrate

続いてfactory側も準備します。

$factory->define(PurchaseHistory::class, function (Faker $faker) {
    return [
        'user_id' => $faker->randomNumber(),
        'product_name' => $faker->word(),
        'price' => $faker->randomNumber(4),
        'quantity' => $faker->randomNumber(1),
    ];
});

tinkerから100レコードほどダミーデータを生成しておきます

factory('App\PurchaseHistory', 100)->create();
PurchaseHistory::count();
>> 100

これでダミーデータの準備完了です。

Exportクラスを作成

以下のコマンドでExportファイルを生成して下さい。

php artisan make:export PurchaseHistoryExport

app\Exports\PurchaseHistoryExport.php が生成されるはずです。このクラスでヘッダや、ソースからのデータ取得、出力データの整形などを指定していきます。デフォルトでcollectionメソッドが定義されていますので以下のように編集します。

namespace App\Exports;

use App\PurchaseHistory;
use Maatwebsite\Excel\Concerns\FromCollection;

class PurchaseHistoryExport implements FromCollection
{
    /**
    * @return \Illuminate\Support\Collection
    */
    public function collection()
    {
    	return PurchaseHistory::all();
    }
}

これでpurchase_historyテーブルから抽出したデータを全てエクスポートすることになります。試しにtinkerからエクスポートしてみます。

use App\Exports\PurchaseHistoryExport;
Excel::store(new PurchaseHistoryExport, 'purchase_history.xlsx');

第一引数に先程編集したExportクラス、第2引数に出力するファイル名を指定しています。trueが返されればエクスポート完了です。出力先はデフォルトでstorage/app/purchase_history.xlsxになります

お手軽ですね！因みにファイル名の拡張子を’xlsx’から’csv’にするとcsv形式でも出力してくれます。その他、対応している拡張子が公式ドキュメントの方に載っていますのでチェックしてみて下さい。

長くなってしまったので、続きは次の記事にします。

Laravel 7.x更新で発見したこと（3）ルートのキャッシュ

Sun, 21 Mar 2021 04:16:59 +0900

Laravelはプログラム実行において読み込むファイルの数は非常に多いです。実行速度を最適化するにはいろいろな方法がありますが、一番簡単に実行できる方法があります。遠い昔にも紹介しましたが、ルートのキャッシュです。しかし、バージョン７への更新によりちょっと問題が発生です。

ルートのキャッシュ

お客さんのプロジェクトでは、routes/web.phpやapi.phpで定義されているルート（routeのことです）は結構あります。現在445あります。毎回毎回これを読み込みLaravelが処理するにはシステムに負荷がかかります。Laravelでは以前から、それを最適化してキャッシュするコマンドがあります。

まず、L7.xでプロジェクトを作成して、その時点で動作確認したところで、ルートをキャッシュしまするのですが、

その前にちょっとした作業が必要です。なぜなら、そのキャッシュのコマンドはクロージャのルートでエラーとなってしまうからです。それはL6.xでも同じことです。

ということで、以下の２つのファイルにおいてコメントアウトが必要です。

routes/api.php

...
// 以下コメントアウト
// Route::middleware('auth:api')->get('/user', function (Request $request) {
//    return $request->user();
// });

routes/web.php

...
// 以下コメントアウト
// Route::get('/', function () {
//    return view('welcome');
//});

Auth::routes();

Route::get('/home', 'HomeController@index')->name('home');

これでルートのキャッシュ化のコマンドを実行です。

$ php artisan route:cache
Route cache cleared!
Routes cached successfully!

成功しましたね。そしてディレクトリには以下のように、

bootstrap/cache
├── packages.php
├── routes-v7.php
└── services.php

キャッシュされたroutes-v7.phpのファイルが作成されています。L6.xではファイル名は、routes.phpでした。

重複のルート名はL6.xではOKだったのに

L7.xになってこのコマンドの実行において前バージョンから１つ変わったことあります。L6.xにおいては、ルート名の重複が許されていたのですが、L7.xではそれが許されません。比較してみましょう。

まず、L6.xの環境で、以下のようなルートの設定をします。

routes/web.php

// Route::get('/', function () {
//     return view('welcome');
// });

// Auth::routes(); // 左の関数から以下を抽出
Route::get('login', 'Auth\LoginController@showLoginForm')->name('login');
Route::post('login', 'Auth\LoginController@login')->name('login');

// Route::get('/home', 'HomeController@index')->name('home');

Auth::routes()で設定されているルートから、loginのルート定義を取り出して、意図的にgetとpostに同じloginという名前となるように設定します。->name(’login’)の部分です。

$ php artisan route:list

を実行すると、

+--------+----------+-------+-------+---------------------------------------------------------+------------+
| Domain | Method   | URI   | Name  | Action                                                  | Middleware |
+--------+----------+-------+-------+---------------------------------------------------------+------------+
|        | GET|HEAD | login | login | App\Http\Controllers\Auth\LoginController@showLoginForm | web,guest  |
|        | POST     | login | login | App\Http\Controllers\Auth\LoginController@login         | web,guest  |
+--------+----------+-------+-------+---------------------------------------------------------+------------+

そして、キャッシュのコマンドの実行もOKです。

$ php artisan route:cache
Route cache cleared!
Routes cached successfully!

重複のルート名でも、GETとPOSTと使用されるメソッドが違うので使用には問題がありませんでした。

以上は、L6.xでの話ですが、L7.xでは。。。

L7.xでの問題

L7.xにおいて、先と同じようにルートをweb.phpで設定して、

$ php artisan route:list

を実行すると、

+--------+----------+-------+-------+---------------------------------------------------------+------------+
| Domain | Method   | URI   | Name  | Action                                                  | Middleware |
+--------+----------+-------+-------+---------------------------------------------------------+------------+
|        | GET|HEAD | login | login | App\Http\Controllers\Auth\LoginController@showLoginForm | web        |
|        |          |       |       |                                                         | guest      |
|        | POST     | login | login | App\Http\Controllers\Auth\LoginController@login         | web        |
|        |          |       |       |                                                         | guest      |
+--------+----------+-------+-------+---------------------------------------------------------+------------+

OKそうですね。そして、キャッシュのコマンドを実行すると、

Route cache cleared!

   LogicException 

  Unable to prepare route [login] for serialization. Another route has already been assigned name [login].
...

と、「もうloginの名前は使われているよ」というエラーが表示されます。

そうなら、重複とならないようにルートの名前を変えてみます。

...
Route::get('login', 'Auth\LoginController@showLoginForm')->name('login');
Route::post('login', 'Auth\LoginController@login')->name('login-post');
...

今度はキャッシュのコマンドの実行はOKとなりました。

$ php artisan route:cache
Route cache cleared!
Routes cached successfully!

そして、今度はpostのルートの名前を外してみます。オリジナルの定義と同じです。

...
Route::get('login', 'Auth\LoginController@showLoginForm')->name('login');
Route::post('login', 'Auth\LoginController@login');
...

これでも、キャッシュのコマンドの実行は成功となります。

どうなっているのか？と以下を実行してみると、

$ php aritsan route:list
+--------+----------+-------+-----------------------------+---------------------------------------------------------+------------+
| Domain | Method   | URI   | Name                        | Action                                                  | Middleware |
+--------+----------+-------+-----------------------------+---------------------------------------------------------+------------+
|        | GET|HEAD | login | login                       | App\Http\Controllers\Auth\LoginController@showLoginForm | web        |
|        |          |       |                             |                                                         | guest      |
|        | POST     | login | generated::Jhj05XtQrWTdgVlP | App\Http\Controllers\Auth\LoginController@login         | web        |
|        |          |       |                             |                                                         | guest      |
+--------+----------+-------+-----------------------------+---------------------------------------------------------+------------+

名が無かったルートには、 generated::Jhj05XtQrWTdgVlPと自動で名前が付けられていました。便利ですね。

最後に

ルート名がそのキャッシュ化において重複を許さなくなったL7.xの更新は、既存のコードをブレイクするという報告がいくつか出ていました。もちろんこれにより私のプロジェクトでも変更がいくつか必要となりました。ここの部分更新時には注意要です。

それから、ルートのキャッシュでもうひとつ注意することは、ルートの定義ファイルを変更したら必ず、キャッシュコマンドを再実行する必要があります。

ときどきこれを忘れてどうして変更が反映していないのか考え込んでしまう経験が過去にありました。それゆえに私の開発環境ではキャッシュせずに、本環境のみにおいてキャッシュ化を実行するようにしています。

Laravel 7.x更新で発見したこと（２）URLの余分なスラッシュ

Sun, 14 Mar 2021 02:46:25 +0900

これも前回と同様に、開発したプログラムに今まであったバグがLaravelの更新により表面化したという話です。

余分なスラッシュ

例えば、このブログで以下のようなURLあります。

/2021/02/16/laravel-7-xのインストール

このURLに含まれるスラッシュに余分にスラッシュをつけます。以下では.comの直後にです。

//2021/02/16/laravel-7-xのインストール

上のリンクをクリックしたらわかりますが、余分なスラッシュを削除して最初のようなURLにして希望したページを表示してくれます。これは、ブラウザが修正してくれるのではなくサーバーで使用しているワードプレスのプログラムが修正してくれます。

Laravel 7.x更新で余分なスラッシュが禁止となる

これに気づいたのは、お客さんのサイトでLaravelを6から7に更新した後です。お客さんが発行したメルマガに入っていた販売商品のページのリンクに余分なスラッシュが含まれていたのです。そのためにリンク先のページにアクセスしても、404の「ページが見つかりません」のエラーページです。さあ大変ということで原因わからずに、即座にLaravel6にダウングレードと、冷や汗ものでした。

お客さんの話では以前は余計なスラッシュが入っていてもアクセスできたということです。さて、いったいどういことでしょう、ということで調査すると、ありました。

https://github.com/laravel/framework/pull/32260

これによると、今までURLにおける余分なスラッシュの扱いにおいて問題がありました。routeをキャッシュしたときとしないときでの統一性にも問題があったそうです。しかしこのPRは、Laravel 7.xのバージョンにマージされています。

ということで、今後は余分なスラッシュがURLに入らないように注意する必要あります。

これからその点をしっかり注意するとして、問題は過去のメルマガに含まれるリンクです。過去だからアクセスをする人は少ないと思いますが昨日のメルマガとかからはアクセスしますよね。ということで、Laravel 7.xが対応しないURLを対応しなければなりません。そうでなければいつまでもLaravelの更新ができないです。

ということで、急いで解決方法を見つけました。

解決方法

解決方法は意外にも、phpのプログラムの変更ではなく、public/.htaccessのapacheのウェブサーバーの設定ファイルの修正でした。

以下は、URLのドメイン名の直後の余分なスラッシュを削除してくれます。

public/.htaccess

<IfModule mod_rewrite.c>
    <IfModule mod_negotiation.c>
        Options -MultiViews -Indexes
    </IfModule>

    RewriteEngine On

    # Handle Authorization Header
    RewriteCond %{HTTP:Authorization} .
    RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization}]

    # Redirect Trailing Slashes If Not A Folder...
    RewriteCond %{REQUEST_FILENAME} !-d
    RewriteCond %{REQUEST_URI} (.+)/$
    RewriteRule ^ %1 [L,R=301]

    # 余分なスラッシュを削除
    RewriteCond %{THE_REQUEST} \s//+
    RewriteRule (.*) /$1 [R=301,L]

    # Handle Front Controller...
    RewriteCond %{REQUEST_FILENAME} !/assets
    RewriteCond %{REQUEST_FILENAME} !/server-status
    RewriteCond %{REQUEST_FILENAME} !-d
    RewriteCond %{REQUEST_FILENAME} !-f
    RewriteRule ^ index.php [L]

</IfModule>

{THE_REQUEST}は、例えば GET /////2021/02/16/laravel-7-xのインストール HTTP/1.1のような値が含まれます。GETの後の空白文字が\sで//+が複数のスラッシュをマッチの条件とします。$1の変数には、余計なスラッシュを含まない2021/02/16/laravel-7-xのインストールの値となるので、/$1で１つのスラッシュに置き換えてリダイレクトします。

これで晴れてLaravel 7.xへの更新ができます！

Laravel 7.x更新で発見したこと（１）パジネーションのクエリ

Fri, 05 Mar 2021 12:36:06 +0900

Laravel6からLaravel7へのバージョン更新で起こった問題を深～く追及していったら、私のプログラムのバグの発見とともにLaravelフレームワークの内部の変更の背景を知ることになりました。

groupByを使ったパジネーションの問題

Laravel6.xからLaravel7.xに更新して、動作テストを行っていたらこのようなこと起こりました。

まず、テストケースの作成です。ユーザーの一日の歩行数を記録するとして以下の構造を持つstepsのテーブルを作成します。

user_idは、usersのuser.idとして、date_loggedが対象の日付、そしてstepsが歩行数です。

mysql> describe steps;
+-------------+----------------------+------+-----+---------+----------------+
| Field       | Type                 | Null | Key | Default | Extra          |
+-------------+----------------------+------+-----+---------+----------------+
| id          | bigint(20) unsigned  | NO   | PRI | NULL    | auto_increment |
| user_id     | int(10) unsigned     | NO   |     | NULL    |                |
| date_logged | date                 | NO   |     | NULL    |                |
| steps       | smallint(5) unsigned | NO   |     | 0       |                |
| created_at  | timestamp            | YES  |     | NULL    |                |
| updated_at  | timestamp            | YES  |     | NULL    |                |
+-------------+----------------------+------+-----+---------+----------------+
6 rows in set (0.00 sec)

factory()を利用してDBテーブルにデータを入れます。こんなデータです。

mysql> select * from steps;
+----+---------+-------------+-------+---------------------+---------------------+
| id | user_id | date_logged | steps | created_at          | updated_at          |
+----+---------+-------------+-------+---------------------+---------------------+
|  1 |       4 | 2021-02-20  |  1119 | 2021-02-26 15:53:46 | 2021-02-26 15:53:46 |
|  2 |       3 | 2021-02-22  |  3955 | 2021-02-26 15:53:46 | 2021-02-26 15:53:46 |
|  3 |       4 | 2021-02-21  |   294 | 2021-02-26 15:53:46 | 2021-02-26 15:53:46 |
|  4 |       2 | 2021-02-22  |  1473 | 2021-02-26 15:53:46 | 2021-02-26 15:53:46 |
|  5 |       1 | 2021-02-22  |  2858 | 2021-02-26 15:53:46 | 2021-02-26 15:53:46 |
|  6 |       2 | 2021-02-21  |  1517 | 2021-02-26 15:53:46 | 2021-02-26 15:53:46 |
|  7 |       3 | 2021-02-21  |  2913 | 2021-02-26 15:53:46 | 2021-02-26 15:53:46 |
|  8 |       2 | 2021-02-21  |  3653 | 2021-02-26 15:53:46 | 2021-02-26 15:53:46 |
|  9 |       1 | 2021-02-24  |   309 | 2021-02-26 15:53:46 | 2021-02-26 15:53:46 |
| 10 |       1 | 2021-02-24  |  2985 | 2021-02-26 15:53:46 | 2021-02-26 15:53:46 |
+----+---------+-------------+-------+---------------------+---------------------+
10 rows in set (0.01 sec)

さて、Laravel6.xの環境でtinkerを実行して以下のクエリを実行します。日付でグループ化してそれぞれの日付の総歩数を表示したいわけです。しかも、画面で表示するのでパジネーションを使います。

>>> use App\Step;

>>> $pager = Step::select('date_logged', DB::raw('sum(steps) as steps'), 'date_logged')
->groupBy('steps.date_logged')
->paginate(2)
=> Illuminate\Pagination\LengthAwarePaginator {#4152
     +onEachSide: 3,
   }

>>> $pager->toArray();
=> [
     "current_page" => 1,
     "data" => [
       [
         "date_logged" => "2021-02-20",
         "steps" => "1119",
       ],
       [
         "date_logged" => "2021-02-21",
         "steps" => "8377",
       ],
     ],
     "first_page_url" => "http://localhost?page=1",
     "from" => 1,
     "last_page" => 2,
     "last_page_url" => "http://localhost?page=2",
     "next_page_url" => "http://localhost?page=2",
     "path" => "http://localhost",
     "per_page" => 2,
     "prev_page_url" => null,
     "to" => 2,
     "total" => 4,
   ]

実行は問題ないですね。全部（total）で合計４つのレコードがあり、１ページあたり２レコード表示で最初の２つレコードを抽出（data）です。

さて、今度は同じクエリをLaravel 7.xで実行すると、

>>> use App\Step;

>>> $pager = Step::select('date_logged', DB::raw('sum(steps) as steps'), 'date_logged')
->groupBy('steps.date_logged')
->paginate(2)
Illuminate\Database\QueryException with message 'SQLSTATE[42S21]: Column already exists: 1060 Duplicate column name 'date_logged' (SQL: select count(*) as aggregate from (select `date_logged`, sum(steps) as steps, `date_logged` from `steps` group by `steps`.`date_logged`) as `aggregate_table`)'

とクエリがSQLの実行エラーになっていしまいます。

エラーは初歩的なミスで、クエリが返す項目に重複の項目があるよ、という指摘です。そうですね、select()でdate_loggedが重複しています。

しかし、Laravel 6.xでは問題ありませんでしたね。また、以下のpaginate()をget()に置き換えたクエリの実行はLaravel 7.xでも問題はありません。

>>> Step::select('date_logged', DB::raw('sum(steps) as steps'), 'date_logged')
->groupBy('steps.date_logged')
->get();
=> Illuminate\Database\Eloquent\Collection {#3658
     all: [
       App\Step {#4220
         date_logged: "2021-02-20",
         steps: "1119",
       },
       App\Step {#4219
         date_logged: "2021-02-21",
         steps: "8377",
       },
       App\Step {#4065
         date_logged: "2021-02-22",
         steps: "8286",
       },
       App\Step {#3337
         date_logged: "2021-02-24",
         steps: "3294",
       },
     ],
   }

エラーの原因は何でしょう？paginate()の関数のコードがLaravel7.xに変わった？

Laravel 6.xに戻って、実行されたクエリを見てみると、

>>> $pager = Step::select('date_logged', DB::raw('sum(steps) as steps'), 'date_logged')
->groupBy('steps.date_logged')
->paginate(2)
=> Illuminate\Pagination\LengthAwarePaginator {#3241
     +onEachSide: 3,
   }

>>> sql();
=> [
     [
       "query" => "select count(*) as aggregate from `steps` group by `steps`.`date_logged`",
       "bindings" => [],
       "time" => 1.37,
     ],
     [
       "query" => "select `date_logged`, sum(steps) as steps, `date_logged` from `steps` group by `steps`.`date_logged` limit 2 offset 0",
       "bindings" => [],
       "time" => 0.82,
     ],
   ]
]

Laravel 7.xで重複を修正して再度実行すると、

>>> use App\Step;                                                                                                                                                                                                  >>> $pager = Step::select('date_logged', DB::raw('sum(steps) as steps'))                                                                                                                                           ->groupBy('steps.date_logged')                                                                                                                                                                                     ->paginate(2)
=> Illuminate\Pagination\LengthAwarePaginator {#4274
     +onEachSide: 3,
   }

>>> sql()
=> [
     [
       "query" => "select count(*) as aggregate from (select `date_logged`, sum(steps) as steps from `steps` group by `steps`.`date_logged`) as `aggregate_table`",
       "bindings" => [],
       "time" => 164.63,
     ],
     [
       "query" => "select `date_logged`, sum(steps) as steps from `steps` group by `steps`.`date_logged` limit 2 offset 0",
       "bindings" => [],
       "time" => 0.42,
     ],
   ]

どちらを見てもわかるように、パジネーションを作成するには、指定したレコードを取得するクエリを実行するだけなく、対象となる総レコード数のクエリも実行されます。もちろんそうでないと、全部でのページ数がわかりません。

しかし、そのレコード数計算のためのクエリを比較してみると、Laravel 7.xでは対象のクエリをサブクエリとしてSQL文のFromに与えています。そして、そこの部分で項目の重複を許さないためにエラーとなった次第です。なるほど！

また、Laravel 7.xが一発でレコード数の結果を返しますが、Laravel 6.xのレコード数計算のクエリは結果が複数のレコードで返されますので、さらにそれ自体をカウントしなければいけません。多分にプログラムでカウントしていたのかもしれませんが、効率は良くないですね。

調べてみると

まず、Laravel 6.xのマニュアルでは、この部分

Currently, pagination operations that use a groupBy statement cannot be executed efficiently by Laravel. If you need to use a groupBy with a paginated result set, it is recommended that you query the database and create a paginator manually.
現在groupBy文を使用したパジネーションの操作は、Laravelで効率よく実行できません。groupByを使用したパジネーションを使用する必要がある場合はデータベースクエリを実行し、その結果を元にパジネーターを自前で作成してください）

とあります。

この記述はLaravel 7.xのマニュアルにもありますが、最新の7xのコードでは修正されているはずです（次を読むとわかります）。Laravel 8.xではこの記述はありません。

もう少し調べてみると、github.comのissuesにまさにそのマージありました。

[7.x] Run pagination count as subquery for group by and havings

Paginating queries with groupBy or having statements is a long-standing issue in Laravel going back to the very beginning of the framework with literal dozens of raised issues:
#1892, #2761, #3105, #4306, #6985, #7372, #9567, #10632, #14123, #16320, #17406, #22883, #28931

This solution was suggested @acasar years ago but I wrote it off at the time - but honestly I think it’s a lot better than what we have now so I’m bringing it up again for consideration.

groupByあるいはhavingを使用したパジネーションは、フレームワークの開発当初からたくさん問題として取り上げられたLaravelの長年の課題でした。

今回の@acasarが何年も前に提示した解決方法は、当時私が取り上げなかったものですが、正直言って現在使用されているものより良いので、ここで再度取り入れることにします。

なるほど、Laravelの作者でもこういうことがあるのですね。というかたくさんの人が改良のアイデア（あるいは不平）をいつも与えて続けているのは好まれている証拠です。

Laravel 7.xのインストール

Tue, 16 Feb 2021 06:12:05 +0900

最新のLaravelのバージョンは8.xなことはわかっています。私が新しいもの嫌いというわけでもありません。しかし、リリースされてからちょっと遅れて（１年近く経って）、Laravelのバージョン7.xのインストールの手順の紹介です。

バージョン

残念ながらバージョン7.xはLTS（長期サポート）ではありません。以下に見ての通りに来月でサポートが切れてしまいます。前バージョンの6.xの方がLTSサポートなのでサポート終了はまだ先です。

上の表を見て気づきましたか？　そうバージョン９から、今までの半年に１回のメジャーバージョンの更新が１年に１回となります。Laravelも成熟してきたというのが理由らしいです。これで少しは追いつけるかな。

新規プロジェクトの作成

composerはすでにシステムにインストールされていると仮定して、以下のコマンドがl7xのディレクトリ名でLaravelをインストールします。

$ composer create-project --prefer-dist laravel/laravel:^7.0 l7x

ウェブサーバーなどが書き込みを行うディレクトリにはパーミッションが必要です。

$ cd l7x
$ chmod -R a+w storage bootstrap/cache

以下を実行して、

$ php artisan serve

ブラウザでhttp://localhost:8000にアクセスすると、ページを見ることができます。

必要なら、この時点でパージョン管理をするのも良いアイデアです。

$ cd l7x
$ git init
$ git add .
$ git commit -am "init"

ユーザー認証のパッケージ

Laravelではユーザー認証の機能が簡単にインストールできます。

まず、必要なパッケージのインストールから、

$ composer require laravel/ui "^2.0"

次に、以下を実行して会員登録画面やログイン画面などを作成します。boostrapだけでなく、vueやreactの指定も可能です。

$ php artisan ui bootstrap --auth

これにより以下のファイルが追加あるいは編集されています。

	new file:   app/Http/Controllers/Auth/ConfirmPasswordController.php
	new file:   app/Http/Controllers/Auth/ForgotPasswordController.php
	new file:   app/Http/Controllers/Auth/LoginController.php
	new file:   app/Http/Controllers/Auth/RegisterController.php
	new file:   app/Http/Controllers/Auth/ResetPasswordController.php
	new file:   app/Http/Controllers/Auth/VerificationController.php
	new file:   app/Http/Controllers/HomeController.php
	modified:   composer.json
	modified:   composer.lock
	modified:   package.json
	modified:   resources/js/bootstrap.js
	new file:   resources/sass/_variables.scss
	modified:   resources/sass/app.scss
	new file:   resources/views/auth/login.blade.php
	new file:   resources/views/auth/passwords/confirm.blade.php
	new file:   resources/views/auth/passwords/email.blade.php
	new file:   resources/views/auth/passwords/reset.blade.php
	new file:   resources/views/auth/register.blade.php
	new file:   resources/views/auth/verify.blade.php
	new file:   resources/views/home.blade.php
	new file:   resources/views/layouts/app.blade.php
	modified:   routes/web.php

今度は、javascriptやcssのトランスパイルのために、nodeのパッケージのインストールとwebpackの実行です。

$ npm install && npm run dev

次はDBの設定です。mysqlのコマンドを実行して、l7xのデータベースを作成します。

$ mysql -u root -p
mysql> create database l7x;

.envファイルを次のように編集してDB情報を入れます。

DB_DATABASE=l7x DB_USERNAME=DBユーザー名 DB_PASSWORD=DBパスワード

以下のコマンドを実行してDBテーブルを作成します。

$ php artisan migrate

以下のように、４つのテーブルが作成されます。

mysql> show tables;
+-----------------+
| Tables_in_l7x   |
+-----------------+
| failed_jobs     |
| migrations      |
| password_resets |
| users           |
+-----------------+
4 rows in set (0.00 sec)

再度、ブラウザでhttp://localhost:8000/registerにアクセスします。

と入力して、「Register」ボタンをクリックすると、

新規会員登録成功です。

メールの送信（６）Notificationを使ってメールを送信

Sun, 07 Feb 2021 02:45:46 +0900

前回はMailableを使ってのメール送信の話でした。今回は、もう１つLaravelからメールを送信する方法としてNotificationの話です。

Notificationを使用してメールを送信

Mailableを使ってメールを送信するには、

use App\Mail\SomeMailableClass;

Mail::to("test@example.com")->send(new SomeMailableClass);

が典型的な送信の仕方です。

一方、今回紹介するNotificationは、Notifiableのトレイトを使ったモデルクラスにメールを送信する機能を与えます。

例えば、このようにUserのクラスにNotifiableを追加すると、

namespace App;

use Illuminate\Contracts\Auth\MustVerifyEmail;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;

class User extends Authenticatable implements MustVerifyEmail
{
    use Notifiable;
..
}

以下のように、Userのモデルのインスタンスのメソッドとして、notify()でメールを送信できます。

use App\User;
use App\Notifications\Hello;

$user = User::find(1);
$user->notify(new Hello);

上では、$userのオブジェクトの項目である、$user->emailが自動的にメール送信の宛先となります。

さて、送信するメールの内容の方は、Notificationのクラス（上ではHelloのクラス）の作成が必要です。

$ php artisan make:notification Hello

を実行して、作成されたファイルを以下のように編集します。

app/Notifications/Hello.php

namespace App\Notifications;

use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Notifications\Messages\MailMessage;
use Illuminate\Notifications\Notification;

class Hello extends Notification
{
    use Queueable;

    /**
     * Create a new notification instance.
     *
     * @return void
     */
    public function __construct()
    {
        //
    }

    /**
     * Get the notification's delivery channels.
     *
     * @param  mixed  $notifiable
     * @return array
     */
    public function via($notifiable)
    {
        return ['mail'];
    }

    /**
     * Get the mail representation of the notification.
     *
     * @param  mixed  $notifiable
     * @return \Illuminate\Notifications\Messages\MailMessage
     */
    public function toMail($notifiable)
    {
        return (new MailMessage)
                    ->subject('こんにちは')
                    ->greeting('こんにちは！')
                    ->line('メールの内容')
                    ->action('ホームページへ', url('/'))
                    ->line('ありがとうございます');
    }

    /**
     * Get the array representation of the notification.
     *
     * @param  mixed  $notifiable
     * @return array
     */
    public function toArray($notifiable)
    {
        return [
            //
        ];
    }
}

さてtinkerで送信してみます。

>>> $user = User::find(1);
[!] Aliasing 'User' to 'App\User' for this Tinker session.
=> App\User {#4072
     id: 1,
     name: "test",
     email: "test@example.com",
     email_verified_at: null,
     created_at: "2020-12-30 23:14:29",
     updated_at: "2020-12-30 23:14:29",
   }

>>> $user->notify(new App\Notifications\Hello);
=> null

MailTrapで送信したメールを見ると、

もうすでにHTMLのメールとなっています。

以下のように、文言はすべてMailMessageのクラスのメソッドで簡単に与えるだけOKです。上の例で、まだ英語として残っているRegards, Laravelの部分を変えたいなら、以下のように、salutationのメソッドに引数を渡します。

...
   public function toMail($notifiable)
    {
        return (new MailMessage)
                    ->subject('こんにちは')
                    ->greeting('こんにちは！')
                    ->line('メールの内容')
                    ->action('ホームページへ', url('/'))
                    ->line('ありがとうございます')
                    ->salutation('Larajapan');
    }
..

送信メールをカスタマイズ

もっとHTMLメールをカスタマイズしたいなら、以下を実行してデフォルトのブレードを自分のプロジェクトのディレクトリに出力します。

$ php artisan vendor:publish --tag=laravel-notifications
Copied Directory [/vendor/laravel/framework/src/Illuminate/Notifications/resources/views] To [/resources/views/vendor/notifications]
Publishing complete.

作成された、email.blade.phpは以下のようなマークダウンのブレードです。Laravelのコンポーネントとマークダウンのシンボルが混ざっていて少しわかりづらいですが、上で使用されたメソッド名がブレードでは変数名となっているのがわかります。line()に関してはボタンの表示を境に上と下で、$introLinesと$outroLinesに分かれます。

resources/views/vendor/notifications/email.blade.php

@component('mail::message')
{{-- Greeting --}}
@if (! empty($greeting))
# {{ $greeting }}
@else
@if ($level === 'error')
# @lang('Whoops!')
@else
# @lang('Hello!')
@endif
@endif

{{-- Intro Lines --}}
@foreach ($introLines as $line)
{{ $line }}

@endforeach

{{-- Action Button --}}
@isset($actionText)
<?php
    switch ($level) {
        case 'success':
        case 'error':
            $color = $level;
            break;
        default:
            $color = 'primary';
    }
?>
@component('mail::button', ['url' => $actionUrl, 'color' => $color])
{{ $actionText }}
@endcomponent
@endisset

{{-- Outro Lines --}}
@foreach ($outroLines as $line)
{{ $line }}

@endforeach

{{-- Salutation --}}
@if (! empty($salutation))
{{ $salutation }}
@else
@lang('Regards'),<br>
{{ config('app.name') }}
@endif

{{-- Subcopy --}}
@isset($actionText)
@slot('subcopy')
@lang(
    "If you’re having trouble clicking the \":actionText\" button, copy and paste the URL below\n".
    'into your web browser:',
    [
        'actionText' => $actionText,
    ]
) <span class="break-all">[{{ $displayableActionUrl }}]({{ $actionUrl }})</span>
@endslot
@endisset
@endcomponent

もちろん、前回のように独自のマークダウンのブレードを作成して利用することも可能です。その場合は以下のように、markdown()メソッドにブレード名を入れます。

app/Notifications/Hello.php

...
   /**
     * Get the mail representation of the notification.
     *
     * @param  mixed  $notifiable
     * @return \Illuminate\Notifications\Messages\MailMessage
     */
    public function toMail($notifiable)
    {
        return (new MailMessage)
                    ->subject('こんにちは！マークダウン')
                    ->markdown('emails.hello-markdown');
    }
...

メールの送信（５）HTMLメールのフォントなどをカスタマイズ

Sat, 30 Jan 2021 08:04:00 +0900

HTMLメールをマークダウンで簡単に作成して送信できることができたので、今度はフォントや色などのカスタマイズを試みます。

前回のマークダウンメールでに使われているコンポーネントやCSSの定義は、Laravelのパッケージの奥深くに隠れています。カスタマイズのためにはそれを日の目に出してあげる必要があります。まず以下をコマンドラインで実行します。

$ php artisan vendor:publish --tag=laravel-mail

resources/views/vendor/mailのディレクトリに以下のようにファイル作成されます。

resources
└── views
    ├── emails
    │   ├── hello.blade.php
    │   └── hello-markdown.blade.php
    ├── vendor
    │   └── mail
    │       ├── html
    │       │   ├── button.blade.php
    │       │   ├── footer.blade.php
    │       │   ├── header.blade.php
    │       │   ├── layout.blade.php
    │       │   ├── message.blade.php
    │       │   ├── panel.blade.php
    │       │   ├── subcopy.blade.php
    │       │   ├── table.blade.php
    │       │   └── themes
    │       │       └── default.css
    │       └── text
    │           ├── button.blade.php
    │           ├── footer.blade.php
    │           ├── header.blade.php
    │           ├── layout.blade.php
    │           ├── message.blade.php
    │           ├── panel.blade.php
    │           ├── subcopy.blade.php
    │           └── table.blade.php
    └── welcome.blade.php

resources/views/vendor/mailのhtmlのディレクトリには、HTML用メールのコンポーネント、textにはテキストメール用のコンポーネントの定義のファイルが作成されます。

これらのファイルがいったん作成されると、Laravelのパッケージの定義でなくこれらのファイルの定義がマークダウンのメール送信に使用されます。

今回は、ブレードのコンポーネントの理解などにば深入りはしたくないので、HTMLのカスタマイズにはCSSの定義だけを変更してみます。

デフォルトのCSSは、上に見られるのように、html/themes/default.cssにあります。以下にその内容の一部を掲載します。

/* Base */

body,
body *:not(html):not(style):not(br):not(tr):not(code) {
    box-sizing: border-box;
    font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif,
        'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol';
    position: relative;
}

body {
    -webkit-text-size-adjust: none;
    background-color: #ffffff;
    color: #718096;
    height: 100%;
    line-height: 1.4;
    margin: 0;
    padding: 0;
    width: 100% !important;
}

p,
ul,
ol,
blockquote {
    line-height: 1.4;
    text-align: left;
}

a {
    color: #3869d4;
}

a img {
    border: none;
}

/* Typography */

h1 {
    color: #3d4852;
    font-size: 18px;
    font-weight: bold;
    margin-top: 0;
    text-align: left;
}
...

font-familyの定義を見てわかる通りに、フォントなどは日本語のフォントを意識はしていません。

まず、そこを変えてみます。このデフォルトのCSSファイルを直接編集してもよいですが、将来を考慮してこのファイルのコピー、larajapan.cssを作成して編集します。

bodyのfont-familyのフォントとh1の色を変更します。

resources/views/vendor/mail/html/themes/laravel.css

/* Base */

body,
body *:not(html):not(style):not(br):not(tr):not(code) {
    box-sizing: border-box;
    font-family: "Lucida Grande", "Hiragino Kaku Gothic ProN", Meiryo, sans-serif; /*日本語のフォントを指定 */
    position: relative;
}
...
h1 {
    color: blue;　/* 青に変更 */
    font-size: 18px;
    font-weight: bold;
    margin-top: 0;
    text-align: left;
}
...

さて、このCSSの変更を反映してメールを送信するには、いくつか方法あります。

最初の方法は、config/mail.phpにおいて以下のように定義、

config/mail.php

return [
...
   /*
    |--------------------------------------------------------------------------
    | Markdown Mail Settings
    |--------------------------------------------------------------------------
    |
    | If you are using Markdown based email rendering, you may configure your
    | theme and component paths here, allowing you to customize the design
    | of the emails. Or, you may simply stick with the Laravel defaults!
    |
    */

    'markdown' => [
        'theme' => 'larajapan', // defaultからlarajapanに変更

        'paths' => [
            resource_path('views/vendor/mail'),
        ],
    ],

];

次の方法は、Mailableのクラスで定義。

app/MailHelloMarkdown

namespace App\Mail;

use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Mail\Mailable;
use Illuminate\Queue\SerializesModels;

class HelloMarkdown extends Mailable
{
    use Queueable, SerializesModels;

    /**
     * Create a new message instance.
     *
     * @return void
     */
    public function __construct()
    {
        $this->theme = 'larajapan';　//ここで指定
    }

    /**
     * Build the message.
     *
     * @return $this
     */
    public function build()
    {
        return $this->subject('こんにちは！マークダウン')
            ->markdown('emails.hello-markdown');
    }
}

最後は、HelloMarkdownのインスタンスで変更します。以下はtinkerでの例。

Psy Shell v0.10.6 (PHP 7.2.24 — cli) by Justin Hileman
>>> $mailable = new App\Mail\HelloMarkdown;
=> App\Mail\HelloMarkdown {#3283
     +locale: null,
     +from: [],
     +to: [],
     +cc: [],
     +bcc: [],
     +replyTo: [],
     +subject: null,
     +view: null,
     +textView: null,
     +viewData: [],
     +attachments: [],
     +rawAttachments: [],
     +diskAttachments: [],
     +callbacks: [],
     +theme: null,
     +mailer: null,
     +connection: null,
     +queue: null,
     +chainConnection: null,
     +chainQueue: null,
     +delay: null,
     +middleware: [],
     +chained: [],
   }

>>> $mailable->theme = 'larajapan';
=> "larajapan"

>>> Mail::to('test@example.com')->send($mailable);
=> null

さて、送信した結果をMailtrapで見てみます。

h1の部分は変更した通りに、青色になっていますが、フォントはそうたいした変化ないですね。HTMLソースを見てみましょう。

変更した定義のフォント（赤箱）になっていますね。MailtrapのCSSが上書きしているのかな？

このソースを見て気づいたと思いますが、HTMLメールでは、画面のHTMLと違って、

  <link rel="stylesheet" href="larajapan.css">

のような指定がソースにはなく、すべて定義に置き換えられています。

メールの送信（４）ブレードを使ってHTMLメールを作成

Sat, 23 Jan 2021 03:25:11 +0900

コントローラでブレードを指定して画面を作成するように、メールでもブレードを使ってメールの作成が可能です。今回はそれを可能にしてくれるMailableのお話です。

HTMLメールの送信

まず、Mailableの作成から。

$ php artisan make:mail HelloHtml

を実行すると、Mailableのクラス、HelloHtml.phpを作成してくれます。

これを以下のように編集します。

app/Mail/HelloHtml.php

namespace App\Mail;

use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Mail\Mailable;
use Illuminate\Queue\SerializesModels;

class HelloHtml extends Mailable
{
    use Queueable, SerializesModels;

    /**
     * Create a new message instance.
     *
     * @return void
     */
    public function __construct()
    {
        //
    }

    /**
     * Build the message.
     *
     * @return $this
     */
    public function build()
    {
       return $this->subject('こんにちは！') // メールの件名
            ->view('emails.hello');　// ここでブレードを指定
    }
}

ブレードの中身は、簡単に以下とします。

resources/views/emails/hello.blade.php

<html>
  <body>
    <h1>こんにちは！</h1>
  </body>
</html>

これをtinkerで送信します。

$ php artisan tinker
Psy Shell v0.10.6 (PHP 7.2.24 — cli) by Justin Hileman
>>> use App\Mail\HelloHtml;
>>> Mail::to('test@example.com')->send(new HelloHtml);
=> null

Mailtrapで送信されたメールを見てましょう。

HTMLメールとして届いていますね。

ここでひとつ修正です。前回にMailtrapの無料プランは３ヶ月までと書きましたが、それは大間違いで永遠に無料でした。毎月500通までの受信などの制限ありますが、私の使用頻度では十分です。

マークダウンを使ってもっとHTMLの要素をメールに

先に送信したメールは、HTMLですがとてもベーシックでつまらないですね。せっかくのHTMLだから、画像を入れたり色変えたりボタンを入れたりしたいです。しかし、コントローラの画面と違って、いちいちデザイナーに頼むのもなんです。

そこで、Laravelのマークダウンメールの登場です。

マークダウンのためのMailableのクラスの作成は、先のMailableのクラスと同じで、先のコマンドの実行に、–markdownの引数の指定するだけです。

$ php artisan make:mail HelloMarkdown --markdown=emails.hello-markdown

これで、HelloMarkdown.phpとhello-markdown.blade.phpが作成されます。

これらを以下のように編集します。

app/Mail/HelloMarkdown.php

namespace App\Mail;

use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Mail\Mailable;
use Illuminate\Queue\SerializesModels;

class HelloMarkdown extends Mailable
{
    use Queueable, SerializesModels;

    /**
     * Create a new message instance.
     *
     * @return void
     */
    public function __construct()
    {
        //
    }

    /**
     * Build the message.
     *
     * @return $this
     */
    public function build()
    {
        return $this->subject('こんにちは！マークダウン')
            ->markdown('emails.hello-markdown'); // viewでなくmarkdownメソッドを使用
    }
}

resources/views/emails/hello-markdown.blade.php

@component('mail::message')
# こんにちは

![Gmail](https://example.com/gmail.png)

ここにメールの内容が入る

@component('mail::button', ['url' => ''])
ホームページへ
@endcomponent

ありがとうございます<br>
{{ config('app.name') }}
@endcomponent

先と同様に、tinkerで送信します。

Psy Shell v0.10.6 (PHP 7.2.24 — cli) by Justin Hileman
>>> use App\Mail\HelloMarkdown;

>>> Mail::to('test@example.com')->send(new HelloMarkdown);
=> null

結果を、Mailtrapで見ると、以下のようになります。

tinkerでartisanを実行

Mon, 18 Jan 2021 04:23:35 +0900

debugbarを使うとコントローラでのDB処理に使用されるSQL文をブラウザ画面でデバッグ文をわざわざ挿入することなしに見ることができます。しかし、php artisanのコマンドラインの実行では同様なことできません。さて、どうしたらよいでしょうか？

まず、テストコマンドの作成から、

$ php artisan make:command TestCommand

この実行で、TestCommand.php が作成されます。これを以下のように編集します。

app/Console/Commands/TestCommand.php

namespace App\Console\Commands;

use App\User;
use Illuminate\Console\Command;

class TestCommand extends Command
{
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'command:test';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'テストコマンド';

    /**
     * Create a new command instance.
     *
     * @return void
     */
    public function __construct()
    {
        parent::__construct();
    }

    /**
     * Execute the console command.
     *
     * @return int
     */
    public function handle()
    {
        $count = User::count();

        echo "会員の数：$count\n";

        return 0;
    }
}

まず、通常のコマンドラインからの実行で動作確認です。

$ php artisan command:test
会員の数：1

大丈夫ですね。

さて、その実行でどのようなSQL文が実行されているかをチェックするには、そう、tinkerの登場です。以下はtinkerの１セッションですが、説明のために分割されているので注意を。

$ php artisan tinker
Psy Shell v0.10.4 (PHP 7.3.14 — cli) by Justin Hileman

まず、DBクエリのログ機能をオンにします。

>>> DB::enableQueryLog();
=> null

次に、コマンドの実行です。そうです、Artisan::call()の関数の引数にコマンド名を指定するだけなのです。

>>> Artisan::call('command:test');
会員の数：1
=> 0

次に、貯めたログを出力します。

>>> DB::getQueryLog();
=> [
     [
       "query" => "select count(*) as aggregate from `users`",
       "bindings" => [],
       "time" => 14.32,
     ],
   ]
>>>

SQL文が見れましたね。

DB::enableQueryLog()などを毎回毎回tinkerのセッションでタイプするのが面倒なら、以前のこの記事のようにブートストラップのファイルを作成しておくと、

$ php artisan tinker ~/tinker.php
>>> Artisan::call('command:test');
会員の数：1
=> 0
>>> sql()
=> [
     [
       "query" => "select count(*) as aggregate from `users`",
       "bindings" => [],
       "time" => 14.29,
     ],
   ]
>>>

と簡単になります。

私は、シェルのエイリアスとして、.zshrcファイルに入れています。

...
alias tinker='php artisan tinker ~/tinker.php'
...

メールの送信（３）メール受信サービス　Mailhog

Sun, 10 Jan 2021 13:03:22 +0900

前回紹介したMailtrapに比べて機能は劣りますが、十分代わりとなるしかもオープンスース（つまり無料）のMailhogの紹介です。このプログラムと知り合ったのは、Laravelの最新バージョン8のsailのパッケージで使用されていたからです。sailはDockerを使用して簡単に開発環境を作成できる素晴らしいものなのですが、Dockerの１つのコンテイナーとしてMailhogがインストールされます。sailの紹介は別の機会として、今回は単独でのインストールです。

インストール

まず、Mailhogはphpで作成されたプログラムでなく、Goの言語で書かれコンパイルされたバイナリのプログラムです。

以下がソースコードのレポジトリです。

https://github.com/mailhog/MailHog

しかし、ソースコードをコンパイルするやっかいなことは必要でありません。すでにコンパイルされたバイナリを以下からダウンロードできます。

https://github.com/mailhog/MailHog/releases/v1.0.0

この最新のリリースはもう３年以上も前なのは少し気になりますが、上のリンク先の画面の下方にOSごとのバイナリのダウンロードリンクがあります。

ここでは、私のFedoraの仮想環境でLinuxバージョンを選択します。

これをダウンロードして、mailhogと改名して/usr/local/binに移します。また、chmodを実行して適切なパーミッションを与えます。

# mv MailHog_linux_386 /usr/local/bin/mailhog
# chmod 755 mailhog

次にコマンドラインで、mailhogを実行します。このリンク先のようなスクリプトを作成して、OSのサービスとして立ち上げてもOKです。

$ mailhog 
2021/01/07 08:42:42 Using in-memory storage
2021/01/07 08:42:42 [SMTP] Binding to address: 0.0.0.0:1025
[HTTP] Binding to address: 0.0.0.0:8025
2021/01/07 08:42:42 Serving under http://0.0.0.0:8025/
Creating API v1 with WebPath: 
Creating API v2 with WebPath:

これでMailhogがメールを受信できる準備ができました。

Laravelの環境変数の設定

Laravelのプロジェクトでは、.envを編集して以下のようにメール送信の設定をします。

...
MAIL_MAILER=smtp
MAIL_HOST=0.0.0.0
MAIL_PORT=1025
MAIL_USERNAME=null
MAIL_PASSWIRD=null
MAIL_ENCRYPTION=null
MAIL_FROM_ADDRESS=test@example.com
MAIL_FROM_NAME=test
...

MailTrapのような設定ですが、PortやEncryptが違うことに注意を。

メール送信テスト

準備が整ったところで、tinkerでまずテキストメールを送信

$ php artisan tinker
Psy Shell v0.10.4 (PHP 7.2.24 — cli) by Justin Hileman
>>> Mail::raw('Hello', function($m) { $m->subject('hello')->to('test@example.com'); });
=> null
>>>

ブラウザを開いて、http://localhost:8025にアクセスすると、以下の画面が表示されます。

メール届いていますね！

メールの中身も閲覧できます。

今度は、アプリからHTMLのメールを送信します。

いいですね。ちゃんと表示されています。

さて、HTMLソースはどうでしょう。

う～ん。Quoted-printableがそのままです。例えば、上の画面の青背景は、「確認」の日本語なのですがこれじゃ読めません。もちろん、メールをファイルとしてダウンロードしてOutlookでHTMLソースを見ることが可能ですが、ちょいと不便です。

ここの部分残念ですが、自分のメールアカウントを使用せずに開発のテストとしては十分と思います。無料であることを考えたら、なおさら。

最後に、先のmailhogのプログラムの実行を停止したら、デフォルトではメモリにメールを保存なので受信したメールはすべて消えてしまいます。それが嫌なら、mongodbにメールを保存するオプションもあります。

メールの送信（２）メール受信サービス　Mailtrap

Sun, 03 Jan 2021 03:20:18 +0900

LaravelのマニュアルのMailのセクションでは、Mailtrapというサービスが紹介されています。開発中はGmailのアドレスの送信すればいいものの、なにゆえに必要なのか疑問を持っていました。しかし、先日LaravelのNotificationのHTMLメールでHTMLのタグがどう使われているかチェックするのに困ったことがあり、Mailtrapのサービスを使用してみました。

Mailtrapのようなサービスの必要性

これ考えてみましょう。開発では、これが意外と理由あるのです。

まず、通常使用している自分のメールアカウントに開発サイトから送信されるメールを一緒にしたくありません。しかも、テストのために何回も何回もプログラムからメールを送信して、いつもそれらを読んだ後削除するから、Gmailなどは学習して勝手にスパムあるいはゴミ箱に入れてしまいます。いちいちゴミ箱を見るのも面倒です。

それなら、メールフィルターで送信元で仕分ければとか、違うGmailアカウントを作成すれば、とか言われそうです。

しかし、開発では、１つのプロジェクトで複数の届け先のテストが必要なときがあります。例えば、違う会員で違う内容の送信となるときでは、違うメールアドレスでのテストが必要です。そうなら、いくつものフィルターの設定やメールアカウントが必要となり、いちいち設定が面倒なのです。

また、HTMLメールだと、特にLaravelでは最近マークダウンとかコンポーネントとか使用していて、最終的に生成されるメールのHTMLがどうなるかをチェックしたいときがあります。しかし、HTMLだとQuoted-printableのフォーマットであるし、Gmailでオリジナルのデータを見ても通常のHTMLとは違うのでわけがわからないのです。こんな感じです。

ということで、これらの開発者が直面する問題を解決すべく、このようなサービスがあるわけです。

サインアップ

英語版しかないのですが、まずサインアップ。アカウントは、メールアドレスとパスワードだけで作成可能です。GoogleやGithubなどのアカウントがすでにあるならそれを通してログインしてもOKです。

無料版なのでチャージされることないので心配ないです。

Laravelの環境変数の設定

以下の画面で、Laravelを選択したら、.envにそのままコピーできる環境設定を表示してくれます。

Mailtrapのインボックス

さっそく、メールを送信してみます。Laravelで会員登録完了時に送信されるメールアドレス確認のメールです。HTMLのメールです。

見れましたね。どのメールアドレスに送信してもmailtrapのInboxに入ります。

中身のHTMLソースを見てみましょう。

これなら、通常のブラウザで見るHTMLソースと同じようです。つまり読めます。並んでいるタブの「Raw」をクリックして比べてみてください。

無料はいつまで？

この時点においては、無料版は1ヶ月500通までの受信OKで、~~3ヶ月まで~~永遠に無料です。有料のプランとしては、月9ドルから始まります。

メールの送信（１）メール送信の確認

Fri, 25 Dec 2020 01:22:52 +0900

先日、Laravelのメール送信の設定、つまり、.envでメールに関わる環境変数の設定をいじっていて、設定が正しいかどうかをテストすることで学んだことを共有です。

メール送信のテストは、メールサーバーが走っている環境下なら以下のようなシェルのコマンドラインで実行できます。

$ echo Hello | mail -s hello test@examle.com

届け先は、test@example.com、件名は、hello、内容は、Helloのメールが届きます。

しかし、Laravelのプロジェクトを通して同様にメールを送るには、Mailのファサードの登場です。tinkerで実行してみましょう。

Psy Shell v0.10.4 (PHP 7.2.16 — cli) by Justin Hileman
>>> Mail::raw('Hello', function($m) { $m->subject('hello')->to('test@example.com'); });
=> null

これでメールが届けば、実際使用するプロジェクトのメール関連の環境設定が正しいということです。便利です。

先ほどのは、テキストメールの送信の確認ですが、HTMLのメールの送信も確認したいです。

以下のように、今度は Mail::htmlのコールとなりました。

Psy Shell v0.10.4 (PHP 7.2.16 — cli) by Justin Hileman
>>> Mail::html('<h1>Hello</h1>', function($m) { $m->subject('hello')->to('test@example.com'); });
=> null

「どちらかに入力してください」のバリデーション

Sun, 13 Dec 2020 01:58:11 +0900

入力画面のバリデーションでちょいと頭をひねったケースです。２つの入力項目があり、どちらかが必須なのだけれど両方の入力は禁止という場合です。まず、具体的な例を見てみましょう。

簡単化しましたが、要はお客さんに配るクーポンのレコードの作成です。

注目してもらいたのは「割引」の項目で、２つの入力場所があります。ひとつは割引額で円で入力、もうひとつは割引率で%で入力です。

コントローラのコードはこんな感じです。新規のDBレコード作成の部分だけですけれど。

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class CouponController extends Controller
{
    /**
     * Show the form for creating a new resource.
     *
     * @return \Illuminate\Http\Response
     */
    public function create()
    {
  		return view('coupon.create');
    }

    /**
     * Store a newly created resource in storage.
     *
     * @param  \Illuminate\Http\Request  $request
     * @return \Illuminate\Http\Response
     */
    public function store(Request $request)
    {
    	$rules = [
            'code'            => 'required|alpha_numeric',
            'discount_amount' => 'nullable|required_without:discount_rate|integer|gt:0',
    	    'discount_rate'   => 'nullable|required_without:discount_amount|integer|gt:0|lte:100',
    	];

    	$validated = $request->validate($rules);

        // DBに保存のコードがここに入る
    }
...

discount_amount（割引額）と discount_rate（割引率）のバリデーションに注目してください。nullableは両方とも空になるかもしれないゆえに必要です。

次の、required_withoutは指定する項目が空のとき（つまりnull）はバリデーションの対象の項目が必須となる、ということです。両方の項目でお互いの項目を指定しているのは、両方が空となっては困るからです。つまり、どちらかの入力が必須となります。

よさそうですね。

と思いきや、この問題は両方に値を入れてもパスしてしまうことです。

その問題に対応するために思いついたのは、以下のようにバリデーションに匿名の関数を使用します。

...
   	$rules = [
            'code'            => 'required|alpha_num',
            'discount_amount' => [
                'nullable',
                'required_without:discount_rate',
                function ($attribute, $value, $fail) {
                    if (request('discount_rate')) {
                        $fail("割引額あるいは割引率どちらかだけ入力してください");
                    }
                },
                'integer',
                'gt:0',
            ],
    		'discount_rate'   => 'nullable|required_without:discount_amount|integer|gt:0|lte:100',
    	];
...

request()のヘルパーがここで役に立ちます。バリデーション対象以外の項目の値を簡単に取得できます。

最後に、今回の「どちらかに入力してください」のケースはそう起こることではないと思いますが、UIを変えてクリエイティブな対応も可能と思います。例えば、以下のように割引額と割引率をラジオボタンとすると、それぞれに対応する値の入力項目は２つでなく１つになり常に必須とすることできます。もちろん、それはそれでバリデーションのルールが簡単になるかどうかは保証なしですけれど。

入力フォームで@error

Sun, 22 Nov 2020 11:03:46 +0900

今回は、またしても新規のLaravelのバージョン対しての私のキャッチアップの話です。もちろん、存在は知っていたのですが、最近まで使用する機会がありませんでした。ブレードで使われる@errorの話なのですが、調べたら登場したのはなんとLaravelバージョン5.8、現在のバージョンが8.xなので遠い昔のように思えます。しかし、5.8がリリースされたのはつい去年のことです。Laravelのバージョン形態が変わってから、どんどん更新が早まっていくように感じられます。

@if vs @error

まず、バリデーションエラー表示において、どう@ifから@errorへ進化したかを比較してみます。

@ifを使用すると、

<label for="title">投稿のタイトル</label>

<input id="title" type="text" class="@if ($errors->has('title') is-invalid @endif">

@if ($errors->has('title')
    <div class="alert alert-danger">{{ $errors->first('title') }}</div>
@endif

これが、@errorを使用すると、

<label for="title">投稿のタイトル</label>

<input id="title" type="text" class="@error('title') is-invalid @enderror">

@error('title')
    <div class="alert alert-danger">{{ $message }}</div>
@enderror

両者とも意味は同じですが、@errorの方がすっきりして意味がわかりやすいですね。

配列の入力があるフォームで@error

さて、先の例と違って、以下のような配列フォームではどう@errorを使うことができるでしょう？

まず、エラー表示のもととなるコントローラのバリデーションは、

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class FormController extends Controller
{
    public function create()
    {
    	return view('form.create');
    }

    public function store(Request $request)
    {
    	$rules = [
            'name.*'  => 'nullable',
            'price.*' => 'nullable|required_with:name.*|integer|gt:0',
    	];

        $messages = [
            'price.*.required_with' => '入力してください',
            'price.*.integer'       => '整数で入力してください',
            'price.*.gt'            => '０超の整数で入力してください',
        ];

    	$validated = $request->validate($rules, $messages);

        // DBに保存...
   }
...

配列だから、name.のように、項目名にが使用されていることに注意してください。 nullableは、空(null)の入力でもOKという意味です。

使用されるブレードは、

@extends('layouts.app')

@section('content')
<div class="container">
  <div class="row justify-content-center">
    <div class="col-md-8">
      <div class="card">
        <div class="card-header">出費</div>

        <div class="card-body">
          <form method="POST" action="{{ route('form.store') }}">
            @csrf

            <div class="table-responsive">
              <table class="table table-bordered table-hover table-sm">
              <thead>
                <tr>
                <th class="">アイテム名</th>
                <th class="">金額</th>
                </tr>
              </thead>
              <tbody>
                @for($i = 0; $i < 5; $i++)
                  <tr>
                    <td>
                      <input type="text" class="form-control @error('name.'.$i) is-invalid @enderror" name="name[]" value="{{ old('name.'.$i) }}">
                      @error('name.'.$i)
                        <span class="invalid-feedback" role="alert">
                          <strong>{{ $message }}</strong>
                        </span>
                      @enderror
                    </td>
                    <td>
                      <input type="text" class="form-control @error('price.'.$i) is-invalid @enderror" name="price[]" value="{{ old('price.'.$i) }}">
                      @error('price.'.$i)
                        <span class="invalid-feedback" role="alert">
                          <strong>{{ $message }}</strong>
                        </span>
                      @enderror
                    </td>
                  </tr>
                @endfor
              </tbody>
              </table>
            </div>

            <div class="row justify-content-center">
              <button type="submit" class="btn btn-primary">
                  保存
              </button>
            </div>
          </form>
        </div>
      </div>
    </div>
  </div>
</div>
@endsection

@error(‘price.’.$i)と、price1でなくprice.1となっていることに注意してください。Laravelでは、price.1は指定の配列値で、price[1]と同じことです。同様に、old()でもold(‘price.’.$i)とprice.1となっています。

メンテナンス画面：php artisan up & down

Sun, 08 Nov 2020 05:10:45 +0900

Laravelの経験が長くなると、つまり初期のバージョンから使用していると、昔のやり方しか知らずに過ごしていることがあります。以前にメンテナンス画面の裏口のポストがありますが、それはバージョン5.1の話で、大昔です。ということでやり方学びなおします。

メンテンナンス画面

プログラムの更新をインストールしたり、データベースに変更をしたりするときは、誰にも作業中にアクセスしてもらいたくありません。そのときに、以下を実行します。

$ php artisan down

これを実行すると、アクセスしてきたら、以下のような画面が表示されます。それで安心して、プログラムを更新したり、データベースを変更したり、など好き勝手なことできます。

メンテナンスが完了したら、

$ php artisan up

を実行して、皆にアクセスできるようにします。

メンテンナンス画面にメッセージを表示したいなら、

$ php artisan down --message="メンテナンス中です。午前３時に終了します。"

と実行すると以下のように、メッセージが表示されます。

便利ですね。

私がアクセスしたい

メンテナンスの間、好き勝手なことをするのはいいのですが、私自身がサイトにアクセスできないと困ります。プログラムの更新をテストすることなどができません。

特定のIPアドレスからアクセスできるようにする、つまり裏口を作る必要あります。

ここが以前（古いLaravelのバージョン）と最近のバージョンが違うところです。

$ php artisan down --message="メンテナンス中です。午前３時に終了します。" --allow=192.168.56.1

のように、–allowの引数で自分のIPアドレスを指定するだけで、私にとってはアクセス可能となります。

さらに、毎回毎回コマンドラインで指定するのが面倒なら、以前のように

app/Http/Middleware/CheckForMaintenanceMode.php

namespace App\Http\Middleware;

use Closure;
use Symfony\Component\HttpFoundation\IpUtils;

use Illuminate\Foundation\Http\Middleware\CheckForMaintenanceMode as Middleware;

class CheckForMaintenanceMode extends Middleware
{
    /**
     * The URIs that should be reachable while maintenance mode is enabled.
     *
     * @var array
     */
    protected $except = [
    	//
    ];

    protected $allowed = [
    	'192.168.56.1'　// ここで許可するIPを登録
    ];

    /**
     * Handle an incoming request.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Closure  $next
     * @return mixed
     *
     * @throws \Symfony\Component\HttpKernel\Exception\HttpException
     * @throws \Illuminate\Foundation\Http\Exceptions\MaintenanceModeException
     */
    public function handle($request, Closure $next)
    {
        if ($this->app->isDownForMaintenance()) {

            if (IpUtils::checkIp($request->ip(), (array) $this->allowed)) {
                return $next($request);
            }
        }

        return parent::handle($request, $next);　// ここで親の関数を呼ぶ
    }
}

と編集します。

メンテナンス画面をカスタマイズしたいなら

メンテナンス画面をカスタマイズしたいなら、まず、以下を実行してブレードを作成します。

$ php artisan vendor:publish --tag=laravel-errors

resources/viewsのディレクトリにerrorsサブディレクトリが作成されて以下のファイルがコピーされます。

errors
├── 401.blade.php
├── 403.blade.php
├── 404.blade.php
├── 419.blade.php
├── 429.blade.php
├── 500.blade.php
├── 503.blade.php
├── illustrated-layout.blade.php
├── layout.blade.php
└── minimal.blade.php

メンテナンス画面のカスタマイズのために編集するファイル、503.blade.phpです。503は、Service Unavailable、つまり「サービスは利用できません」のウェブステータスです。

artisanのコマンドは実行できる？

最後に、メンテナンス中に、クロンで設定されているphp artisanのコマンドは実行されるかどうかですが、php aritsan upが実行できるのだからもちろん実行可能です。ということは、メンテナンス中においてクロンのサービスをいったん止めることも必要かもしれません。ご注意を。

パンくずパッケージ、復活！

Thu, 29 Oct 2020 23:19:59 +0900

以前から紹介したいと思っていたパンくずのパッケージがありました。人気ものなのですが、作者が忙しいという理由で管理を辞めてしまいました。幸い、Laravelのバージョンが上がっても問題なく動作していますが、いつダメになるわかりません。小さなパッケージはこれがあるから嫌だなと思うところですが、オープンソースゆえに他の開発者が後継してくれました。しかも、「オフィシャル」となっているので長期間管理されるようです。今回はこのパッケージの紹介です。

まず、以下の画面見てください。

パンくずとは、矢印の部分に表示される階層のナビゲーションのことです。

現在の画面のポジション、ここなら管理ユーザーのtesttestの編集画面ということがわかるし、その前の「管理ユーザーリスト」、「ホーム」にもリンクがついてここから直接リンク先に飛ばすことができます。

さて、これを作成するためには、まずパッケージのインストールから、

$ composer require diglactic/laravel-breadcrumbs

実行が完了したら、次は設定です。

routes/breadcrumbs.php

のファイルを作成して、以下のように定義します。、

routes/breadcrumbs.php

Breadcrumbs::for('admin.home', function ($trail) {
    $trail->push('ホーム', route('admin.home'));
})

Breadcrumbs::for('admin.user.index', function ($trail) {
    $trail->parent('admin.home');
    $trail->push('管理ユーザー', route('admin.user.index'));
});

Breadcrumbs::for('admin.user.create', function ($trail) {
    $trail->parent('admin.user.index');
    $trail->push('新規');
});

Breadcrumbs::for('admin.user.show', function ($trail, $user) {
    $trail->parent('admin.user.index');
    $trail->push($user->login);
});

// 以下が先の画面のパンくず
Breadcrumbs::for('admin.user.edit', function ($trail, $user) {
    $trail->parent('admin.user.show', $user);
    $trail->push('編集');
});

パンくずの名前、つまりfor()の最初の引数、がユニークである必要があります。名前つきのルートを使用しているなら、それと同じとするのが良いでしょう。

parent()の関数を使用するなら、その前に定義したパンくずとチェーンできます。例えば、上の、admin.user.editの定義なら、以下のようにチェーンされます。

admin.user.edit →　admin.user.show → admin.user.index → admin.home

設定が完了したら、ブレイドのレイアウトのテンプレートファイルに、

...
{{ Breadcrumbs::render('admin.user.edit', $user) }}
..

と埋め込むと、最初の画面のようなHTMLコードが自動生成されます。

もちろん、このためのテンプレートがあるわけですが、デフォルトではbootstrap ver.4が使われます。

こちらが今回紹介したパッケージ：

https://github.com/diglactic/laravel-breadcrumbs

長い間、大変お世話になっていた旧パッケージ：

https://github.com/davejamesmiller/laravel-breadcrumbs

FormRequestのユニットテスト

Sun, 18 Oct 2020 01:17:02 +0900

前回のFormRequestの入力補正を例にして、そのユニットテストを作成してみます。

ルールの部分だけのテスト

まず、テスト作成のコマンドを実行します。

$ php artisan make:test App/Http/Requests/EventRequestTest

実行すると、テストのファイルはLaravelのディレクトリ構造を真似て、tests/Feature/App/Http/Requestsのディレクトリに作成されます。

作成されたテストを以下のように編集します。

app/tests/Feature/App/Http/Requests/EventRequestTest.php

namespace Tests\Feature\App\Http\Requests;

use App\Http\Requests\EventRequest;

use Illuminate\Foundation\Testing\RefreshDatabase;
use Illuminate\Foundation\Testing\WithFaker;
use Tests\TestCase;

class EventRequestTest extends TestCase
{
    /**
     * @test
     * @dataProvider validationProvider
     */
    public function validation($expected, $data)
    {
        $rules = (new EventRequest())->rules(); // rules()だけを抜き出す
        $validator = validator($data, $rules);

        $this->assertEquals($expected, $validator->passes());
    }

    public function validationProvider()
    {
        return [
            [
                true,
                [
                    'start_at' => '2020-01-01 00:00:00',
                    'end_at'   => '2020-01-01 01:00:00',
                ],
            ],
            [
                false,
                [
                    'start_at' => '2020-01-01 00:00:00',
                    'end_at'   => '2020-01-01 24:00:00', // 24時はない
                ],
            ]
        ];
    }
}

実行すれば、こんな感じでパスです。あとはvalidationProvider()のテストケースを増やしていくだけです。

PHPUnit 8.5.8 by Sebastian Bergmann and contributors.

..                                                                  2 / 2 (100%)

Time: 152 ms, Memory: 22.00 MB

OK (2 tests, 2 assertions)

しかし、ちょっと待ってください!

EventRequestでは以下のようにprepareForValidation()が使用されています。つまり、実際の入力の項目（date, start_hr, end_hr）を合わせて新規の項目（start_at, end_at）を作成しています。

...
    protected function prepareForValidation()
    {
        // ここでDBに収納する項目を作成
        $this->merge([
            'start_at' => sprintf('%s %02d:00:00', $this->date, $this->start_hr),
            'end_at'   => sprintf('%s %02d:59:59', $this->date, $this->end_hr),
        ]);
    }
...

先のテストでは、ルールだけのテストなのでこの部分のテストをスキップしてしまっているのです。

ベターなテスト

やはり、直接画面から入力されるテストをしたいということで、$this->post(’/event’)とかの使用も考えましたが、DBデータを用意する必要や認証も考えてやらないやら、ちょいと面倒です。

ということで、以下の記事を見つけました。

https://dev.to/dsazup/testing-laravel-form-requests-853

これを参照して先のテストを変更しました。今度は、dateとstart_hrとend_hrがテストデータとなっていることに注意してください。

namespace Tests\Feature\App\Http\Requests;

use App\Http\Requests\EventRequest;

use Illuminate\Foundation\Testing\RefreshDatabase;
use Illuminate\Foundation\Testing\WithFaker;
use Illuminate\Validation\ValidationException;

use Tests\TestCase;

class EventRequestTest extends TestCase
{
    /**
     * @test
     * @dataProvider validationProvider
     */
    public function validation($expected, $data)
    {
       $this->assertEquals($expected, $this->validate($data));
    }

    // ここが先の記事からとってきたところ、LaravelのFormRequestServiceProvider::boot()を参照したらしい。
    protected function validate($data)
    {
        $this->app->resolving(EventRequest::class, function ($resolved) use ($data){
            $resolved->merge($data);
        });

        try {
            app(EventRequest::class);

            return true;
        } catch (ValidationException $e) {
            return false;
        }
    }

    public function validationProvider()
    {
        return [
            [
                true,
                [
                    'date'     => '2020-01-01',
                    'start_hr' => '0',
                    'end_hr'   => '1',
                ],
            ],
            [
                false,
                [
                    'date'     => '2020-01-01',
                    'start_hr' => '0',
                    'end_hr'   => '24',
                ],
            ]
        ];
    }
}

実行してみると、

PHPUnit 8.5.8 by Sebastian Bergmann and contributors.

..                                                                  2 / 2 (100%)

Time: 145 ms, Memory: 22.00 MB

OK (2 tests, 2 assertions)

うまいこと成功です！

テストにより問題発見！

テストケースを増やしてみます。

...
    public function validationProvider()
    {
        return [
...
            [
                true,
                [
                    // 同じ時間は、00:00:00と00:59:59となるのでOK
                    'date'     => '2020-01-01',
                    'start_hr' => '0',
                    'end_hr'   => '0',
                ],
           ],
           [
                false,
                [
                    'date'     => '2020-01-01',
                    'start_hr' => 'a',
                    'end_hr'   => 'b',
                ],
            ]
        ];
    }
}

PHPUnit 8.5.8 by Sebastian Bergmann and contributors.

...F                                                                4 / 4 (100%)

Time: 268 ms, Memory: 22.00 MB

There was 1 failure:

1) Tests\Feature\App\Http\Requests\EventRequestTest::validation with data set #3 (false, array('2020-01-01', 'a', 'b'))
Failed asserting that true matches expected false.

あれれ、エラーになりました。　これでは、‘2020-01-01’, ‘a’, ‘b’の入力でも正しいということになってしまいます。これはおかしい。

問題は、EventRequest::prepareForValidation()の部分で、以下のようにsprintf()で文字列が０に変換されることです。tinkerを使って検証してみると、

>>> $data = (object)['date' => '2020-01-01', 'start_hr' => 'a', 'end_hr' => 'b'];
=> {#4452
     +"date": "2020-01-01",
     +"start_hr": "a",
     +"end_hr": "b",
   }
>>> sprintf('%s %02d:00:00', $data->date, $data->start_hr, $data->end_hr);
=> "2020-01-01 00:00:00"

ゼロになっていましたね。

さて、この修正は以下となりました。start_atを作成するFormRequestの関数で、start_hr, end_hrを先にチェックして違法なら、invalidという文字列を与えることにしました。

...
   protected function prepareForValidation()
    {
        if (! preg_match('/^[0-9]{1,2}$/', $this->start_hr)) { // ２桁の数字でないときは、'invalid'とする
            $start_at = 'invalid';
        } else {
            $start_at = sprintf('%s %02d:00:00', $this->date, $this->start_hr);
        }

        if (! preg_match('/^[0-9]{1,2}$/', $this->end_hr)) {
            $end_at = 'invalid';
        } else {
            $end_at = sprintf('%s %02d:59:59', $this->date, $this->end_hr);
        }

        $this->merge([
            'start_at' => $start_at,
            'end_at'   => $end_at,
        ]);
    }
...

実行すると、今度はパスです。

PHPUnit 8.5.8 by Sebastian Bergmann and contributors.

....                                                                4 / 4 (100%)

Time: 203 ms, Memory: 22.00 MB

OK (4 tests, 4 assertions)

FormRequestで入力値を補正（２）

Sat, 10 Oct 2020 01:20:11 +0900

FormRequestで入力値を補正を以前紹介しましたが、今度はちょっと違う補正の紹介です。何が違うというと、今度はバリデーションの後でなくバリデーション前に入力値を変えます。入力項目とDBに保存する項目の形態が違うときにとても便利です。とりあえず、それが必要なケースの説明から。

まず、DBに保存するのは、start_at（開始日時）とend_at（終了日時）の日時タイプ（mysqlならDATETIME）の２つ項目とします。しかし、両方の項目ともに日付は同じという仮定。いくつかのUIのバリエーションが考えられますが、私が考えたのは以下。

つまり、入力項目は、日付、開始時刻（数字）、終了時刻（数字）の３つの入力項目です。

日付はjquery-uiでカレンダーからの選択も可能（以下）であるし、時刻もドロップダウン、とすることもできますね。

画面から入ってくるのは、date, start_hr, end_hrの３つの値なのですが、さて、これらの入力値をバリデーションにかけて、DBには、start_atとend_atの２つの項目に保存するには、どうしたらよいでしょうか？

そこで登場するのが、FormRequestです。

まず、以下のコマンドでFormRequestファイルを、app/Http/Requestsのディレクトリに作成します。

$ php artisan make:request EventRequest

作成されたファイルを以下のように編集します。

app/Http/Requests/EventRequest.php

namespace App\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;

class EventRequest extends FormRequest
{
    /**
     * Get the validation rules that apply to the request.
     *
     * @return array
     */
    public function rules()
    {
        return [
            'start_at'     => 'required|date|date_format:Y-m-d H:i:s',
            'end_at'       => 'required|date|date_format:Y-m-d H:i:s|after:start_at',
        ];
    }

    public function messages()
    {
        return [
            'date_format' => '不正な日時のフォーマットです',
        ];
    }

   public function attributes()
    {
        return [
            'start_at' => '開始日時',
            'end_at'   => '終了日時',
        ];
    }

    /**
     * Prepare the data for validation.
     *
     * @return void
     */
    protected function prepareForValidation()
    {
        // ここでDBに収納する項目を作成
        $this->merge([
            'start_at' => sprintf('%s %02d:00:00', $this->date, $this->start_hr),
            'end_at'   => sprintf('%s %02d:59:59', $this->date, $this->end_hr),
        ]);
    }
}

ここ、preparedForValidation()の関数において、入力値を、start_atとend_atの入力値に変換しています。DBではそれらの項目はDateTimeのタイプなので、時間だけでなく分や秒も足すこと必要です。

コントローラのメソッドでは、以下のようにコールします。store()の引数が、通常のRequestでなくEventRequestとなっていることに注意を。

app/Http/Controllers/EventController.php

namespace App\Http\Controllers;

use App\Http\Controllers\Controller;
use App\Http\Requests\EventRequest;

class EventController extends Controller
{
...
    /**
     * Store
     *
     * @param  \App\Http\Requests\EventRequest $request
     * @return \Illuminate\Http\RedirectResponse
     */
    public function store(EventRequest $request)
    {
        dd($request->all());
...

実行すると、dd()の出力は、

array:6 [▼
  "_token" => "npq1EPLTVvthufpgQiIpXIkxpwMPEsEEIBIzYf5A"
  "date" => "2020-10-08"
  "start_hr" => "8"
  "end_hr" => "17"
  "start_at" => "2020-10-08 08:00:00"
  "end_at" => "2020-10-08 17:59:59"
]

withInput(), withErrors(), with()

Sat, 03 Oct 2020 02:10:22 +0900

前回では、入力画面で投稿した入力値やバリデーションエラーを画面に表示するために、セッションを利用してそれらの値がキープされることを知りました。今回はそれらがどのようにコントローラで指示されるかを見てみます。

Laravelの認証パッケージで提供されるものは、より複雑なので簡単な会員登録のコントローラをここでは使います。

RegisterController.php

namespace App\Http\Controllers;

use App\User;

use Illuminate\Http\Request;

class RegisterController extends Controller
{
    /**
     * Create
     *
     * @return \Illuminate\View\View
     */
    public function create()
    {
        return view('auth.register');
    }

    /**
     * Store
     *
     * @param  \Illuminate\Http\Request $request
     * @return \Illuminate\Http\RedirectResponse
     */
    public function store(Request $request)
    {
        $rules = [
            'name'                  => 'required',
            'email'                 => 'required|email',
            'password'              => 'required|confirmed',
            'password_confirmation' => 'required',
        ];

        $request->validate($rules);

        User::create($request->all);

        return redirect()
            ->route('login')
            ->with('status', '新規作成完了');
    }
}

３４行目の$request->validate($rules)のコードが、バリデーションエラーが起こったときに、入力値やエラーをセッションに一時的に保存する作業をすべてやってくれるのですが、これではシンプルすぎ（もちろん良いことですが）で説明のしようがないので、以下のように拡張したコードに変えてみます。

...
        $validator = validator($request->all(), $rules); // バリデーションを実行

        if ($validator->fails()) { // バリデーションエラーがあるなら、
            return back()   // 前の画面にリダイレクト
                ->withInput() // セッション(_old_input)に入力値すべてを入れる
                ->withErrors($validator); // セッション(errors)にエラーの情報を入れる
        }
...

上でコメントを入れましたが、back()にチェーンされた、withInput()とwithErrors()の関数が入力値とエラーをセッションに保存してくれます。

withInput()の引数として、配列関数を指定することもできます。例えば、

...
            return back()
                ->withInput($request->except('email')) // email以外の入力値を保存
                ->withErrors($validator);
...

さらに、入力値やエラーと関係ない値も、with()でセッションに保存して、次の画面で使用も可能です。

...
            return back()
                ->withInput($request->except('email'))
                ->with('error', '入力エラーがあります')
                ->with(['more' => 'メッセージ', 'more2' => 'メッセージ2']);
...

デバッグバーで見ると、セッションに保存されていることがわかります。

with()で渡した値は、ブレードでは、session()ヘルパーを利用して、

@if (session('error')) 
    <div class="alert alert-danger">{{ session('error') }}</div>
@endif

のように使えます。

old()ヘルパー

Fri, 25 Sep 2020 23:42:41 +0900

Laravelのブレードファイルでよく見かける、old()ヘルパー。エラーが起こった時に入力した値をキープしてエラーとともに入力項目に残してくれる優れものです。今回はこの仕組みを見てみます。

ブレードファイル

old()ヘルパーはブレードファイルに使われます。以下は、Laravelのデフォルトの認証に使用されるブレードのファイルの一部をとってきました。

...
<div class="form-group row">
	<label for="email" class="col-md-4 col-form-label text-md-right">{{ __('E-Mail Address') }}</label>

	<div class="col-md-6">
		<input id="email" type="text" class="form-control @error('email') is-invalid @enderror" name="email" 
		    value="{{ old('email') }}" required autocomplete="email">

		@error('email')
			<span class="invalid-feedback" role="alert">
				<strong>{{ $message }}</strong>
			</span>
		@enderror
	</div>
</div>
...

inputのHTML文で、value="{{ old(’email’) }}"にヘルパーが使われていますね。

このために、以下のようにエラーが起こると、入力した値が再表示されます（ここでは、デモののためにtype=“email"ではなく、type=“text"としています）。

リクエストの流れ

エラーが出力するまでのリクエストの流れをたどってみると、以下の３つのリクエストとリスポンスからなります。

GETのリクエストで空の入力画面が表示されます。
次に、不正なEmailの値を入れて、「Register」のボタンを押すとPOSTのリクエストでサーバー、つまりLaravelのコントローラに送信されます。
そこのバリデーションでエラーが起こると（つまりメールアドレスのフォーマットではない）、入力した値とエラーを表示するためにGETのリクエストで以下の画面となります。

さて、どうやってLaravelはPOSTした入力値を次のGETで表示される画面に出力しているのでしょう？

Laravelはこの目的のためにセッションを利用しています。上の２番目のPOSTのリクエストでセッションに入力値を保存して、次のGETのリクエストのときに、セッションから取り出します。このセッションの保存は特別で、使用は次のリクエストのみです。それゆえに同じ画面を手動でリフレッシュすると上の１の空の入力の画面となります。

デバッグバー

ここ実際のセッションの状態がどう遷移するか見てみたいですね。

そこで登場するのがデバッグバーのパッケージです。

以下でインストールできます。

$ composer require barryvdh/laravel-debugbar --dev

デバッグバーをインストールして、同じ画面でエラーを発生させると、以下のように画面下で実行したDBクエリーやセッションなどの情報を見ることできます。

赤の矢印の部分をクリックすると、セッションの情報が表示されます。あれれ、old()の値となるセッション項目は空ですね。おかしいかなと思いきや、この画面は、流れの３番目の画面を表示後の段階で、もう保存した値はセッションにはないのです。その前のPOSTのの直後のセッションの値を見る必要あります。

POSTへ戻るには、青箱のフォルダーアイコンをクリックします。そこでポップアップ表示される以下のダイアログにおいて、POSTの行をクリックします。

以下がPOSTの直後でのセッションの値です。見ての通りに、_old_inputには入力された値、errorsにはエラーのデータが保存されています。さらに、_flashの配列には、oldとして_old_inputとerrorsがあり、これらは次のリクエストで利用できることを示しています。

route()ヘルパー

Sat, 19 Sep 2020 06:44:13 +0900

Laravelのヘルパーの関数は本当に便利なもので、日常よく使うものです。しかし、こんな使い方もあったのか、と知らない使い方を知って嬉しくなることあります。今回は私を嬉しくさせる、route()のヘルパーの紹介です。

私はrouteに名前を付けるのが好きで、プログラムのrouteにはすべて名前がついています。それゆえに、route()のヘルパーは欠かせないものです。

以下は、Laravel 7.xバージョンの新規プロジェクトを作成してユーザー認証もインストールしたプロジェクトのrouteです。

+----------+------------------------+------------------+------------------------------------------------------------------------+ | Method | URI | Name | Action | +----------+------------------------+------------------+------------------------------------------------------------------------+ | GET|HEAD | / | | Closure | | GET|HEAD | api/user | | Closure | | GET|HEAD | home | home | App\Http\Controllers\HomeController@index | | GET|HEAD | login | login | App\Http\Controllers\Auth\LoginController@showLoginForm | | POST | login | | App\Http\Controllers\Auth\LoginController@login | | POST | logout | logout | App\Http\Controllers\Auth\LoginController@logout | | GET|HEAD | password/confirm | password.confirm | App\Http\Controllers\Auth\ConfirmPasswordController@showConfirmForm | | POST | password/confirm | | App\Http\Controllers\Auth\ConfirmPasswordController@confirm | | POST | password/email | password.email | App\Http\Controllers\Auth\ForgotPasswordController@sendResetLinkEmail | | GET|HEAD | password/reset | password.request | App\Http\Controllers\Auth\ForgotPasswordController@showLinkRequestForm | | POST | password/reset | password.update | App\Http\Controllers\Auth\ResetPasswordController@reset | | GET|HEAD | password/reset/{token} | password.reset | App\Http\Controllers\Auth\ResetPasswordController@showResetForm | | GET|HEAD | register | register | App\Http\Controllers\Auth\RegisterController@showRegistrationForm | | POST | register | | App\Http\Controllers\Auth\RegisterController@register | +----------+------------------------+------------------+------------------------------------------------------------------------+
第３番目のNameの列がrouteの名前です。この値をもとにtinkerで、route()を使っていろいろなurlを作成してみます。まずは基本からで、route()の最初の引数に、route名を渡します。

>>> route('home'); => "http://localhost/home"
作成されたurlの、http://localhostの部分は、.envのAPP_URLの定義から来ています。 .envにおいて、

.env

... APP_URL=http://www.example.com ...
と定義すると、

>>> route('home'); => "http://www.example.com/home"
となります。

今度は、route()に２番目の引数を与えます。

>>> route('password.reset', ['token' => '1232457890']); => "http://www.example.com/password/reset/1232457890"
このtokenは上のrouteの表のURIで password/reset/{token}と定義されているので、与えた値に置き換わります。

しかし、定義されていない変数も渡すこと可能です。

>>> route('password.reset', ['token' => '1232457890', 'type' => 'user']); => "http://www.example.com/password/reset/1232457890?type=user"
この値は、コントローラの引数の$requestを使って、$request->typeとかで取得できますね。

さらに、‘type’ => ‘user’の配列の形でなくても、単に、‘user’とかでも与えることできます。

>>> route('password.reset', ['token' => '1232457890', 'user']); => "http://www.example.com/password/reset/1232457890?user"
この場合は、コントローラ側では、$request->has(‘user’)とかでブーリアン値で取得できます。

今度は、route()の第３の引数です。これはブーリアン値で、デフォルトがtrueでfalseを与えるとドメイン名がついた絶対URLではなくパス名だけを生成してくれます。

>>> route('home', null, false); => "/home"
最後に、redirect()にもroute()を使えます。

SomeController.php

] ... return redirect(route('home'));
でもOKですが、

... return redirect()->route('home');
とチェーンできます。

Laravelへの移行（３）管理画面のスターターパッケージ　Laravel-AdminLTE

Sun, 06 Sep 2020 01:17:16 +0900

前回に引き続いて、Laravelを使用したBootstrapの管理画面のスターターパッケージの紹介です。いかに新規のプロジェクトの管理画面を速く立ち上げるかが目的です。前回は、Core UIをベースにしたパッケージでしたが、今度は、Admin LTEをベースにしたものです。両方ともBootstrapのバージョン４をもとにしています。

インストール

Laravel Boilerplateでは、Laravelそのものも含むzipファイルをダウンロードしてインストールという形式でしたが、Laravel-AdminLTEでは、まずLaravelのプロジェクトをコマンドラインで作成してから、Laravel-AdminLTEのパッケージjeroennoten/laravel-adminlteをcomposerでプロジェクトにインストールします。その際には、依存するパッケージalmasaeed2010/adminlteもインストールされます。 almasaeed2010/adminlteのパッケージがAdmin LTEの無料版のCSSフレームワークで、jeroennoten/laravel-adminlteのパッケージがLaravelのプロジェクトにおいて、管理画面のbladeファイル、レイアウト設定やメニューなどの機能を提供します。

ルック

残念ながらLaravel-Admin LTEのデモサイトがないのですが、以下のような感じです。

ログイン画像

管理画面画像

config/app.phpで設定が必要ですが、日本語も対応しています。

Admin LTEに関しては、こちらでいろいろなUIを閲覧できます。

設定
Laravel Boilerplateと比べて、デフォルトでインストールされている機能は少ないですが、以下のベーシックなレイアウトの設定が独自のconfig/adminlte.phpのファイルから簡単にできます。

タイトル

ファビコン

ロゴ画像

ユーザーメニュー
これは、画面右上のログインしたユーザー名（ここではkenji）をクリックしたときの表示。

レイアウト
例えば、上の画面の設定では、固定のナビバーとフッターを指定しています。
'layout_topnav' => null, 'layout_boxed' => null, 'layout_fixed_sidebar' => false, 'layout_fixed_navbar' => true, 'layout_fixed_footer' => true,

認証の画面表示のCSSクラス

body、content、sidebar、topnavなどのcssクラス

サイドバーのルック

ユーザーのプロフィールやダッシュボードやログアウトなどのURL

Laravel MIXの使用

サイドバーのメニューの指定
配列で指定できます。階層もOKです。以下は上のメニューの設定の一部。

style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;">'menu' => [ [ 'text' => 'search', 'search' => true, 'topnav' => true, ], [ 'text' => 'blog', 'url' => 'admin/blog', 'can' => 'manage-blog', ], [ 'text' => 'pages', 'url' => 'admin/pages', 'icon' => 'far fa-fw fa-file', 'label' => 4, 'label_color' => 'success', ], ['header' => 'account_settings'], [ 'text' => 'profile', 'url' => 'admin/settings', 'icon' => 'fas fa-fw fa-user', ], [ 'text' => 'change_password', 'url' => 'admin/settings', 'icon' => 'fas fa-fw fa-lock', ], [ 'text' => 'multilevel', 'icon' => 'fas fa-fw fa-share', 'submenu' => [ [ 'text' => 'level_one', 'url' => '#', ], style="color:#f92672">...
サイドバーのメニューのフィルター。権限によりメニューのオン・オフが可能となります。プラグイン。datatablesやselect2などのjsの指定。
これら設定は、以下の場所で詳細がドキュメントされています。 https://github.com/jeroennoten/Laravel-AdminLTE#6-configuration 採用できそう？気に入ったのは、基本的な設定が簡単にconfigファイルで行えることです。また、Laravel Boilerplateと違って、独立したパッケージとして提供されているので、将来のパッケージの更新の面では管理しやすいと思います。
Laravelへの移行（２）管理画面のスターターパッケージ　Laravel Boilerplate Sun, 30 Aug 2020 09:32:09 +0900 前回ではセッションを共有することで、現行のPHPのプログラムと新規のLaravelのプログラムの行き来が可能となりました。もう現行に縛られることはないので、新規の画面のルックも最新のレスポンシブ対応のBootstrapを取り入れてみます。管理画面の移行を前提に、Laravelを使用したBootstrapの管理画面のスターターパッケージをいくつか紹介します。今回はLaravel Boilerplateをご紹介します。デモ Laravel Boilerplateは、現在Laravel6.xと7.xの２つのバージョンがあります。ウェブサイトは、https://laravel-boilerplate.com/index.html デモサイトがあるので早速見てみましょう。 https://demo.laravel-boilerplate.com/login 以下の情報でログインできます。管理者: User: admin@admin.com Password: secret ユーザー: User: user@user.com Password: secret ログイン画面は、管理者としてログインすると管理画面となりますが、以下はそのユーザー管理画面、とちょっと日本語変だけれど日本語にも対応しています。ルックは、以下のBoostrapバージョン４対応のCore UIを使用しています。これを見るといろいろなことができそうでワクワクしますね。追加されたcomposerのパッケージインストールして標準装着されている機能をチェックしたいなら、composer.jsonを見るのが手っ取り早いです。以下は、Laravel 7.xのデフォルトのcomposerのrequireのセクションです。 ... "require": { "php": "^7.2.5", "fideloper/proxy": "^4.2", "fruitcake/laravel-cors": "^1.0", "guzzlehttp/guzzle": "^6.3", "laravel/framework": "^7.0", "laravel/tinker": "^2.0", "laravel/ui": "^2.1" }, ... 以下は、Laravel boilerplateの同様なセクションです。 ... "require": { "php": "^7.2.5", "albertcht/invisible-recaptcha": "^1.9", "arcanedev/log-viewer": "7.x", "darkghosthunter/laraguard": "^2.0", "fideloper/proxy": "^4.2", "fruitcake/laravel-cors": "^2.0", "guzzlehttp/guzzle": "^6.3", "jamesmills/laravel-timezone": "^1.9", "lab404/laravel-impersonate": "^1.6", "langleyfoxall/laravel-nist-password-rules": "^4.1", "laravel/framework": "^7.22.4", "laravel/socialite": "^4.3", "laravel/tinker": "^2.0", "laravel/ui": "^2.0", "livewire/livewire": "^1.0", "rappasoft/laravel-livewire-tables": "^0.1", "rappasoft/lockout": "^2.1", "spatie/laravel-activitylog": "^3.14", "spatie/laravel-permission": "^3.11", "tabuna/breadcrumbs": "^1.0" }, ... いくつか追加されたパッケージを紹介すると、 arcanedev/log-viewer Laravelのログも含めて、作成されたログファイルを管理画面でログのメッセージのレベルにマッチした色付きで閲覧できるようです。 darkghosthunter/laraguard 「2ファクタ認証」のパッケージです。最初から必要でないかもしれないですが、オプションとしてあるのはいいですね。 lab404/laravel-impersonate これは管理者があたかもユーザーになりすますためのパッケージです。すでにLaravelにその機能あったような。 rappasoft/laravel-livewire-tables これは以前紹介したjqueryのdatatablesのlivewire版です。 spatie/laravel-activitylog こちらは以前紹介した、DBの変更履歴記録と同様なパッケージです。 spatie/laravel-permission これは上に掲載したユーザー管理の画面において、それぞれのユーザーにロール（役割）を割り当てるためのパッケージです。それにより、ログインした管理者がどの画面にアクセスが可能かを操作します。結構なパッケージです。 tabuna/breadcrumbs このブログでいつか紹介しようと思っていたのですが、パンくず表示のための、とても有名な、https://github.com/davejamesmiller/laravel-breadcrumbsパッケージがありました。しかし、残念なことに作者の都合で今年更新ストップとなりました。しかし、嬉しいことに、違うプログラマがそれをもとに新たなパッケージを作成したのがこれです。まだ使用したことありませんが、いつか紹介したいです。追加されたnode-jsのパッケージ今度は、jsのパッケージの方を見てみます。 composerと同様に、laravel 7.xでは、 ... "devDependencies": { "axios": "^0.19", "bootstrap": "^4.0.0", "cross-env": "^7.0", "jquery": "^3.2", "laravel-mix": "^5.0.1", "lodash": "^4.17.13", "popper.js": "^1.12", "resolve-url-loader": "^3.1.0", "sass": "^1.15.2", "sass-loader": "^8.0.0", "vue-template-compiler": "^2.6.11" } ... Laravel Boilerplateでは、 ... "devDependencies": { "@coreui/coreui": "^3.0.0", "@coreui/icons": "^1.0.1", "@fortawesome/fontawesome-free": "^5.12.1", "@popperjs/core": "^2.0.6", "alpinejs": "^2.3.5", "axios": "^0.19", "bootstrap": "^4.5.0", "cross-env": "^7.0", "jquery": "^3.5.1", "laravel-mix": "^5.0.1", "lodash": "^4.17.19", "perfect-scrollbar": "^1.5.0", "popper.js": "^1.16.1", "resolve-url-loader": "^2.3.1", "sass": "^1.20.1", "sass-loader": "^8.0.0", "sweetalert2": "^9.8.2", "vue": "^2.5.17", "vue-template-compiler": "^2.6.10" } ... こちらも追加されたパッケージを見てみましょう。 @coreui/coreui、@coreui/icons テンプレートとして使用しているCore UIのパッケージです。なるほどnpmで管理するのですね。アイコンも1500以上あるようです。ちなみに、Core UIを使用しているのは、管理者画面の部分のみです。 @fortawesome/fontawesome-free これは非常に有名なアイコンのライブラリです。有料版もありますが、ここでは無料版を使用です。先の、Core UIのアイコンと合わせて膨大な数のアイコンから選択可能となります。 alpinejs こちらはLivewireの作者のjsフレームワークです。日本語のマニュアルもありますね。 sweetalert2 こちらは、jsのalert()のベターバージョンのようですね。興味あります。さて、これ採用できそう？機能が盛りだくさん、というのが印象です。しかし使いこなすには、彼ら独自のディレクトリの構造（Domainなど）があり、すべて理解する必要あり時間がかかりそうです。かと言って、要らない機能のパッケージを外して簡単化するのは、影響する部分を考えると難しそうだし。また、resources/viewsのディレクトリの構造やその中のbladeファイルを見ると、コンポーネントとか使用してとてもフレキシブルにしていますが、細分化しすぎの感がありこれまた理解に時間がかかりそうです。また、多言語対応なので、国際的なプロジェクトの作成には良いかもしれませんが、日本語だけしか必要ないとなると複雑すぎです。あと、管理画面のメニューを管理する機能があればよいのですが、残念ながらありません。これを採用するかどうかは別として、知らないパッケージがどう使われているかはとても参考になりそうで、時間かけて理解するのは価値はあります。ということで次回は違うLaravelのスターターパッケージ（？）を見てみます。