extract

説明

この関数は、配列から現在のシンボルテーブルに変数をインポートする ために使用されます。この関数は連想配列var_array を引数とし、そのキーを変数名、値を変数の値として処理します。 各キー/値の組に関して、extract_typeおよび prefixパラメータに基づき現在のシンボルテー ブルに変数を一つ作成します。

extract()は、各キーについて変数名として有効で あるかどうか、そして、シンボルテーブルの既存の変数と衝突しないか どうかを確認します。無効または数値キーおよび衝突に関する対処法は、 extract_typeで定義されます。これは以下の値 のどれかとなります。

extract_typeが指定されない場合、EXTR_OVERWRITE が仮定されます。

prefixは、 extract_typeがEXTR_PREFIX_SAME、 EXTR_PREFIX_ALL、EXTR_PREFIX_INVALID の場合にのみ必要であることに 注意して下さい。接頭辞を付けた変数名が有効な変数名でない場合、こ の変数はシンボルテーブルにインポートされません。

extract()は、各キーが有効な変数名からなるかど うかを確認し、有効な変数名である場合のみインポート処理を行います。

extractの使用例としては、シンボルテーブルに wddx_deserialize()から返された連想配列を インポートすることが考えられます。

例 1extract()の例 <?php /* $var_array はwddx_deserializeから返された配列と仮定します */ $size = "large"; $var_array = array ("color" => "blue", "size" => "medium", "shape" => "sphere"); extract ($var_array, EXTR_PREFIX_SAME, "wddx"); print "$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 が作成されます。

連想配列を使用する必要があり、数値添字の配列には結果は出力されま せん。

compact()も参照下さい。