[Laravel] arrayデータのheader行を省略して書く
Tech※ 本記事はアフィリエイト広告(Amazonアソシエイト)を含みます。
初期値だったりデータ流し込みだったり、Sitemap的なやつだったり、結構名前付きのArrayを書くことが多いと思うんだけど、毎回name指定するの面倒だよねっていうときに。
普通に書くとこうなる
$array = [
['id' => 1, 'name' => 'one', 'description' => 'hogehoge'],
['id' => 2, 'name' => 'two', 'description' => 'hogehoge'],
// ...行が増えるたびに 'id' => 'name' => を書く
];
行数が増えるほど、キー名の繰り返しで横に長くなって読みにくい。キー名を1か所変えたいときも、全行を直すことになります。
ヘッダー行を分けて combine する
Laravel の Illuminate\Support\Collection の恩恵。
$header = collect(['id', 'name', 'description']);
$values = collect([
[1, 'one', 'hogehoge'],
[2, 'two', 'hogehoge'],
]);
$array = $values->map(fn ($col) => $header->combine($col))->toArray();
combine() は「自分の値をキーに、引数の値を値にした」コレクションを作るメソッドです。
// 結果
[
['id' => 1, 'name' => 'one', 'description' => 'hogehoge'],
['id' => 2, 'name' => 'two', 'description' => 'hogehoge'],
]
キー名は $header の1か所だけ。表を書くような感覚でデータを並べられます。
PHP 7.4 より前の場合
尚、fn () => のアロー関数は PHP 7.4 以降で。それ以前の場合はこう。
$array = $values->map(
function ($value) use ($header) {
return $header->combine($value);
}
)->toArray();
Laravel を使わない場合
素の PHP でも array_combine() で同じことができます。
$header = ['id', 'name', 'description'];
$rows = [
[1, 'one', 'hogehoge'],
[2, 'two', 'hogehoge'],
];
$array = array_map(fn ($row) => array_combine($header, $row), $rows);
使いどころ
シーダー
初期データの投入にちょうど良いです。
DB::table('categories')->insert($array);
CSV の読み込み
1行目がヘッダーの CSV なら、そのまま $header として使えます。
$rows = array_map('str_getcsv', file(storage_path('app/data.csv'), FILE_IGNORE_NEW_LINES));
$header = collect(array_shift($rows));
$array = collect($rows)->map(fn ($row) => $header->combine($row))->toArray();
注意点
(当然ながら、header行と数ズレてると動かないし、Arrayになるのでオブジェクトではないよっていう)
- 列数がずれると失敗する: 素の
array_combine()は、PHP 8 以降だと要素数が違うとValueErrorを投げます。CSV に空行が混ざっていると引っかかるので、先に空行を除いておくと安全 - 結果は連想配列:
->toArray()で返すのは配列です。$row->nameのようにオブジェクトとして扱いたいならtoArray()を外して Collection のまま使うか、モデルに詰め替えます
まとめ
- キー名は
$headerに1回だけ書き、combine()で各行と組み合わせる - PHP 7.4 以降ならアロー関数で1行
- Laravel なしなら
array_combine()、PHP 8 では列数のずれに注意
参考リンク
Laravel, php