PHP関数「compact」と「extract」を試してみる

PHPにはcompact、extratと言う関数がある。
CakePHPをやっている人なら、compactは何度かお目にかかった事があるんじゃなかろうか。

PHP公式マニュアルを斜め読みしながら開発をしていると、知っているけど実はちゃんと分かっていなかったと言うことがたくさんあるとおもう。

今回はcompactとextractを試してみようと思う。
まずはextractだ。

int extract ( array $var_array [, int $extract_type = EXTR_OVERWRITE [, string $prefix ]] )
配列からシンボルテーブルに変数をインポートします

これはつまりどういうことかと言うと、実際にやってみると早い。

というわけで、以下のソースを試して見た。

view plain print ?

$account = array(
'id' => 'someone@example.com',
'password' => 'mypassword',
'screenname' => 'sam',
);
extract($account);

$account = array(
  'id' => 'someone@example.com',
  'password' => 'mypassword',
  'screenname' => 'sam',
);
extract($account);

id、password、screennameをキーとして、それぞれsomeone@example.com、mypassword、samをバリューとして持つ、只の連想配列（ハッシュ）だが、この連想配列をextractすると、以下のような変数が生成される。

変数	値
$id	someone@example.com
$password	mypassword
$screenname	sam

可変変数を可能にしたPHPらしい関数だ。
使い道は少ないとは思うが、あると便利な関数ではないだろうか。

次に、extractの逆になるcompactを試してみる。

array compact ( mixed $varname [, mixed $... ] )
変数名とその値から配列を作成します。

extractは「連想配列＞変数へ展開」だったが、compactは逆なので、「変数＞連想配列に格納」となる。

あらかじめいくつかの変数を定義しておく必要があるので、以下のように設定しておいた。

view plain print ?

$id = 'someone@example.com';
$password = 'mypassword';
$screenname = 'sam';

$id = 'someone@example.com';
$password = 'mypassword';
$screenname = 'sam';

この状態で、すべての変数をcompactして見よう。

view plain print ?

$account = compact('id', 'passwd', 'screenname');

$account = compact('id', 'passwd', 'screenname');

注意点として、変数を定義するのではなく、変数名を定義する、と言うことだ。なので、$idは'id'としなければならない。
そしてcompact化した変数accountをみて見ると、連想配列になっているのが分かる。
最終的なソースは以下になる。

view plain print ?

$id = 'someone@example.com';
$password = 'mypassword';
$screenname = 'sam';
$account = compact('id', 'passwd', 'screenname');
echo "<pre>";
print_r($account);
echo "</pre>";

$id = 'someone@example.com';
$password = 'mypassword';
$screenname = 'sam';
$account = compact('id', 'passwd', 'screenname');

echo "<pre>";
print_r($account);
echo "</pre>";

結果は以下のようになる。

Array
(
    [id] => someone@example.com
    [password] => mypassword
    [screenname] => sam
)

まさにextractとcompactは逆だ。
そしてこれらのCakePHPでの使用用途だ。
ずばり言うと、$this->setで使うと考えておいて良い。

$begin、$end、$idをそれぞれ同じ変数名としてビュースクリプトへセットしたい場合、通常はこのような記述をすると思う。

view plain print ?

$this->set('begin', $begin);
$this->set('end', $end);
$this->set('id', $id);

$this->set('begin', $begin);
$this->set('end', $end);
$this->set('id', $id);

しかし、compactを使った場合、$this->setは1回で済む。
ただしあらかじめ連想配列にしておく必要がある。

view plain print ?

$datas = array(
'begin'=>$begin,
'end'=>$end,
'id'=>$id
);
$this->set(compact('datas'));

$datas = array(
  'begin'=>$begin,
  'end'=>$end,
  'id'=>$id
);
$this->set(compact('datas'));

これで、begin、end、idがそれぞれビュースクリプト側で使えるようになった。

とはいえ、$this->setする際、なるべくひとつのデータを送っておいた方が楽なのではないか、と思う。
いちいちidなど、個別にセットしておくと、たとえば一気にデータを消す際、変数の数だけ処理をしなくてはならなくなる。

というわけで、それほどcompactの用途は多くは無さそうだ。