パッケージ on ララジャパン

composerをもっと知ろう（４）ローカルのパッケージをLaravelで使う

Fri, 21 Feb 2025 10:58:09 +0900

皆さんは、DGFTのベリトランスの支払決済のPHPのSDKキットを使用したことありますか？それを利用するには彼らのウェブサイトからファイルをダウンロードして、プロジェクトに置いてそれをパッケージとしてインストールします。今回はその仕組みの説明です。ローカルにパッケージを作成してそれをcomposer requireします。

自分のパッケージを作成

まず、デモとしてあるヘルパー関数の定義を含むパッケージを作成します。このパッケージには１つのヘルパー関数しかなく、インストールしたら以下のように、全角の英数字文字列を半角に変換する関数、to_hankaku()を使うことができます。

Psy Shell v0.12.7 (PHP 8.2.15 — cli) by Justin Hileman
> to_hankaku('１２３');
= "123"

便利そうでしょう。

まず、Laravelのプロジェクトを新規作成して、プロジェクトのディレクトリ直下にpackagesのディレクトリを作成して、以下のような構造で必要なファイルを作成します。

├── app
...

packages
└── larajapan
    └── japanese-utils
        ├── composer.json
        └── src
            └── helpers.php
...

上では、composer.jsonとhelpers.phpのみがファイルで他は皆ディレクトリです。larajapanが開発者のアイデンティティでその下のjapanese-utilsが今回のパッケージ名となります。

まずそのパッケージのcomposer.jsonの中身を見てみましょう（混乱していけないのは、このcomposer.jsonはjapanese-utilsのパッケージのcomposer.jsonであり、これからそれをインストールしようというLaravelのプロジェクト、つまりルートパッケージのcomposer.jsonではありません）。

packages/larajapan/japanese-utils/composer.json

{
    "name": "larajapan/japanese-utils",
    "description": "helpers to manipuliate a japanese string",
    "version": "1.0.0",
    "require": {
        "php": ">=7.4",
        "ext-mbstring": "*"
    },
    "autoload": {
        "files": [
            "src/helpers.php"
        ]
    }
}

ここでは、パッケージ名（name）、説明（description）、バージョン（version）、必須条件（require）、ロードの指示（autoload）が含まれます。to_hanakaku()の関数では、mbstringのPHPのモジュールのmb_convert()を使用し、さらにタイプヒントも使用するので、それを対応しているPHPバージョン7.4以上であることをインストールの前提とします.

今度は、その関数を定義するhelpers.phpを見てみましょう。

packages/larajapan/japanese-utils/src/helpers.php

if (!function_exists('to_hankaku')) {
    function to_hankaku(string $zenkaku): string
    {
        return mb_convert_kana($zenkaku, 'as'); // 全角英数字と空白を半角に変換
    }
}

とても簡単な定義ですが、他のパッケージですでに定義されていたら困るので、!function_exists(’to_hankaku’)の条件を入れています。

Laravelのプロジェクトにインストール

同じプロジェクトのディレクトリ内にパッケージを作成したものの、これだけではプロジェクトで先ほどのto_hanakaku()は使えません。プロジェクトにインストールすることが必要です。

今度は作成したパッケージのではなくプロジェクト（ルートパッケージ）のcomposer.jsonの編集が必要です。以下のrepositoriesのブロックが追加した部分です。

composer.json

{
    "$schema": "https://getcomposer.org/schema.json",
    "name": "laravel/laravel",
    "type": "project",
    "description": "The skeleton application for the Laravel framework.",
    "keywords": ["laravel", "framework"],
    "license": "MIT",
    "repositories": [
        {
            "type": "path",
            "url": "./packages/larajapan/japanese-utils",
            "options": {
                "symlink": true
            }
        }
    ],
    "require": {
        "php": "^8.2",
        "laravel/framework": "^11.31",
        "laravel/tinker": "^2.9"
    },
...
}

“type”: “path”がローカルのパッケージがレポジトリということを指示し、その場所 “url”にパッケージの相対の場所を指定します。そして、“options”として、“symlink”: trueは、プロジェクトにおいて使用されるパッケージを収めるvendorのディレクトリにおいて、作成したパッケージへのsymlinkを張るという指示です。ちなみにfalseならファイルのコピーとなります。

これでインストールの準備は完了です。通常のパッケージのインストールのようにcomposre requireを実行しましょう。

$ composer require larajapan/japanese-utils

インストール後には、composer.jsonは更新され、“larajapan/japanese-utils”: “^1.0”,のエントリーが追加されているのがわかります。

composer.json

{
...
    "require": {
        "php": "^8.2",
        "larajapan/japanese-utils": "^1.0",
        "laravel/framework": "^11.31",
        "laravel/tinker": "^2.9"
    },
...
}

vendorのディレクトリを見ると、以下のようにパッケージへのsymlinkとなっています。

$ ls -l vendor/larajapan
total 0
lrwxrwxrwx 1 kenji kenji 40 Feb 19 16:42 japanese-utils -> ../../packages/larajapan/japanese-utils/

これで、このLaravelのプロジェクト内で、to_hankaku()のヘルパーをどこでも使えるようになります。

最後に

自分が作成したパッケージは、Packagistに登録したものでもなく、githubのレポジトリに置いたプライベートのパッケージでもありません。そのようなパッケージが必要となるのは不思議と思われるかもしれません。しかし、以下のようにいくつか必要となるケースがあります。

将来はPackagistにおいて自分で開発したパッケージを共有したいが、完成度が低いので暫くは自分のプロジェクトだけ使う
今まで使用していたgithubにあるパッケージはもうメンテインされていなくダウンロードして自分のプロジェクトだけで使えるようにする
プロジェクトが肥大化したのでパッケージとしてモジュール化して使う
あえて自社のサービスのSDKキットをPackagistでパブリックで共有することをせずに、サービスを利用する開発者にローカルにダウンロードしてからcomposerでインストールしてもらう。日本で有名なDGFTのベリトランスの決済のPHPのSDKキットはまさにそれです。

Googleリキャプチャv2の導入

Tue, 02 May 2023 05:08:18 +0900

タイトルを見てv2とは古いんじゃないと言われそうです。しかし「私はロボットでありません」というのが好きなお客さんも要るのです。今回はGoogle reCaptchaを簡単に取り付けできるパッケージを紹介します。もちろん、v3あるいはさらにエンタープライズバージョンも将来に紹介する予定です。

サイトを登録してキーを取得

Googleのアカウントをすでに持っている、そしてログインしていることを仮定して以下のURLへ行きます。 https://www.google.com/recaptcha/admin 日本語版の画面というのはないみたいですね（間違っていたらお知らせを）。

画面の赤箱部分を入力します。

Labelは設定の名前なので代表する名前を入力してください。保存後に編集可能です。
reCAPTCHA Typeは、ここではv2の「私はロボットでありません」（I'm not a robot）のチェックボックスを選択しますが、チェックボックスなし（invisible）も選択可能です。画面の右下に表示されているのが多分にそのreCAPTCHAタイプでしょう。それから、こちらの設定は保存後に変更できません。
DomainsはreCaptchaを使用するサイトのドメイン名です。複数のドメインの入力が可能で自分が持っていないドメイン（例えばお客さんの）でもOKです。保存後に編集も可能です。

上の画面で「Submit」ボタンを押すと以下の画面へ遷移します。

サイトキーとシークレットキーが生成されています。ここでそれらをコピーして控える必要はないです。Settingの画面に行くといつでも以下のように両方とも閲覧可能です。

この画面では、Ownersのところで私以外に他のユーザーがオーナーとなることも可能です。後に話しますが、不正アクセス数を含むアクセスの統計を表示する画面があるのでそれらは関係者と共有した方がいいですね。

上の画面では、Send Alert To Ownersは、何か問題が起きた時に先に登録したオーナーにメールするのでチェックボックスをオンとした方が良いです。

v2のパッケージ

今回の目的のためにLaravelで使用できるcomposerのパッケージはいくつかあります。

まず、本家のGoogleから、 https://github.com/google/recaptcha もちろん、これがベストなのですがバリデーションルールやフロントエンドなどの設定は自作する必要あります。自作してもそうは難しくないですけれど。 https://github.com/biscolab/laravel-recaptcha こちら、パッケージ名にLaravelがあるくらいだから、Laravelのために作られています。Laravelのバージョン5から10まで対応しています。オプションが多く細かく指定できるようですが、私としてはちょっと多すぎでそこまで頭を使いたくありません。

ということで、落ち着いたのが以下、 https://github.com/thinhbuzz/laravel-google-captcha こちらも、Laravel特定です。バリデーションもあるし、ブレードにある関数を埋め込むだけでgoogleのapi urlも入れてくれるのでフロンエンドの作成も簡単です。

laravel-google-captchaのインストールと設定

早速インストールしてみましょう。

composer require buzz/laravel-google-captcha

–devがないことに注意を。

config/captcha.phpを生成するために以下も実行します。

php artisan vendor:publish --provider="Buzz\LaravelGoogleCaptcha\CaptchaServiceProvider"

そして、.envにおいて以下を追加します。先ほどの画面からキーは取得します。

.env

CAPTCHA_SITEKEY=6Lc18solAAAAABF13H_BrF0t0pQ237n-KmXBFWWC
CAPTCHA_SECRET=6Lc18solAAAAADWvyxFaAT_XA29eV6SHi-JMb-NJ

さて、ブレードには以下のように入れます。表示のときには、

{!! Captcha::display() !!}
@error('g-recaptcha-response')
    <div class="alert alert-danger">{{ $message }}</div>
@enderror

画面が表示されるときには、

<script src="https://www.google.com/recaptcha/api.js?hl=ja" async defer></script><div class="g-recaptcha" theme="light" id="buzzNoCaptchaId_5cfd27964f5cbd34338165f72c4675ab" data-sitekey="6Lc18solAAAAABF13H_BrF0t0pQ237n-KmXBFWWC"></div>

ように、google apiへのurlも入れてくれます。

もちろん、その画面には以下のように「私はロボットでありません」のチェックボックスが表示されます。

サーバー側でのバリデーションでは、以下のようにcaptchaを指定するだけです。

$request->validate([
    'email'                => ['required', 'email', 'unique:customer,email'],
    'password'             => ['required', new CustomerPasswordRule, 'confirmed'],
    'name'                 => ['required', 'string'],
    'g-recaptcha-response' => ['required', 'captcha'],
];

Googleの管理画面

最後にですが、Googleの管理画面で以下のような統計情報を見せてくれます。

青の棒グラフが「私はロボットでありません」をクリックしても、テストするための画像が表示されなくパスしたもので、緑がテストの画像が表示されましたがユーザーが問題なくパス。そして赤がテストの画像が表示されて失敗したものとなります。

そうだ、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 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 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 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形式でも出力してくれます。その他、対応している拡張子が公式ドキュメントの方に載っていますのでチェックしてみて下さい。

長くなってしまったので、続きは次の記事にします。

パンくずパッケージ、復活！

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

phpdotenv

Sun, 21 Jun 2020 01:14:36 +0900

Laravelのプロジェクトでは、環境変数の設定は.envのファイルで行います。インストールするプロジェクトの環境（開発、ステージング、プロダクション）ごとで内容を変更できるし、.gitignoreに入れておけばバージョン管理のレポジトリでプライベートなデータ（パスワードやapiのトークンなど）を共有する必要もなく安全です。この機能、私の昔のphpのプロジェクト、つまりLaravel生誕以前の時代でのプロジェクトで現在もお客さんに使用されているプロジェクトでも取り入れたいです。

まず、この機能を提供するのは、phpdotenvというパッケージです。

https://github.com/vlucas/phpdotenv

Laravelのプロジェクトでは、以下のコマンドを実行すると、

$ composer show | grep dotenv
vlucas/phpdotenv                      v3.6.4   Loads environment variables from `.env` to `getenv()`, `$_ENV` and `$_SERVER` automagically.

とパッケージが使用されていることが確認されます。

さて、Laravelでないphpのプロジェクトでこのパッケージを使うには、以下のように、プロジェクトのディレクトリを作成してから、パッケージをインストールします。

$ mkdir dotenv
$ composer require vlucas/phpdotenv

チェックのためにテストのプログラムを作成します。

test.php

<?php
require_once 'vendor/autoload.php';
$dotenv = Dotenv\Dotenv::createImmutable(__DIR__);
$dotenv->load();                                                                                                                                                                                                   

echo $_ENV['BASE_DIR']."\n";

.envのファイルも作成します。

.env

BASE_DIR=/var/www/example

この時点で、このプロジェクトのディレクトリ構造は、以下のようになります。

.
├── composer.json
├── composer.lock
├── .env
├── test.php
└── vendor
    ├── autoload.php
    ├── composer
    ├── graham-campbell
    ├── phpoption
    ├── symfony
    └── vlucas

テストを実行してみます。

$ php test.php
/var/www/example

.envから値を取得できましたね。以下のような設定も可能です。

.env

BASE_DIR=/var/www/example
IMAGE_DIR=${BASE_DIR}/images

すでに設定した環境変数を.envの中で変数として使用できます。つまり、Laravelでも同様なことができるのですね、

DB変更履歴の作成（４）パッケージ

Sun, 07 Jun 2020 04:55:17 +0900

DB変更の履歴の作成をトレイトで簡単にEloquentのモデルに装着できるとしたころまでが前回ですが、巷では似たような仕組みでより良いパッケージがすでにあります。今回はそれを紹介します。

Laravel Auditing

パッケージは、Laravel Auditingという名でララベル専用です。

独自のサイトもあります。

http://www.laravel-auditing.com/

まずはインストール、

$ composer require owen-it/laravel-auditing

次に設定ファイルのパブリッシュ。

$ php artisan vendor:publish --provider "OwenIt\Auditing\AuditingServiceProvider" --tag="config"

config/audit.phpが作成されます。

DBテーブルの作成が必要なので、以下を実行してmigrationファイルを作成します。

$ php artisan vendor:publish --provider "OwenIt\Auditing\AuditingServiceProvider" --tag="migrations"

作成されたファイルを見てみましょう。

database/migrations/2020_06_05_152546_create_audits_table.php

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

class CreateAuditsTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::create('audits', function (Blueprint $table) {
            $table->bigIncrements('id');
            $table->string('user_type')->nullable();
            $table->unsignedBigInteger('user_id')->nullable();
            $table->string('event');
            $table->morphs('auditable');
            $table->text('old_values')->nullable();
            $table->text('new_values')->nullable();
            $table->text('url')->nullable();
            $table->ipAddress('ip_address')->nullable();
            $table->string('user_agent', 1023)->nullable();
            $table->string('tags')->nullable();
            $table->timestamps();

            $table->index(['user_id', 'user_type']);
        });
    }

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

これを見ると、作成するDBテーブルの名前はauditsで、 user_type, user_idは、アクセスしたユーザーの情報、 old_valuesとnew_valuesはモデルの古い値と新規の値が入る、 url、ip_address, user_agentはウェブのどこからアクセスされたかの情報、などと検討できますが、その他の項目はどう使われるが興味あるところです。特に、morphs(‘auditable’)の部分はなんでしょう？見たことないですね。

とりあえず、migrateしてテーブルを作成します。

$ php artisan migrate       
Migrating: 2020_06_05_152546_create_audits_table
Migrated:  2020_06_05_152546_create_audits_table (0.04 seconds)

作成されたテーブルの構造を見ると、

mysql> describe audits;
+----------------+---------------------+------+-----+---------+----------------+
| Field          | Type                | Null | Key | Default | Extra          |
+----------------+---------------------+------+-----+---------+----------------+
| id             | bigint(20) unsigned | NO   | PRI | NULL    | auto_increment |
| user_type      | varchar(255)        | YES  |     | NULL    |                |
| user_id        | bigint(20) unsigned | YES  | MUL | NULL    |                |
| event          | varchar(255)        | NO   |     | NULL    |                |
| auditable_type | varchar(255)        | NO   | MUL | NULL    |                |
| auditable_id   | bigint(20) unsigned | NO   |     | NULL    |                |
| old_values     | text                | YES  |     | NULL    |                |
| new_values     | text                | YES  |     | NULL    |                |
| url            | text                | YES  |     | NULL    |                |
| ip_address     | varchar(45)         | YES  |     | NULL    |                |
| user_agent     | varchar(1023)       | YES  |     | NULL    |                |
| tags           | varchar(255)        | YES  |     | NULL    |                |
| created_at     | timestamp           | YES  |     | NULL    |                |
| updated_at     | timestamp           | YES  |     | NULL    |                |
+----------------+---------------------+------+-----+---------+----------------+

$table->morphs(‘auditable’);は、auditable_typeとauditable_idの２つの項目が作成される結果となっていますが、何の値が入るのでしょうね。

モデルでの設定

さて、実際にモデルに設定してみましょう。私の仕組みと同様にトレイト(Auditable)を使用しますが、同じ名前のインターフェース(Auditable)も使われています。以下の「これが必要！」の部分です。

app/User.php

namespace App;

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

use OwenIt\Auditing\Contracts\Auditable; // これが必要！

class User extends Authenticatable implements Auditable　// これが必要！
{
    use Notifiable;
    use \OwenIt\Auditing\Auditable; // これが必要！

    /**
     * The attributes that are mass assignable.
     *
     * @var array
     */
    protected $fillable = [
        'name', 'email', 'password',
    ];

    /**
     * The attributes that should be hidden for arrays.
     *
     * @var array
     */
    protected $hidden = [
        'password', 'remember_token',
    ];

    /**
     * The attributes that should be cast to native types.
     *
     * @var array
     */
    protected $casts = [
        'email_verified_at' => 'datetime',
    ];

    /**
     * ここで監査したい項目を指定！
     *
     * @var array
     */
    protected $auditInclude = [
        'name',
        'email',
    ];

早速、tinkerで実行してみましょう。 tinkerはコンソールの実行なので、設定ファイルを以下のように変更する必要あります。

config/audit.php

...
   /*
    |--------------------------------------------------------------------------
    | Audit Console
    |--------------------------------------------------------------------------
    |
    | Whether console events should be audited (eg. php artisan db:seed).
    |
    */

    'console' => true,
];

Psy Shell v0.10.4 (PHP 7.2.16 — cli) by Justin Hileman
>>> User::truncate(); //　リセットして空にします。
>>> $user = User::create(['name' => 'name1', 'email' => 'test1@example.com', 'password' => 'test']);
[!] Aliasing 'User' to 'App\User' for this Tinker session.
=> App\User {#3995
     name: "name1",
     email: "test1@example.com",
     updated_at: "2020-06-05 17:01:38",
     created_at: "2020-06-05 17:01:38",
     id: 1,
   }
>>> $user->update(['email' => 'test2@example.com']);
=> true
>>> $user->audits; // 作成した監査レコードを取得
=> Illuminate\Database\Eloquent\Collection {#4005
     all: [
       OwenIt\Auditing\Models\Audit {#4021
         id: 1,
         user_type: null,
         user_id: null,
         event: "created",
         auditable_type: "App\User",
         auditable_id: 1,
         old_values: "[]",
         new_values: "{"name":"name1","email":"test1@example.com"}",
         url: "console",
         ip_address: "127.0.0.1",
         user_agent: "Symfony",
         tags: null,
         created_at: "2020-06-05 17:01:38",
         updated_at: "2020-06-05 17:01:38",
       },
       OwenIt\Auditing\Models\Audit {#4026
         id: 2,
         user_type: null,
         user_id: null,
         event: "updated",
         auditable_type: "App\User",
         auditable_id: 1,
         old_values: "{"email":"test1@example.com"}",
         new_values: "{"email":"test2@example.com"}",
         url: "console",
         ip_address: "127.0.0.1",
         user_agent: "Symfony",
         tags: null,
         created_at: "2020-06-05 17:01:43",
         updated_at: "2020-06-05 17:01:43",
       },
     ],
   }

なるほど、

         auditable_type: "App\User",
         auditable_id: 1,

これらの項目には、何のモデルのどのレコードの履歴という情報を残しているのですね。

引き続いて、レコード削除も試みると、

>>> $user->delete();
=> true
>>> DB::table('audits')->get();
=> Illuminate\Support\Collection {#3986
     all: [
       {#4019
         +"id": 1,
         +"user_type": null,
         +"user_id": null,
         +"event": "created",
         +"auditable_type": "App\User",
         +"auditable_id": 1,
         +"old_values": "[]",
         +"new_values": "{"name":"name1","email":"test1@example.com"}",
         +"url": "console",
         +"ip_address": "127.0.0.1",
         +"user_agent": "Symfony",
         +"tags": null,
         +"created_at": "2020-06-05 17:01:38",
         +"updated_at": "2020-06-05 17:01:38",
       },
       {#4025
         +"id": 2,
         +"user_type": null,
         +"user_id": null,
         +"event": "updated",
         +"auditable_type": "App\User",
         +"auditable_id": 1,
         +"old_values": "{"email":"test1@example.com"}",
         +"new_values": "{"email":"test2@example.com"}",
         +"url": "console",
         +"ip_address": "127.0.0.1",
         +"user_agent": "Symfony",
         +"tags": null,
         +"created_at": "2020-06-05 17:01:43",
         +"updated_at": "2020-06-05 17:01:43",
       },
       {#4032
         +"id": 3,
         +"user_type": null,
         +"user_id": null,
         +"event": "deleted",
         +"auditable_type": "App\User",
         +"auditable_id": 1,
         +"old_values": "{"name":"name1","email":"test2@example.com"}",
         +"new_values": "[]",
         +"url": "console",
         +"ip_address": "127.0.0.1",
         +"user_agent": "Symfony",
         +"tags": null,
         +"created_at": "2020-06-05 17:04:27",
         +"updated_at": "2020-06-05 17:04:27",
       },
     ],
   }

削除されたレコードゆえにUser::find()では取得できないので、クエリビルダーで取得しましたが、３番目のauditsのレコードが作成されていること確認できます。また、eventの項目に注目してもらうと、created, updated, deletedという値が入っていることも確認できます。

今回はここまでですが、他にもタグを追加できる機能や、古いレコードを自動的に削除する機能など将来紹介したい機能がたくさんあります。また、クラス定義のインターフェイス、つまり、implementsや、よく知らないmorphsのトピックも将来扱いたいです。