【PHP8.x】SplFixedArray::fromArray()メソッドの使い方

Copy
1<?php
2
3/**
4 * Excelから読み込んだデータを模倣し、SplFixedArray::fromArray() を使用して
5 * 通常のPHP配列をSplFixedArrayに変換するサンプルコードです。
6 *
7 * SplFixedArrayは、事前にサイズが固定される配列オブジェクトで、
8 * 特に大量のデータセットを扱う際に、通常のPHP配列に比べてメモリ効率が良い場合があります。
9 * ExcelのデータをPHPで処理する際などに応用できます。
10 * この例では、PHP 8 の機能に準拠しています。
11 */
12function demonstrateSplFixedArrayFromExcelData(): void
13{
14    // Excelから読み込んだデータを想定した多次元配列を定義します。
15    // 各内部配列がExcelの1行に相当し、通常、CSVファイルやExcelライブラリから
16    // 取得したデータはこのような形式になります。
17    $excelData = [
18        ['ID', '商品名', '価格'],
19        [101, 'キーボード', 3500],
20        [102, 'マウス', 1800],
21        [103, 'モニター', 15000],
22    ];
23
24    echo "--- 元のPHP配列の内容 ---" . PHP_EOL;
25    print_r($excelData);
26    echo PHP_EOL;
27
28    // SplFixedArray::fromArray() メソッドを使って、
29    // 上記のPHP配列をSplFixedArrayオブジェクトに変換します。
30    // 第1引数に変換元の配列を渡し、第2引数 $preserveKeys はデフォルトで true です。
31    // この引数は、元の配列のキーを保持するかどうかを決定しますが、
32    // 今回のような数値インデックスの多次元配列では、SplFixedArrayも0から始まる
33    // 数値インデックスになるため、この引数の影響はほとんどありません。
34    $fixedArray = SplFixedArray::fromArray($excelData);
35
36    echo "--- SplFixedArray に変換後の内容 (print_r) ---" . PHP_EOL;
37    // print_rでSplFixedArrayオブジェクトを表示すると、その構造が確認できます。
38    // SplFixedArrayは固定長（ここでは4要素）で、各要素は元のPHP配列のサブ配列（array型）がコピーされています。
39    print_r($fixedArray);
40    echo PHP_EOL;
41
42    echo "--- SplFixedArray の要素をループで表示 ---" . PHP_EOL;
43    // SplFixedArrayはイテレート可能なので、foreachやforループで要素にアクセスできます。
44    // ここで取得される各行（$rowData）は元のPHP配列のままで、SplFixedArrayには変換されません。
45    foreach ($fixedArray as $rowIndex => $rowData) {
46        echo "行 " . ($rowIndex + 1) . ": ";
47        // $rowData はPHPの通常の配列型です。
48        foreach ($rowData as $colIndex => $cellData) {
49            echo "[" . $colIndex . "] " . $cellData . "\t";
50        }
51        echo PHP_EOL;
52    }
53}
54
55// 関数を実行してサンプルコードの動作を確認します。
56demonstrateSplFixedArrayFromExcelData();
57
58?>

このPHPのサンプルコードは、SplFixedArray::fromArray()メソッドの利用方法を説明します。SplFixedArrayは、事前にサイズが固定される特殊な配列オブジェクトで、通常のPHP配列に比べてメモリ効率が良い特徴を持ちます。特に、大量のデータ、例えばExcelから読み込んだ表形式のデータをPHPで効率的に扱う際に活用できます。

SplFixedArray::fromArray()は、第一引数に与えられた通常のPHP配列を、指定された要素数で固定されたSplFixedArrayオブジェクトに変換するメソッドです。第二引数$preserveKeysは、元の配列のキーを保持するかどうかをブール値で指定しますが、デフォルトでtrueであり、多くの場合そのままで問題ありません。特に数値インデックスの配列の場合、変換後のSplFixedArrayも0から始まる数値インデックスとなります。メソッドの戻り値は、変換されたSplFixedArrayオブジェクトです。

サンプルコードでは、Excelデータを模倣した多次元PHP配列をSplFixedArray::fromArray()で変換し、その内容を表示しています。変換後のSplFixedArrayは固定された要素数を持ち、元の配列の各行がそのまま要素として格納されます。その後、foreachループを使って各要素にアクセスし、データが正しく変換され、効率的なデータ管理が実現可能となることを確認できます。

Copy
1<?php
2
3/**
4 * スプレッドシートのデータを行ごとにSplFixedArrayに変換するサンプルコード。
5 *
6 * SplFixedArrayは固定長の配列で、メモリ効率が良いのが特徴です。
7 * fromArrayメソッドは、通常のPHP配列からSplFixedArrayインスタンスを生成します。
8 * スプレッドシートの各行を固定長の配列として扱う場合に便利です。
9 */
10function processSpreadsheetData(): void
11{
12    // スプレッドシートのデータに見立てた2次元配列を準備します。
13    // 各内部配列がスプレッドシートの1行を表します。
14    $spreadsheetData = [
15        ['商品名', '価格', '数量'], // ヘッダー行
16        ['りんご', 150, 10],
17        ['バナナ', 100, 15],
18        ['みかん', 80, 20],
19    ];
20
21    echo "元のスプレッドシートデータ:\n";
22    foreach ($spreadsheetData as $rowData) {
23        echo implode("\t", $rowData) . "\n";
24    }
25    echo "\n";
26
27    $fixedArrayRows = [];
28
29    // 各行（PHP配列）をSplFixedArray::fromArrayメソッドを使ってSplFixedArrayに変換します。
30    // 第2引数 $preserveKeys はデフォルトでtrueですが、
31    // ここでは数値キーなのでtrue/falseどちらでも同じ結果になります。
32    foreach ($spreadsheetData as $rowIndex => $rowData) {
33        $fixedArrayRows[$rowIndex] = SplFixedArray::fromArray($rowData);
34        echo "行 " . ($rowIndex + 1) . " (SplFixedArray): ";
35        // SplFixedArrayはIteratorインターフェースを実装しているので、foreachでループできます。
36        foreach ($fixedArrayRows[$rowIndex] as $cell) {
37            echo $cell . "\t";
38        }
39        echo "\n";
40    }
41
42    echo "\nSplFixedArrayとして処理されたデータ:\n";
43    // 変換された固定長配列のコレクションを表示
44    foreach ($fixedArrayRows as $rowIndex => $fixedRow) {
45        echo "行 " . ($rowIndex + 1) . " (SplFixedArrayサイズ: " . $fixedRow->getSize() . "): ";
46        foreach ($fixedRow as $cell) {
47            echo $cell . "\t";
48        }
49        echo "\n";
50    }
51}
52
53// 関数を実行します
54processSpreadsheetData();
55
56?>

SplFixedArray::fromArrayメソッドは、PHPの標準的な配列を、固定長配列であるSplFixedArrayのインスタンスに変換するために使用されます。SplFixedArrayは、あらかじめサイズが決まっているデータを扱う際に、メモリ効率が良く、高速なアクセスを可能にする配列です。

このメソッドは、変換したいPHP配列を最初の引数$arrayとして受け取ります。2つ目の引数$preserveKeysはオプションで、デフォルトはtrueです。この引数をtrueに設定すると、元の配列のキーをSplFixedArrayでも保持します。数値キーの配列では、trueでもfalseでも結果に大きな違いはありません。メソッドの戻り値は、変換されたSplFixedArrayのインスタンスです。

サンプルコードでは、スプレッドシートの各行データに見立てた通常のPHP配列を、SplFixedArray::fromArrayメソッドを使ってSplFixedArrayに変換しています。これにより、各行のデータ要素数が固定されるため、データ構造を明確に保ちつつ、メモリを効率的に利用しながらデータ処理を進めることができます。変換されたSplFixedArrayは、foreachループで各要素にアクセスしたり、getSize()メソッドで配列の要素数を取得したりすることが可能です。このメソッドは、スプレッドシートの行やデータベースのレコードのように、構造が固定されたデータを効率的に管理したい場合に非常に有効です。