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

Copy
1<?php
2
3/**
4 * PHPのextract()関数と関連する定数EXTR_PREFIX_SAME、EXTR_PREFIX_ALLの挙動を実演します。
5 * システムエンジニアを目指す初心者の方にも理解しやすいように、具体的な例を通じて説明します。
6 */
7function demonstrateExtractConstants(): void
8{
9    // 元になる連想配列を用意します。この配列のキーが変数名になり、値が変数の値になります。
10    $data = [
11        'name' => 'Alice',
12        'age'  => 30,
13        'city' => 'New York',
14    ];
15
16    echo "--- 1. extract() 定数なしの場合 (デフォルトの動作) ---\n";
17    // デフォルトでは、extract()関数は既存の変数名と衝突した場合に、その変数を上書きします。
18    // まず、衝突する可能性のある既存の変数を定義します。
19    $name = 'Bob';
20    $age  = 25;
21
22    echo "extract() 実行前:\n";
23    echo "  \$name: '{$name}' (既存)\n";
24    echo "  \$age: {$age} (既存)\n";
25    echo "  \$city: (未定義)\n";
26    echo "元データ: " . json_encode($data) . "\n\n";
27
28    // 配列$dataのキーを変数として現在のスコープにインポートします。
29    // 既存の$nameと$ageは上書きされます。
30    extract($data);
31
32    echo "extract() 実行後:\n";
33    echo "  \$name: '{$name}' (配列の値で上書きされました)\n";
34    echo "  \$age: {$age} (配列の値で上書きされました)\n";
35    echo "  \$city: '{$city}' (新しく作成されました)\n";
36    echo "-----------------------------------------------------\n\n";
37
38    // 次の例に影響を与えないように、作成された変数を削除します。
39    unset($name, $age, $city);
40
41    echo "--- 2. EXTR_PREFIX_SAME の使用例 ---\n";
42    // EXTR_PREFIX_SAME定数は、既存の変数名と衝突する場合にのみ、指定したプレフィックスを付けて新しい変数を作成します。
43    // 既存の変数は上書きされません。
44    $name   = 'Charlie'; // 既存の $name (衝突)
45    $age    = 35;        // 既存の $age (衝突)
46    $country = 'USA';    // 既存の $country (配列にはない)
47    $prefix = 'my';      // 変数名が衝突した場合に付与するプレフィックス
48
49    echo "extract() 実行前:\n";
50    echo "  \$name: '{$name}' (既存)\n";
51    echo "  \$age: {$age} (既存)\n";
52    echo "  \$country: '{$country}' (既存)\n";
53    echo "  \$city: (未定義)\n";
54    echo "元データ: " . json_encode($data) . "\n";
55    echo "使用するプレフィックス: '{$prefix}'\n\n";
56
57    // EXTR_PREFIX_SAME とプレフィックスを指定してextract()を実行します。
58    extract($data, EXTR_PREFIX_SAME, $prefix);
59
60    echo "extract() 実行後 (EXTR_PREFIX_SAME を使用):\n";
61    // $nameと$ageは既存の変数と衝突したため、既存の変数はそのまま残り、
62    // プレフィックスが付いた新しい変数が作成されます。
63    echo "  \$name: '{$name}' (既存のまま。上書きされませんでした)\n";
64    echo "  \$age: {$age} (既存のまま。上書きされませんでした)\n";
65    // $my_nameと$my_ageが新しく作成されました。
66    echo "  \$my_name: " . (isset($my_name) ? "'{$my_name}'" : '(未定義)') . " (新しく作成されました)\n";
67    echo "  \$my_age: " . (isset($my_age) ? $my_age : '(未定義)') . " (新しく作成されました)\n";
68    // $cityは既存の変数と衝突しなかったため、プレフィックスなしで作成されます。
69    echo "  \$city: " . (isset($city) ? "'{$city}'" : '(未定義)') . " (新しく作成されました)\n";
70    // $countryは配列$dataに存在しないため、変化しません。
71    echo "  \$country: " . (isset($country) ? "'{$country}'" : '(未定義)') . " (既存のまま)\n";
72    echo "-----------------------------------------------------\n\n";
73
74    // 次の例に影響を与えないように、作成された変数を削除します。
75    unset($name, $age, $city, $country, $my_name, $my_age);
76
77    echo "--- 3. EXTR_PREFIX_ALL の使用例 ---\n";
78    // EXTR_PREFIX_ALL定数は、配列の全てのキーに対して、指定したプレフィックスを付けて新しい変数を作成します。
79    // 既存の変数は上書きされません。
80    $name   = 'David'; // 既存の $name
81    $age    = 40;      // 既存の $age
82    $prefix = 'user';  // 全ての変数に付与するプレフィックス
83
84    echo "extract() 実行前:\n";
85    echo "  \$name: '{$name}' (既存)\n";
86    echo "  \$age: {$age} (既存)\n";
87    echo "  \$city: (未定義)\n";
88    echo "元データ: " . json_encode($data) . "\n";
89    echo "使用するプレフィックス: '{$prefix}'\n\n";
90
91    // EXTR_PREFIX_ALL とプレフィックスを指定してextract()を実行します。
92    extract($data, EXTR_PREFIX_ALL, $prefix);
93
94    echo "extract() 実行後 (EXTR_PREFIX_ALL を使用):\n";
95    // 既存の$nameと$ageは上書きされず、そのまま残ります。
96    echo "  \$name: '{$name}' (既存のまま。上書きされませんでした)\n";
97    echo "  \$age: {$age} (既存のまま。上書きされませんでした)\n";
98    // 配列$dataの全てのキーに対してプレフィックスが付与され、新しい変数が作成されます。
99    echo "  \$user_name: " . (isset($user_name) ? "'{$user_name}'" : '(未定義)') . " (新しく作成されました)\n";
100    echo "  \$user_age: " . (isset($user_age) ? $user_age : '(未定義)') . " (新しく作成されました)\n";
101    echo "  \$user_city: " . (isset($user_city) ? "'{$user_city}'" : '(未定義)') . " (新しく作成されました)\n";
102    echo "-----------------------------------------------------\n\n";
103
104    // 次の処理に影響を与えないように、作成された変数を削除します。
105    unset($name, $age, $user_name, $user_age, $user_city);
106}
107
108// 関数を実行して、extract()関数の動作を確認します。
109demonstrateExtractConstants();

PHPのextract()関数は、連想配列のキーを基に変数を作成し、配列の値をその変数の値として現在のスコープにインポートする機能を提供します。この関数は、第一引数に連想配列、第二引数にオプションの定数（デフォルトはEXTR_OVERWRITE）、第三引数にプレフィックス文字列（第二引数でプレフィックス関連の定数を指定した場合）を取ります。戻り値は、作成された変数または上書きされた変数の数を整数値で返します。

extract()関数のデフォルトの挙動では、配列のキーと同じ名前の変数が既に存在する場合、既存の変数を上書きしてしまいます。

これに対し、EXTR_PREFIX_SAME定数を使用すると、既存の変数名と衝突する場合にのみ、指定したプレフィックスを付けて新しい変数が作成されます。この際、既存の変数は上書きされず、元の値が保持されます。配列内に既存の変数名と衝突しないキーがあった場合は、プレフィックスなしで新しい変数が作成されます。

一方、EXTR_PREFIX_ALL定数を指定すると、配列の全てのキーに対して、指定したプレフィックスを付けて新しい変数が作成されます。この場合も、既存の変数は上書きされずに保持されます。これらの定数を適切に利用することで、意図しない変数の上書きを防ぎながら、連想配列のデータを柔軟に変数値として扱うことが可能になります。

Copy
1<?php
2
3/**
4 * EXTR_PREFIX_SAME 定数を使用した extract() 関数の動作例を示します。
5 *
6 * この定数は、extract() 関数で配列から変数をインポートする際、
7 * 既存のスコープ内の変数名と配列のキー名が同じ場合に、
8 * 新しい変数に指定されたプレフィックスを付けて、
9 * 既存の変数を上書きしないようにする働きがあります。
10 *
11 * ここでは、PHPの拡張ディレクトリ (`extension_dir`) を含む
12 * 複数の設定値が既存の変数と衝突するシナリオを想定しています。
13 */
14function demonstrateExtractPrefixSame(): void
15{
16    // シミュレーション用の既存の変数
17    // これらの変数は、extract()で展開される配列のキーと名前が衝突する可能性があります。
18    $appName = 'LegacyApp';
19    // PHPの拡張ディレクトリ（extension_dir）のような設定パスを既存変数として用意
20    $extensionDir = '/etc/php/7.4/mods-available'; 
21    $baseDir = '/var/www/html/legacy';
22
23    echo "--- extract() 実行前の変数状態 ---\n";
24    echo "  \$appName: " . $appName . "\n";
25    echo "  \$extensionDir: " . $extensionDir . "\n";
26    echo "  \$baseDir: " . $baseDir . "\n";
27    echo "  \$logLevel: " . (isset($logLevel) ? $logLevel : '未定義') . "\n";
28    echo "\n";
29
30    // 新しい設定値を保持する配列
31    $newConfig = [
32        'appName' => 'ModernApp',
33        // 新しい拡張ディレクトリのパスを含む設定
34        'extensionDir' => '/usr/lib/php/20210902', 
35        'baseDir' => '/var/www/html/modern',
36        'logLevel' => 'DEBUG', // 既存の変数と衝突しないキー
37    ];
38
39    // EXTR_PREFIX_SAME とプレフィックスを指定して extract() を実行
40    // 既存の変数と衝突するキーには 'new_' プレフィックスが付けられます。
41    // 衝突しないキーは通常通り展開されます。
42    $prefix = 'new_';
43    extract($newConfig, EXTR_PREFIX_SAME, $prefix);
44
45    echo "--- extract() (EXTR_PREFIX_SAME 使用) 実行後の変数状態 ---\n";
46    echo "  \$appName: " . $appName . " (既存の変数は上書きされず保持)\n";
47    echo "  \$extensionDir: " . $extensionDir . " (既存の変数は上書きされず保持)\n";
48    echo "  \$baseDir: " . $baseDir . " (既存の変数は上書きされず保持)\n";
49    echo "  \$logLevel: " . $logLevel . " (衝突しないため新しい変数が作成される)\n";
50    echo "  \$new_appName: " . $new_appName . " (衝突したキーにプレフィックスが付き、新しい変数が作成される)\n";
51    echo "  \$new_extensionDir: " . $new_extensionDir . " (衝突したキーにプレフィックスが付き、新しい変数が作成される)\n";
52    echo "  \$new_baseDir: " . $new_baseDir . " (衝突したキーにプレフィックスが付き、新しい変数が作成される)\n";
53}
54
55// 関数の実行
56demonstrateExtractPrefixSame();

PHPのEXTR_PREFIX_SAME定数は、extract()関数を使って配列から変数を生成する際に役立つオプションです。この定数を使用すると、配列のキー名と同じ名前の変数が現在のスコープに既に存在する場合でも、既存の変数を上書きせずに、指定したプレフィックスを付けて新しい変数として値を展開できます。これにより、既存の重要な設定値などを保護しながら、新しい設定を安全に取り込むことが可能です。

extract()関数は、第一引数に変数を生成したい配列を、第二引数にEXTR_PREFIX_SAMEのような振る舞いを定義する定数を、そして第三引数に衝突時に付与するプレフィックス文字列を受け取ります。戻り値は整数値ですが、この関数の主な役割は配列のキーを基に変数を生成することにあります。

サンプルコードでは、既に存在する$appNameやPHPのextensionDir設定パスのような変数がある状態で、同名のキーを持つ新しい設定配列$newConfigから変数を展開するシナリオを示しています。EXTR_PREFIX_SAMEとプレフィックス「new_」を指定してextract()を実行すると、既存の$appNameや$extensionDirは上書きされず元の値のまま保持されます。その代わりに、衝突したキーは「$new_appName」や「$new_extensionDir」のように、プレフィックスが付けられた新しい変数として配列の値が展開されます。一方、$logLevelのように既存の変数と衝突しないキーは、そのまま「$logLevel」として新しい変数が作成されます。これにより、システムの安全性を確保しつつ、柔軟な変数管理を実現できます。