👨🏿‍🤝‍👨🏻 🙇🏼 🈴 PHPでforeachを使用することの複雑さ 🤹 💃🏻 🔁

最近の興味深いPHPリンクのダイジェストで、Nikita PopovのStackOverflowに関するコメントへのリンクを見つけました。そこでは、Foreach制御構造の「内部」メカニズムについて詳しく説明しています。

foreachは奇妙な方法以上に機能することがあるため、この答えを翻訳すると役立つことがわかりました。

注意：このテキストは、PHPのzval'ovの機能に関する基本的な知識の存在を示しています。特に、refcountとis_refが何であるかを知っておく必要があります。

foreachはさまざまなタイプのエンティティで動作します。配列、単純なオブジェクト（使用可能なプロパティがリストされている場合）、およびTraversableオブジェクト（または、内部get_iteratorが定義されているオブジェクト）を使用します。ここでは主に配列について説明していますが、残りについては最後に説明します。

開始する前に、コンテキストを理解するために重要な配列とその走査に関するいくつかの単語。

配列トラバーサルの仕組み

PHPの配列は順序付けられたハッシュテーブルであり（ハッシュ要素は二重にリンクされたリストに結合されます）、foreachは指定された順序に従って配列を走査します。

PHPには、配列をトラバースする2つの方法があります。

最初の方法は、内部配列ポインターです。このポインターはHashTable構造の一部であり、ハッシュテーブル内の現在のアイテムへのポインターにすぎません。内部配列ポインターは免責で変更できます。つまり、現在の要素が削除されると、内部配列ポインターは次の要素に移動します。
2番目の反復メカニズムは、HashPositionと呼ばれる外部配列ポインターです。これは、配列の内部ポインターとほぼ同じですが、HashTableの一部ではありません。この外部反復メソッドは、変更しても安全ではありません。 HashPositionが指すアイテムを削除すると、ぶら下がりポインターが残るため、セグメンテーションエラーが発生します。

したがって、外部配列ポインターは、カスタムコードが実行されないことを完全に確信している場合にのみ使用できます。また、このようなコードは、エラーハンドラーやデストラクターなど、最も予期しない場所にある可能性があります。そのため、ほとんどの場合、PHPは外部ポインターではなく内部ポインターを使用する必要があります。それ以外の場合、ユーザーが異常な操作を開始するとすぐに、セグメンテーション違反によりPHPが落ちる可能性があります。

内部ポインタの問題は、HashTableの一部であるということです。したがって、それを変更すると、HashTableも一緒に変更されます。また、PHPの配列へのアクセスは（参照ではなく）値によって行われるため、ループ内の要素をバイパスするために配列をコピーする必要があります。

コピーの重要性を示す簡単な例（ちなみに、それほど珍しいことではありません）、これはネストされた反復です：

foreach ($array as $a) { foreach ($array as $b) { // ... } }

ここでは、両方のループを独立させ、1つのポインターで投げるのは難しくありません。

それで、私たちはforeachになりました。

foreachでの配列トラバーサル

これで、foreachが配列をコピーする前に配列のコピーを作成する必要がある理由がわかりました。しかし、これは明らかに全体の話ではありません。 PHPがコピーを作成するかどうかは、いくつかの要因に依存します。

反復可能な配列が参照の場合、コピーは行われず、代わりにaddrefが実行されます。

 $ref =& $array; // $array has is_ref=1 now foreach ($array as $val) { // ... }

なんで？配列への変更は、内部ポインタを含め、参照によって伝播する必要があるためです。この場合、foreachがコピーを作成すると、リンクのセマンティクスが破壊されます。

配列の参照カウントが1の場合、コピーは再び失敗します。 refcount = 1は、配列が他の場所で使用されておらず、foreachが直接使用できることを意味します。 refcountが複数の場合、配列は他の変数で分割され、変更を避けるため、foreachはそれをコピーする必要があります（上記のリンクの場合に関係なく）。
配列が参照されている場合（foreach（$ array as＆$ ref））-コピー関数または非コピー関数に関係なく、配列はリンクになります。

これが謎の最初の部分であるコピー機能です。 2番目の部分は、現在の反復がどのように実行されるかであり、かなり奇妙です。既に知っている（そしてPHPでよく使用されるforeachとは別の）「通常の」反復パターンは、次のようになります（擬似コード）。

 reset(); while (get_current_data(&data) == SUCCESS) { code(); move_forward(); }

foreach反復は少し異なります：

 reset(); while (get_current_data(&data) == SUCCESS) { move_forward(); code(); }

違いは、move_forward（）がループの最後ではなく、最初に実行されることです。したがって、ユーザーコードが要素$ iを使用する場合、配列の内部ポインターは既に要素$ i + 1を指します。

foreachのこの動作モードは、現在の要素が削除された場合、前の要素ではなく、次の要素に移動する理由でもあります（予想どおり）。 foreachで完全に機能するようにすべてが行われます（ただし、明らかに、他のすべてはうまく機能せず、要素をスキップします）。

コードの意味

上記の動作の最初の結果は、多くの場合foreachが反復可能な配列を（ゆっくりと）コピーすることです。しかし、恐れを拒否してください：コピーの要件を削除しようとしましたが、人工的なベンチマーク（反復が2倍高速だった）を除いて、どこでも作業の加速を見ることができませんでした。人々は十分に反復していないようです。

2番目の結果は、通常、他の結果はないはずです。 foreachの動作は、基本的にユーザーに理解可能であり、本来どおりに機能します。コピーがどのように発生するか（およびまったく発生するかどうか）、およびポインターが移動する特定の時点について心配する必要はありません。

そして、3番目の結果-そして、ここで私たちはあなたの問題に近づいています-時々、私たちは理解するのが難しい非常に奇妙な行動を見ます。 これは、ループ内でバイパスする配列自体を変更しようとすると特に発生します。

反復中に配列を変更したときに表示される境界線の場合の動作の大規模なコレクションは、PHPテストで見つけることができます。このテストから始めて、アドレスの012から013に変更することができます。 foreach動作がさまざまな状況（リンクのあらゆる種類の組み合わせなど）でどのように現れるかがわかります。

例に戻りましょう：

 foreach ($array as $item) { echo "$item\n"; $array[] = $item; } print_r($array); /* Output in loop: 1 2 3 4 5 $array after loop: 1 2 3 4 5 1 2 3 4 5 */

ここで、$配列はループの前にrefcount = 1を持つため、コピーされませんが、addrefを取得します。値を$ array []に割り当てると、zvalは分割されるため、要素と反復可能配列を追加する配列は2つの異なる配列になります。

 foreach ($array as $key => $item) { $array[$key + 1] = $item + 2; echo "$item\n"; } print_r($array); /* Output in loop: 1 2 3 4 5 $array after loop: 1 3 4 5 6 7 */

最初のテストと同じ状況。

 //    ,  ,      foreach var_dump(each($array)); foreach ($array as $item) { echo "$item\n"; } var_dump(each($array)); /* Output array(4) { [1]=> int(1) ["value"]=> int(1) [0]=> int(0) ["key"]=> int(0) } 1 2 3 4 5 bool(false) */

再び同じ話。 foreachループでは、refcount = 1になり、addrefのみが取得され、内部ポインター$配列が変更されます。ループの終わりで、ポインターはNULLになります（これは、反復が完了したことを意味します）。それぞれがfalseを返すことでこれを示しています。

 foreach ($array as $key => $item) { echo "$item\n"; each($array); } /* Output: 1 2 3 4 5 */

 foreach ($array as $key => $item) { echo "$item\n"; reset($array); } /* Output: 1 2 3 4 5 */

関数eachとresetは両方とも参照によって参照されます。 $配列の場合、refcount = 2になります。その結果、分割する必要があります。繰り返しますが、foreachは別の配列で動作します。

しかし、これらの例は十分に説得力がありません。ループでcurrentを使用すると、動作は本当に予測不可能になります。

 foreach ($array as $val) { var_dump(current($array)); } /* Output: 2 2 2 2 2 */

ここでは、配列も変更しませんが、currentも参照されることに注意してください。これは、参照によってアクセスされるnextなど、他のすべての関数と連携して動作するために必要です（実際には、現在はref関数であることが望ましいです。値を取得できますが、可能であればリンクを使用します）。参照は、配列を分離する必要があることを意味します。したがって、foreachが使用する$配列と$配列のコピーは独立しています。 1ではなく2を取得する理由についても上記で説明しました。foreachは、配列ポインターをユーザーコードの先頭に拡張し、後ではありません。したがって、コードがまだ最初の要素で動作している場合でも、foreachは既に2番目の要素にポインターを移動しています。

次に、小さな変更を試みます。

 $ref = &$array; foreach ($array as $val) { var_dump(current($array)); } /* Output: 2 3 4 5 false */

ここではis_ref = 1なので、配列はコピーされません（上記のとおり）。しかし、is_refが存在する場合、配列を分割する必要がなくなり、カレントへの参照渡しとなります。現在、現在とforeachは同じ配列で動作します。 foreachがポインターを処理するという理由だけで、配列が1つシフトしていることがわかります。

リンクによる配列トラバーサルを実行すると、同じことがわかります。

 foreach ($array as &$val) { var_dump(current($array)); } /* Output: 2 3 4 5 false */

ここで最も重要なことは、foreachが参照によってループするときに$配列is_ref = 1を割り当てるため、上記と同じになることです。

別の小さなバリエーション、ここでは配列を別の変数に割り当てます。

 $foo = $array; foreach ($array as $val) { var_dump(current($array)); } /* Output: 1 1 1 1 1 */

ここでは、ループの開始時に$配列の参照カウントが2に設定されているため、開始する前にコピーを作成する必要があります。したがって、$配列とforeachで使用される配列は、最初とは異なります。そのため、ループの開始前に関連していた配列の内部ポインターの位置を取得します（この場合、最初の位置にありました）。

オブジェクトの反復

オブジェクトを反復処理する場合、次の2つのケースを考慮するのが理にかなっています。

オブジェクトはTraversableではありません（または、get_iterator内部ハンドラーが定義されていません）

この場合、反復は配列の場合とほぼ同じ方法で行われます。同じコピーセマンティクス。唯一の違い：foreachは、現在のスコープで使用できないプロパティをスキップするためにいくつかの追加コードを実行します。いくつかの興味深い事実：

宣言されたプロパティの場合、PHPはプロパティのハッシュテーブルを再最適化します。オブジェクトを反復する場合、このハッシュテーブルを再構築する必要があります（メモリ使用量が増加します）。これについて心配する必要はありません。念頭に置いてください。
各反復で、プロパティのハッシュテーブルが再度取得されます。つまり、PHPはget_propertiesを何度も何度も呼び出します。「通常の」プロパティの場合、これはそれほど重要ではありませんが、プロパティが動的に作成される場合（組み込みクラスがこれを行うことが多い）、プロパティテーブルは毎回再カウントされます。

トラバース可能なオブジェクト

この場合、上記のすべてが適用されることはありません。また、PHPはコピーせず、ループが通過するまでポインターを増やすなどのトリックを使用しません。通過可能なオブジェクトを通過するモードは、はるかに予測可能であり、さらに説明する必要はないと思います。

ループ中に反復可能なオブジェクトを置き換える

私が言及しなかったもう1つの珍しいケースは、PHPがループ中に反復可能なオブジェクトを置き換える可能性があることです。ある配列から始めて、途中で別の配列に置き換えることで続行できます。または、配列から始めて、それをオブジェクトで置き換えます：

 $arr = [1, 2, 3, 4, 5]; $obj = (object) [6, 7, 8, 9, 10]; $ref =& $arr; foreach ($ref as $val) { echo "$val\n"; if ($val == 3) { $ref = $obj; } } /* Output: 1 2 3 6 7 8 9 10 */

ご覧のように、PHPは置換が行われるとすぐに別のエンティティをバイパスし始めました。

反復中に配列の内部ポインターを変更する

私が言及しなかったforeach動作の最後の詳細（ 本当に奇妙な動作を得るために使用できるため）：ループ処理中に配列の内部ポインターを変更しようとするとどうなりますか。

ここでは、期待したものが得られない場合があります：ループの本体でnextまたはprevを呼び出すと（参照渡しの場合）、内部ポインターが移動したことがわかりますが、これはイテレーターの動作に影響しませんでした。その理由は、foreachは、ループの各パスの後に、HashPointer内の現在の要素の現在の位置とハッシュをバックアップするからです。次のパスで、foreachは内部ポインターの位置が変更されたかどうかを確認し、このハッシュを使用してそれを復元しようとします。

「試してみる」の意味を見てみましょう。最初の例は、内部ポインターを変更してもforeachモードが変更されないことを示しています。

 $array = [1, 2, 3, 4, 5]; $ref =& $array; foreach ($array as $value) { var_dump($value); reset($array); } // output: 1, 2, 3, 4, 5

ここで、最初のパス（キー1）でforeachによってアクセスされる要素の設定を解除してみましょう。

 $array = [1, 2, 3, 4, 5]; $ref =& $array; foreach ($array as $value) { var_dump($value); unset($array[1]); reset($array); } // output: 1, 1, 3, 4, 5

ここで、適切なハッシュを持つ要素を見つけることができなかったため、カウンターがリセットされていることがわかります。

ハッシュは単なるハッシュであることに注意してください。衝突が起こります。次のように試してみましょう。

 $array = ['EzEz' => 1, 'EzFY' => 2, 'FYEz' => 3]; $ref =& $array; foreach ($array as $value) { unset($array['EzFY']); $array['FYFZ'] = 4; reset($array); var_dump($value); } // output: 1 1 3 4

期待どおりに機能します。 EzFYキー（foreachがあったキー）を削除したため、リセットが行われました。追加のキーも追加したため、最後に4が表示されます。

そしてここに未知のものがやってくる。 FYFYキーをFYFZに置き換えるとどうなりますか？試してみましょう：

 $array = ['EzEz' => 1, 'EzFY' => 2, 'FYEz' => 3]; $ref =& $array; foreach ($array as $value) { unset($array['EzFY']); $array['FYFY'] = 4; reset($array); var_dump($value); } // output: 1 4

これで、サイクルは新しい要素に直接渡され、他のすべてがスキップされます。これは、FYFYキーがEzFY（実際には、この配列のすべてのキーも）と衝突するためです。さらに、FYFY要素は、削除されたばかりのEzFY要素と同じメモリアドレスにあります。したがって、PHPの場合、同じハッシュで同じ位置になります。位置が「復元」され、アレイの終わりに移行します。

PHPでforeachを使用することの複雑さ