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

<?php

/**
 * 文字列から数値を抽出し、その結果をextract関数で変数としてスコープに展開するサンプル。
 * extract関数自体は文字列から数値を直接抽出する機能はありません。
 * 抽出された数値を格納した配列を、現在のスコープに変数としてインポートします。
 *
 * @param string $inputString 処理する入力文字列
 * @return void
 */
function extractNumbersFromStringAndToScope(string $inputString): void
{
    echo "--- 入力文字列から数値を抽出 ---" . PHP_EOL;
    echo "入力文字列: \"" . $inputString . "\"" . PHP_EOL;

    $extractedData = [];

    // 正規表現を使って文字列から「ID」に続く数値を抽出
    // extract関数は文字列からの直接抽出は行いません。この部分は一般的なPHPの文字列処理です。
    if (preg_match('/ID:\s*(\d+)/', $inputString, $matches)) {
        $extractedData['itemId'] = (int)$matches[1];
        echo "抽出されたID: " . $extractedData['itemId'] . PHP_EOL;
    }

    // 正規表現を使って文字列から「Price」に続く数値を抽出
    if (preg_match('/Price:\s*(\d+\.?\d*)/', $inputString, $matches)) {
        $extractedData['itemPrice'] = (float)$matches[1];
        echo "抽出された価格: " . $extractedData['itemPrice'] . PHP_EOL;
    }

    echo PHP_EOL . "--- 抽出されたデータを配列として確認 ---" . PHP_EOL;
    print_r($extractedData);

    if (empty($extractedData)) {
        echo "抽出できる数値が見つかりませんでした。" . PHP_EOL;
        return;
    }

    echo PHP_EOL . "--- extract関数で配列を現在のスコープに展開 ---" . PHP_EOL;
    // extract関数は、配列のキー（例: 'itemId'）を変数名（例: $itemId）として、
    // 配列の値（例: 101）をその変数の値として、現在のスコープにインポートします。
    // EXTR_OVERWRITE は、同名の変数が既に存在する場合に上書きするデフォルトの挙動です。
    $numberOfVariablesExtracted = extract($extractedData, EXTR_OVERWRITE);

    echo "展開された変数の数: " . $numberOfVariablesExtracted . PHP_EOL;

    echo PHP_EOL . "--- extract関数によって生成された変数を確認 ---" . PHP_EOL;
    // extract関数によって、$itemId や $itemPrice といった変数がこのスコープで利用可能になります。
    if (isset($itemId)) {
        echo "変数 \$itemId: " . $itemId . " (型: " . gettype($itemId) . ")" . PHP_EOL;
    } else {
        echo "変数 \$itemId は展開されませんでした。" . PHP_EOL;
    }

    if (isset($itemPrice)) {
        echo "変数 \$itemPrice: " . $itemPrice . " (型: " . gettype($itemPrice) . ")" . PHP_EOL;
    } else {
        echo "変数 \$itemPrice は展開されませんでした。" . PHP_EOL;
    }
    echo PHP_EOL;
}

// サンプル実行1: IDと価格を含む文字列
extractNumbersFromStringAndToScope("Product details: ID: 101, Name: Laptop, Price: 1299.99 USD.");
echo "---------------------------------------------------" . PHP_EOL;

// サンプル実行2: IDのみ含む文字列
extractNumbersFromStringAndToScope("Order number: 50023, Quantity: 5.");
echo "---------------------------------------------------" . PHP_EOL;

// サンプル実行3: 数値を含まない文字列
extractNumbersFromStringAndToScope("No specific numbers here, just text.");

PHP 8.4のextract関数は、配列に格納されたデータを現在のプログラムのスコープに、新しい変数として展開する機能を提供します。このサンプルコードでは、まず入力文字列から正規表現を用いて「ID」や「Price」などの数値を抽出し、それらを$extractedDataという連想配列に整理しています。

その後、extract関数にこの$extractedData配列を渡すことで、配列のキー（例: 'itemId'）が変数名（例: $itemId）となり、キーに対応する値がその変数の内容として、現在のスコープで直接利用できるようになります。

第一引数には展開したい配列を渡し、第二引数の$flagsには変数名が重複した場合の動作を指定します。サンプルではEXTR_OVERWRITEが使われており、既存の変数は上書きされます。第三引数$prefixを使うと、展開されるすべての変数名に指定した接頭辞を追加できます。関数は、展開された変数の総数を整数（int）で返します。

extract関数自体は文字列から数値を抽出する機能を持たず、あくまで既に用意された配列を、より使いやすい形で変数としてスコープに導入する役割を担います。

<?php

/**
 * PHPのextract関数は、配列のキーを変数として現在のスコープにインポートします。
 * この関数は、テンプレートエンジンなどで配列から複数の変数を一括で作成する際に便利ですが、
 * 変数名の衝突を引き起こす可能性があるため、使用するフラグを理解することが重要です。
 */
function demonstrateExtractUsage(): void
{
    // 1. 配列を定義します。
    $data = [
        'username' => 'Alice',
        'age' => 30,
        'city' => 'New York',
    ];

    echo "--- extract() の基本的な使い方 (EXTR_OVERWRITE - デフォルト) ---\n";
    echo "  既存の変数がない場合、配列のキーがそのまま変数として展開されます。\n";

    // extractを実行し、配列のキーを変数として現在のスコープにインポートします。
    // デフォルトのフラグは EXTR_OVERWRITE で、同名の既存変数があれば上書きします。
    extract($data);

    // インポートされた変数にアクセスします。
    echo "  ユーザー名: " . $username . "\n";
    echo "  年齢: " . $age . "\n";
    echo "  都市: " . $city . "\n\n";

    // 既存の変数を上書きする例を示します。
    // 既に存在する変数 'username' と 'age' を定義します。
    $username = "Bob";
    $age = 25;
    $country = "Japan"; // extract対象外の変数も定義

    echo "--- 既存変数を上書きする挙動 (EXTR_OVERWRITE) ---\n";
    echo "  extract実行前の既存変数: \$username = " . $username . ", \$age = " . $age . ", \$country = " . $country . "\n";

    // $data配列の 'username' と 'age' が既存の変数を上書きします。
    // $city は $data に存在するため、値が 'New York' で上書きされます。(元の値も同じ)
    // $country は $data に存在しないため影響を受けません。
    extract($data, EXTR_OVERWRITE); // EXTR_OVERWRITEはデフォルトのため省略可能ですが、明示的に指定しています。

    echo "  extract実行後の変数: \$username = " . $username . " (Aliceに上書き)\n";
    echo "  extract実行後の変数: \$age = " . $age . " (30に上書き)\n";
    echo "  extract実行後の変数: \$city = " . $city . " (New Yorkのまま)\n";
    echo "  extract実行後の変数: \$country = " . $country . " (Japanのまま)\n\n";

    // 次のデモのために、作成された変数をクリアします。
    unset($username, $age, $city, $country);

    echo "--- 既存変数をスキップする (EXTR_SKIP) ---\n";
    // 既存の変数として 'username' を定義します。
    $username = "Charlie";
    $occupation = "Developer"; // extract対象外の変数も定義

    $data2 = [
        'username' => 'David', // 'username' は既存変数と衝突
        'email' => 'david@example.com',
    ];
    echo "  extract実行前の既存変数: \$username = " . $username . ", \$occupation = " . $occupation . "\n";

    // EXTR_SKIPフラグを使用すると、配列のキーと同名の既存変数がある場合、
    // その変数は上書きされず、配列の値はスキップされます。
    extract($data2, EXTR_SKIP);

    echo "  extract実行後の変数: \$username = " . $username . " (Charlieのまま、Davidはスキップ)\n";
    echo "  extract実行後の変数: \$email = " . $email . " (新しくインポートされた)\n";
    echo "  extract実行後の変数: \$occupation = " . $occupation . " (Developerのまま、影響なし)\n\n";

    // 次のデモのために、作成された変数をクリアします。
    unset($username, $email, $occupation);

    echo "--- 全ての変数にプレフィックスを付ける (EXTR_PREFIX_ALL) ---\n";
    $productData = [
        'id' => 101,
        'name' => 'Laptop',
        'price' => 1200,
    ];
    $prefix = "prod"; // 付与したいプレフィックスを定義します

    // EXTR_PREFIX_ALLフラグを使用すると、すべてのインポートされる変数名に
    // 指定したプレフィックスがアンダースコア (_) を介して付与されます。
    // これにより、変数名の衝突を安全に回避できます。
    extract($productData, EXTR_PREFIX_ALL, $prefix);

    echo "  商品ID: " . $prod_id . "\n";
    echo "  商品名: " . $prod_name . "\n";
    echo "  商品価格: " . $prod_price . "\n\n";

    // 最後に、extract関数の戻り値を確認します。
    // extract関数は、正常にインポートされた変数の数を返します。
    $anotherData = ['key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3'];
    // 既存変数 'key1' を定義しておきます。
    $key1 = "original_value";

    echo "--- extract() の戻り値の例 (EXTR_SKIP使用) ---\n";
    echo "  extract実行前の \$key1: " . $key1 . "\n";
    $importedCount = extract($anotherData, EXTR_SKIP);
    echo "  extract実行後の \$key1: " . $key1 . "\n"; // スキップされるため 'original_value' のまま
    echo "  extract実行後の \$key2: " . $key2 . "\n";   // 新しくインポートされる
    echo "  インポートされた変数の数 (EXTR_SKIP使用時): " . $importedCount . " (key1はスキップされたため、key2とkey3の2つのみ)\n";

    // 次のデモのために、作成された変数をクリアします。
    unset($key1, $key2, $key3);
}

// 関数を実行します。
demonstrateExtractUsage();

?>

PHPのextract関数は、指定された連想配列のキーを現在のスコープの変数名として、その値を対応する変数に代入する機能を提供します。これは、テンプレートエンジンなどで、データベースから取得した連想配列のデータを個別の変数として手軽に扱いたい場合に特に便利です。

第一引数$arrayには、変数として展開したい連想配列を指定します。この引数は参照渡しとなります。第二引数$flagsは、現在のスコープに同名の変数が既に存在する場合の挙動を制御する非常に重要なオプションです。例えば、デフォルトのEXTR_OVERWRITEフラグでは既存変数を配列の値で上書きしますが、EXTR_SKIPフラグを使用すると既存変数は上書きされず、配列の値はスキップされます。また、EXTR_PREFIX_ALLフラグを指定すると、全てのインポートされる変数名に、第三引数$prefixで指定した文字列が接頭辞としてアンダースコアを介して付与されます。これにより、既存の変数との名前衝突を安全に回避できます。

extract関数の戻り値は整数値で、正常に現在のスコープにインポートされた（新しく作成されたか、上書きされた）変数の総数を返します。この関数はコードを簡潔にするメリットがある反面、予期せぬ変数名の衝突やセキュリティ上の脆弱性につながる可能性もあるため、使用する際はフラグの意味を十分に理解し、注意深く利用することが推奨されます。