compact

compact -- 変数名とその値から配列を作成する

説明

array compact(string varname | array varnames, [...]);

compact() がとるパラメータの数は可変です。 各パラメータは、変数名を値とする文字列か、変数名の配列のどちらかとする ことができます。配列は、変数名を値とする別の配列を持つことができます。 compact() はこれを再帰的に処理します。

各引数について、compact()は現在のシンボルテーブル においてその名前を有する変数を探し、変数名がキー、変数の値がそのキー に関する値となるように追加します。 端的に言うと、 extract() の逆の動作をします。 追加された全ての変数を値とする出力配列を返します。

例 1. compact() の例

  1 
  2 $city = "San Francisco";
  3 $state = "CA";
  4 $event = "SIGGRAPH";
  5 
  6 $location_vars = array("city", "state");
  7 
  8 $result = compact("event", $location_vars);
  9       

この例により $result は、array("event" => "SIGGRAPH", "city" => "San Francisco", "state" => "CA") となります。

extract() も参照下さい。

注意: この関数は、PHP 4.0 で追加されました。