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

Copy
1<?php
2
3/**
4 * EXTR_IF_EXISTS フラグを使用した extract() 関数の動作を示します。
5 *
6 * EXTR_IF_EXISTS は、extract() 関数が配列から変数をインポートする際、
7 * 既に同名の変数が存在する場合にのみ上書きし、存在しない場合は新しい変数を生成しません。
8 * これは、デフォルトの EXTR_OVERWRITE フラグとは異なる挙動です。
9 */
10function demonstrateExtractIfExists(): void
11{
12    // extract() 実行前に存在する変数を定義します。
13    // $name と $age は既存変数です。
14    $name = '初期太郎';
15    $age = 20;
16    // $city はここでは定義されていません。
17
18    echo "--- extract() 実行前の変数状態 ---" . PHP_EOL;
19    echo "変数 \$name: " . $name . PHP_EOL;
20    echo "変数 \$age: " . $age . PHP_EOL;
21    echo "変数 \$city: " . (isset($city) ? $city : '未定義') . PHP_EOL;
22    echo PHP_EOL;
23
24    // extract() に渡す配列を準備します。
25    $data = [
26        'name' => '花子',  // 既存の $name とキーが一致
27        'age' => 30,        // 既存の $age とキーが一致
28        'city' => '東京'   // 既存の $city は存在しない
29    ];
30
31    echo "--- extract(\$data, EXTR_IF_EXISTS) 実行 ---" . PHP_EOL;
32    // EXTR_IF_EXISTS フラグを指定して extract() を実行します。
33    // 1. $name: 既存変数なので '花子' に上書きされます。
34    // 2. $age: 既存変数なので 30 に上書きされます。
35    // 3. $city: 既存変数ではないため、新しく生成されません。
36    extract($data, EXTR_IF_EXISTS);
37
38    echo "--- extract() 実行後の変数状態 ---" . PHP_EOL;
39    echo "変数 \$name: " . $name . PHP_EOL; // '初期太郎' から '花子' に上書き
40    echo "変数 \$age: " . $age . PHP_EOL;   // 20 から 30 に上書き
41    echo "変数 \$city: " . (isset($city) ? $city : '未定義') . PHP_EOL; // 未定義のまま
42    echo PHP_EOL;
43
44    // 参考: もし EXTR_OVERWRITE (デフォルト) を使用した場合:
45    // extract($data, EXTR_OVERWRITE); // または単に extract($data);
46    // その場合、$name は '花子'、 $age は 30 に上書きされ、
47    // さらに $city は '東京' として新しく定義されます。
48}
49
50// 関数を実行して、EXTR_IF_EXISTS の動作を確認します。
51demonstrateExtractIfExists();

PHPのEXTR_IF_EXISTSは、extract()関数と組み合わせて使用する定数で、配列から変数をインポートする際の挙動を制御します。この定数自体に引数はなく、int型の値を持ちます。

EXTR_IF_EXISTSを指定すると、extract()関数は、インポートしようとしている変数と同じ名前の変数が既に存在する場合にのみ、その変数を配列の値で上書きします。もし同じ名前の変数が存在しない場合は、新しく変数を生成することはありません。これは、デフォルトの動作であるEXTR_OVERWRITE（存在しない変数も新しく生成し、既存変数は上書きする）とは異なります。

サンプルコードでは、まず$nameと$ageという変数を定義し、$cityは未定義のままにします。次に、'name', 'age', 'city'をキーに持つ$data配列を準備します。extract($data, EXTR_IF_EXISTS)を実行すると、$data配列の'name'と'age'は既存の$nameと$ageをそれぞれ'花子'と30に上書きします。しかし、'city'は実行前に$city変数が存在しなかったため、extract()関数は新しい$city変数を生成せず、$cityは未定義のままになります。この動作により、意図せず新しい変数が生成されるのを防ぐことができます。

Copy
1<?php
2
3/**
4 * EXTR_IF_EXISTS 定数を使った extract() 関数の挙動を示すサンプルコードです。
5 *
6 * EXTR_IF_EXISTS は、配列からシンボルテーブルに変数をインポートする際、
7 * 同じ名前の変数が現在のスコープに既に存在する場合にのみその変数を上書きします。
8 * 存在しないキーの変数は新しく作成されません。
9 */
10function demonstrateExtractIfExists(): void
11{
12    echo "--- シナリオ1: 変数が現在のスコープに存在しない場合 ---\n";
13
14    // 抽出元となる配列を定義します。
15    $data1 = [
16        'userName' => 'Alice',
17        'userAge' => 30,
18    ];
19
20    echo "現在のスコープに存在する変数: (なし)\n";
21    echo "抽出元のデータ: ";
22    var_dump($data1);
23
24    // EXTR_IF_EXISTS フラグを指定して extract() を実行します。
25    // 'userName' と 'userAge' は現在のスコープに存在しないため、
26    // 新しい変数として作成されることはありません。
27    extract($data1, EXTR_IF_EXISTS);
28
29    echo "extract() 実行後:\n";
30    // isset() を使って変数が存在するかを確認します。
31    echo "\$userName は存在するか: " . (isset($userName) ? 'はい' : 'いいえ') . "\n"; // いいえ
32    echo "\$userAge は存在するか: " . (isset($userAge) ? 'はい' : 'いいえ') . "\n";   // いいえ
33    echo "\n";
34
35
36    echo "--- シナリオ2: 変数が現在のスコープに既に存在する場合 ---\n";
37
38    // 既に存在する変数を定義します。
39    $productName = 'Laptop';
40    $productPrice = 1200;
41
42    // 抽出元となる配列を定義します。
43    $data2 = [
44        'productName' => 'Smartphone', // 既存の変数と同じ名前
45        'productPrice' => 800,         // 既存の変数と同じ名前
46        'productColor' => 'Black',     // 既存しない新しい変数名
47    ];
48
49    echo "現在のスコープに存在する変数:\n";
50    echo "  \$productName = '$productName'\n";
51    echo "  \$productPrice = $productPrice\n";
52    echo "抽出元のデータ: ";
53    var_dump($data2);
54
55    // EXTR_IF_EXISTS フラグを指定して extract() を実行します。
56    // 'productName' と 'productPrice' は既存するため、配列の値で上書きされます。
57    // 'productColor' は既存しないため、新しい変数として作成されません。
58    extract($data2, EXTR_IF_EXISTS);
59
60    echo "extract() 実行後:\n";
61    echo "\$productName の値: " . (isset($productName) ? $productName : '未定義') . "\n";         // Smartphone
62    echo "\$productPrice の値: " . (isset($productPrice) ? $productPrice : '未定義') . "\n"; // 800
63    echo "\$productColor は存在するか: " . (isset($productColor) ? 'はい' : 'いいえ') . "\n"; // いいえ
64}
65
66// 定数の挙動を示す関数を実行します。
67demonstrateExtractIfExists();
68
69?>

PHP 8で提供されるEXTR_IF_EXISTSは、extract()関数と組み合わせて使用する定数です。この定数自体に引数はなく、整数型（int）の値を持ちます。extract()関数は配列のキーを変数名、値をその変数の値として、現在のスコープにインポートする機能を提供しますが、EXTR_IF_EXISTSを使用することで、その挙動を細かく制御できます。

具体的には、この定数を指定してextract()を実行すると、配列のキーに対応する変数が現在のスコープに「既に存在する場合にのみ」、その変数を配列の値で上書きします。逆に、配列のキーに対応する変数が現在のスコープに「存在しない場合」は、新しい変数を作成しません。

サンプルコードのシナリオ1では、$data1配列のキーであるuserNameやuserAgeに対応する変数が事前に定義されていないため、extract($data1, EXTR_IF_EXISTS)を実行しても、これらの変数は新しく作成されません。

シナリオ2では、$productNameと$productPriceが既にスコープに存在しています。この状態でextract($data2, EXTR_IF_EXISTS)を実行すると、$data2配列内の同名のキーの値（'Smartphone', 800）で既存の変数が上書きされます。しかし、$data2に含まれるproductColorは事前に定義されていないため、この変数は新しく作成されることなく、未定義の状態のままです。このようにEXTR_IF_EXISTSは、意図しない変数の追加を防ぎつつ、既存の変数のみを更新したい場合に役立ちます。