(PHP 4, PHP 5, PHP 7, PHP 8)
extract — 配列からシンボルテーブルに変数をインポートする
&$array, int $flags = EXTR_OVERWRITE, string $prefix = ""): int配列からシンボルテーブルに変数をインポートします。
各キーについて変数名として有効であるかどうか、 そして、シンボルテーブルの既存の変数と衝突しないかどうかを確認します。
array
この関数は連想配列 var_array
を引数とし、そのキーを変数名、値を変数の値として処理します。
各キー/値の組に関して、flags および
prefix パラメータに基づき、
現在のシンボルテーブルに変数を一つ作成します。
連想配列を使用する必要があります。EXTR_PREFIX_ALL
または EXTR_PREFIX_INVALID を使用しない限り、
数値添字の配列には結果は出力されません。
flags
無効または数値キーおよび衝突に関する対処法は、
flags で定義されます。
これは以下の値のどれかとなります。
EXTR_OVERWRITEEXTR_SKIPEXTR_PREFIX_SAMEprefix
を前につけた新しい変数となります。
EXTR_PREFIX_ALLprefix を付けます。
EXTR_PREFIX_INVALIDprefix を付けます。
EXTR_IF_EXISTSEXTR_PREFIX_IF_EXISTSEXTR_REFSarray
パラメータの値に常に参照付けられることを意味します。
このフラグを単独で使用するか、
あるいはflagsと和算することにより、
他のフラグとそれを組み合わせることができます。
flags が指定されない場合、
EXTR_OVERWRITE とみなされます。
prefix
prefix は、
flags が
EXTR_PREFIX_SAME、EXTR_PREFIX_ALL、
EXTR_PREFIX_INVALID あるいは
EXTR_PREFIX_IF_EXISTS の場合にのみ必要であることに注意してください。
接頭辞を付けた変数名が有効な変数名でない場合、
この変数はシンボルテーブルにインポートされません。接頭辞は、
アンダースコア文字で配列のキーから自動的に分割されます。
シンボルテーブルにインポートした変数の数を返します。
例1 extract() の例
extract の使用例としては、シンボルテーブルに wddx_deserialize() から返された連想配列を インポートすることが考えられます。
<?php
/* $var_array はwddx_deserializeから返された配列と仮定します */
$size = "large";
$var_array = array("color" => "blue",
"size" => "medium",
"shape" => "sphere");
extract($var_array, EXTR_PREFIX_SAME, "wddx");
echo "$color, $size, $shape, $wddx_size\n";
?>
上の例の出力は以下となります。
blue, large, sphere, medium
EXTR_PREFIX_SAME を指定したため、$size
は上書きされず、$wddx_size が作成されます。
EXTR_SKIP が指定された場合、$wddx_size は作成されません。
EXTR_OVERWRITE
の場合は、$size の値は "medium" となります。
EXTR_PREFIX_ALL の場合は新規の変数
$wddx_color,
$wddx_size, $wddx_shape
が作成されます。
extract() をユーザー入力
($_GET や $_FILES など)
のような信頼できないデータについて使用しないでください。
もし行う場合、
EXTR_SKIP のような flags
の値が上書きされていないことを確認してください。そして
php.ini の
variables_order
で定義されたものと同じ順で展開すべきであることに留意してください。