【PHP8.x】EXTR_OVERWRITE定数の使い方

Copy
1<?php
2
3/**
4 * EXTR_OVERWRITE 定数の動作を示すサンプルコード。
5 *
6 * EXTR_OVERWRITE は extract() 関数のデフォルトのフラグであり、
7 * 配列のキーを変数として現在のシンボルテーブルにインポートする際に、
8 * 既存の変数を上書きすることを示します。
9 *
10 * @see https://www.php.net/manual/ja/function.extract.php
11 */
12function demonstrate_extr_overwrite_behavior(): void
13{
14    // extract() 実行前に定義されている変数
15    $product_id = 100;
16    $product_name = "既存の製品";
17
18    echo "--- extract() 実行前 ---" . PHP_EOL;
19    echo "product_id: " . $product_id . PHP_EOL;
20    echo "product_name: " . $product_name . PHP_EOL;
21    // product_price はこの時点では未定義
22
23    // extract() で展開する配列
24    $data = [
25        'product_id' => 200,            // 既存の $product_id を上書きするキー
26        'product_name' => '新しい製品',    // 既存の $product_name を上書きするキー
27        'product_price' => 99.99,       // 新しい変数として追加されるキー
28    ];
29
30    echo PHP_EOL . "--- extract(\$data, EXTR_OVERWRITE) 実行後 ---" . PHP_EOL;
31
32    // extract() 関数を EXTR_OVERWRITE フラグ（デフォルトの動作）で呼び出します。
33    // このフラグは、配列のキーと同じ名前の変数がスコープ内に既に存在する場合、
34    // その変数の値を配列の値で上書きするように指示します。
35    extract($data, EXTR_OVERWRITE);
36
37    // 展開された変数の値を確認
38    // 既存の $product_id と $product_name は上書きされています
39    echo "product_id: " . $product_id . PHP_EOL;
40    echo "product_name: " . $product_name . PHP_EOL;
41    // 新しい変数 $product_price が追加されています
42    echo "product_price: " . $product_price . PHP_EOL;
43
44    // EXTR_OVERWRITE 定数の値も確認できます (int型)
45    echo PHP_EOL . "EXTR_OVERWRITE 定数の値: " . EXTR_OVERWRITE . PHP_EOL;
46}
47
48// 関数を実行
49demonstrate_extr_overwrite_behavior();

EXTR_OVERWRITEは、PHP 8で利用できる組み込み定数の一つです。この定数は、主にextract()関数と組み合わせて使用され、配列のキーを現在のプログラムのスコープに変数をとしてインポートする際の動作を制御します。

具体的には、EXTR_OVERWRITEはextract()関数に渡せるフラグの一つで、配列内のキーと同じ名前の変数が既にスコープ内に存在する場合、その既存の変数の値を配列の値で「上書きする」ように指示します。もし配列のキーが既存の変数名と重複しない場合は、新しい変数が現在のスコープに作成されます。この「上書き」と「新規作成」の動作は、extract()関数のデフォルトの挙動でもあります。

この定数自体は引数を持ちませんが、内部的には整数型（int）の値を返します。サンプルコードでは、product_idやproduct_nameといった元々定義されていた変数が、extract()実行後に配列$data内の対応する値で更新される様子が示されています。また、配列にのみ存在したproduct_priceというキーは、新しい変数として追加されています。このように、EXTR_OVERWRITEは配列のデータを効率的に個別の変数として利用し、必要に応じて既存の値を更新する際に役立ちます。