Laravel Excel on ララジャパン

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

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