for と foreachのつきまして

Question

以下のように多次元配列の中で、末端の配列の先頭を削除して詰めるコードを
書いているのですが、下記の1も2も等価であり同じように処理ができると考えていたのですが
2については、何も処理されません。2で意図した処理がされないことについて、ご質問させてください。

宜しくお願い申し上げます。

/1
$hoge=[[1,2,3],[4,5,6]];

for ($i=0; $i <count($hoge) ; $i++) {
array_splice($hoge[$i],0,1);
}
print_r($hoge);
/*結果
Array
(
    [0] => Array
        (
            [0] => 2
            [1] => 3
        )

    [1] => Array
        (
            [0] => 5
            [1] => 6
        )

)
*/




/2
foreach ($hoge as $key) {
  array_splice($key,0,1);
}
print_r($hoge);
/*結果
Array
(
    [0] => Array
        (
            [0] => 1
            [1] => 2
            [2] => 3
        )

    [1] => Array
        (
            [0] => 4
            [1] => 5
            [2] => 6
        )

)
*/

Answer 1

forの方では$hogeを直接処理していますが、foreachの方では$keyに対して処理しているからですね
$keyをリファレンスで処理すれば同じ処理になります。

foreach ($hoge as &$key) {
  array_splice($key,0,1);
}
/* 追記
リファレンスは使用後削除すること
*/
unset($key);

Comments

[pegy]

コメント有難うございます。
なるほど、破壊的関数を使用する場合には、置き換わった変数ではなく直接（この場合にはリファレンス変数）変数を処理することに留意する必要があるのですね。
勉強になりました！

[miyabi-sun]

http://php.net/manual/ja/control-structures.foreach.php

> unset($value); // 最後の要素への参照を解除します

補足です。
これは慣習なのですがリファレンスのforeachを使用した場合、
公式サイトでも上記のような行を用いて紹介しているように、foreachを抜けた直後で変数に対してunsetを付けましょう。

今回yambejpさんは`foreach ($hoge as &$key) {`と宣言していますが、
foreachを抜けた後も`&$key`の参照は残っているので、
次の行で`unset($key)`としましょう。

[yambejp]

miyabi-sunさん、フォローありがとうございます

まさにおっしゃる通りだとおもいます
変数の使い回しをする可能性がある限りリファレンスしたものは
使わなくなった時点で削除すべきでした

[miyabi-sun]

強い言い方になっていたので修正しました。
回答のコアな部分としては不要と思いつつ、
バグを埋め込まない形ということで補足としてコメントとしてぶら下げてます。

[yambejp]

miyabi-sunさん

ちなみに
foreach ($hoge as &$key) {
array_splice($key,0,1);
unset($key);
}

と

foreach ($hoge as &$key) {
array_splice($key,0,1);
}
unset($key);

は、どちらがいいと思います？

[miyabi-sun]

前者は初見ですね。今まで後者でやってました。
基本的には後者持ちですが、前者はこの辺が主張にできそうでどっちも良さそうですね。

・副作用を`{}`の中に記述出来るので、外のブロックスコープが汚れない
・foreachに修正入って`&$key`が外に出ていかなくなってもエラーを回避できそう

[yambejp]

なるほど。
私も後者で十分だと思いますが、使い回しという言う意味では
前者を推奨する方もいるのかなと思いまして・・
問題なさそうなので、回答に追記しておきます

[pegy]

miyabi-sun様
yambejp様
参照への解除につきまして、ご追記有難うございます。
公式も確認いたしました。宜しくお願い申し上げます。

[miyabi-sun]

> yamabejpさん
対応ありがとうございます！

Answer 2

プログラム中に回答を書いてみましたが、これで分かりますでしょうか？

<?php 
//Case1
$hoge =[[1,2,3],[4,5,6]];

for ($i=0; $i <count($hoge) ; $i++) {
array_splice($hoge[$i],0,1);
}
print_r($hoge);

//再度、値を設定する
$hoge =[[1,2,3],[4,5,6]];
//Case2
foreach ($hoge as $key) {
    //$keyの内容はここで[2,3]または2回目のループ時には[5,6]となっていますが
    //$hogeの内容は変更されていません
    //array_splice($key,0,1);
    
    //こうやって別の変数に値を入れてあげると結果が等しくなります。
    array_splice($key,0,1);
    $fuga[] = $key;
}
//$fugaを出力
print_r($fuga);
//$hogeは何も変わらず
print_r($hoge);

Comments

[pegy]

コメント有難うございます。
yambejp様のように変数を参照にするか、仰るよう異なる変数に格納するかどちらもできそうですね。
加えて、非破壊的に取扱いたい場合には、敢えてforeachでこのようにやる方法もあるかなと気づきました。
深謝します！