【PHP8.x】unpack関数の使い方

Copy
1<?php
2
3/**
4 * バイナリ文字列からデータを抽出し、それを個別の変数に展開する例。
5 * unpack関数はバイナリデータをPHPの配列に変換し、
6 * extract関数はその配列のキーを元にローカル変数を作成します。
7 *
8 * PHP 8 での unpack 関数の基本的な使用法と、その結果を変数として扱う方法を示します。
9 */
10function demonstrateUnpackAndExtract(): void
11{
12    // pack関数を使って、unpackで処理するためのバイナリ文字列を作成します。
13    // 's' は符号付きショート整数 (16ビット)、'l' は符号付きロング整数 (32ビット) を表します。
14    // 'a*' は残りのバイト全てを文字列として読み込みます。
15    $binaryString = pack('slA*', 12345, 987654321, 'Hello PHP!');
16
17    echo "元のバイナリ文字列の長さ: " . strlen($binaryString) . "バイト\n";
18
19    // unpack関数を使用してバイナリ文字列を連想配列に変換します。
20    // 各フォーマットコードにはキー名を付けています ('short_val', 'long_val', 'message')。
21    // unpackの戻り値はarray|falseなので、エラーチェックも推奨されますが、
22    // この例では成功を前提としています。
23    $unpackedData = unpack('sshort_val/llong_val/A*message', $binaryString);
24
25    if ($unpackedData === false) {
26        echo "unpackに失敗しました。\n";
27        return;
28    }
29
30    echo "\n--- unpack後の配列の内容 ---\n";
31    print_r($unpackedData);
32
33    // extract関数を使って、$unpackedData配列のキーを基にローカル変数を作成します。
34    // 例えば、$unpackedData['short_val'] は $short_val 変数になります。
35    // EXTR_OVERWRITE は、既存の変数を上書きすることを指定します。
36    // 通常、extractの使用は慎重に行うべきですが、この例ではデモンストレーションのために使用します。
37    extract($unpackedData, EXTR_OVERWRITE);
38
39    echo "\n--- extract後の変数アクセス ---\n";
40    // extractによって作成された変数に直接アクセスします。
41    echo "Short Value: " . $short_val . " (型: " . gettype($short_val) . ")\n";
42    echo "Long Value: " . $long_val . " (型: " . gettype($long_val) . ")\n";
43    echo "Message: " . $message . " (型: " . gettype($message) . ")\n";
44
45    // 変数が存在することを確認
46    echo "\n--- 変数の存在確認 ---\n";
47    echo "Is \$short_val set? " . (isset($short_val) ? 'Yes' : 'No') . "\n";
48    echo "Is \$long_val set? " . (isset($long_val) ? 'Yes' : 'No') . "\n";
49    echo "Is \$message set? " . (isset($message) ? 'Yes' : 'No') . "\n";
50}
51
52// 関数の実行
53demonstrateUnpackAndExtract();
54
55?>

このサンプルコードは、PHPのunpack関数とextract関数を組み合わせ、バイナリ文字列からデータを抽出し、それをPHPの扱いやすい個別の変数として利用する方法を示しています。

unpack関数は、バイナリ文字列（コンピュータが直接理解する形式のデータ）を、PHPの連想配列に変換する際に使用します。引数$formatでバイナリデータの形式（例えば、符号付きショート整数はs、文字列はA*）と各データに割り当てるキー名を指定し、$stringで変換したいバイナリ文字列を渡します。$offsetはデータの読み込みを開始する位置です。成功するとデータが格納された配列を返し、失敗するとfalseを返します。サンプルでは、pack関数で作成したバイナリデータから、指定した形式（s、l、A*）に基づいてshort_val、long_val、messageというキーを持つ配列を生成しています。

次にextract関数は、このunpackで得られた連想配列のキーを基に、同じ名前のローカル変数を新しく作成します。例えば、$unpackedData['short_val']という配列要素は$short_valという変数として直接アクセスできるようになります。引数$arrayに展開したい配列を渡し、$flagsで既存の変数との衝突時の挙動などを指定できます（例: EXTR_OVERWRITEは既存の変数を上書きします）。

この一連の処理により、複雑なバイナリデータをPHPのプログラム内で簡単に扱えるようになり、システム開発において様々な場面で活用することができます。

Copy
1<?php
2
3/**
4 * unpack() 関数を使用してバイナリ文字列から連想配列を生成する例。
5 *
6 * この関数は、バイナリデータ（例: ネットワークパケット、ファイルヘッダーなど）を
7 * 読みやすいPHPの連想配列に変換する際に役立ちます。
8 * フォーマット文字列でフィールド名とデータ型を指定することで、
9 * 結果が連想配列として返されます。
10 */
11function demonstrateUnpackAssociativeArray(): void
12{
13    // 例として、2つのバイトからなるバイナリデータを定義します。
14    // \x01 は10進数の1、\x0A は10進数の10に相当します。
15    $binaryData = "\x01\x0A"; // データ例: 'タイプ' = 1, '長さ' = 10
16
17    // unpack() 関数のフォーマット文字列を定義します。
18    // 'Ctype' は最初のバイトを符号なし文字(C)として読み込み、そのキー名を 'type' とします。
19    // 'Clength' は次のバイトを符号なし文字(C)として読み込み、そのキー名を 'length' とします。
20    // スラッシュ '/' は各フィールドの区切り文字として機能します。
21    // この命名規則により、unpack() は結果を連想配列として返します。
22    $format = 'Ctype/Clength';
23
24    // unpack() 関数を呼び出し、バイナリデータを連想配列に変換します。
25    // 第1引数: フォーマット文字列（キー名とデータ型を指定）
26    // 第2引数: 解析対象のバイナリ文字列
27    $unpackedData = unpack($format, $binaryData);
28
29    // unpack() が失敗した場合（例: 不正なフォーマット文字列、データ不足など）は false を返します。
30    if ($unpackedData === false) {
31        echo "エラー: unpack() に失敗しました。" . PHP_EOL;
32    } else {
33        // 成功した場合、結果は連想配列として取得されます。
34        // この例では、['type' => 1, 'length' => 10] となります。
35        print_r($unpackedData);
36    }
37}
38
39// 関数を実行して、unpack() の結果を表示します。
40demonstrateUnpackAssociativeArray();

PHPのunpack関数は、バイナリ形式のデータ（例えばネットワーク通信のパケットやファイルヘッダーなど）を、PHPで扱いやすい連想配列の形に変換する際に使用されます。

この関数は、主に3つの引数を取ります。第1引数$formatは、バイナリデータのどの部分を、どのようなデータ型で、どのようなキー名で読み込むかを指定する「フォーマット文字列」です。この文字列でスラッシュ（/）を用いてキー名を指定することで、結果が連想配列として返されます。サンプルコードの'Ctype/Clength'では、最初のバイトをtype、次のバイトをlengthというキー名でそれぞれ符号なし文字（C）として読み込むことを指示しています。第2引数$stringは解析対象となるバイナリデータそのもので、サンプルコードでは"\x01\x0A"という2バイトのデータが使用されています。第3引数$offsetは省略可能で、指定した場合、バイナリデータのどの位置から読み取りを開始するかをバイト単位で指定できます。

unpack関数は、処理が成功すると、フォーマット文字列で指定されたキー名と変換された値を持つ連想配列を返します。例えば、サンプルコードでは['type' => 1, 'length' => 10]のような結果が得られます。もしフォーマット文字列に誤りがあるなど、処理に失敗した場合はfalseが返されますので、結果がfalseでないかをチェックすることが重要です。この機能は、外部システムとの連携でバイナリデータを扱う際に非常に役立ちます。