each

each -- 配列から、次のキーと値のペアを返す

説明

array each(array array);

配列 array から、次のキーと値のペア を返し、配列カーソルを進めます。このペアは、4 つの要素を持つ配列で、 それぞれの要素は 0, 1, key, および value というキーを有しています。 要素 0key の各々は配列要素のキー名称を保持しており、 1value の各々は そのデータを保持しています。

配列の内部ポインタが、配列の最終要素以降を指す場合、 each() は FALSE を返します。

例 1. each() の例

  1 
  2 $foo = array ("bob", "fred", "jussi", "jouni", "egon", "marliese");
  3 $bar = each( $foo );
  4       

$bar は、ここでは以下のキー/値の ペアを保持しています。

  • 0 => 0
  • 1 => 'bob'
  • key => 0
  • value => 'bob'
  1 
  2 $foo = array( "Robert" => "Bob", "Seppo" => "Sepi" );
  3 $bar = each( $foo );
  4        

$bar は、この時点で以下のキー/値の ペアを保持しています。

  • 0 => 'Robert'
  • 1 => 'Bob'
  • key => 'Robert'
  • value => 'Bob'

通常 each() は、配列の走査をするために list() と共に使用されます。例えば、 $HTTP_POST_VARS の場合は次のようになります。

例 2. each() により $HTTP_POST_VARS を走査する

  1 
  2 echo "POST メソッドにより受け渡された値:<br>";
  3 reset($HTTP_POST_VARS);
  4 while (list($key, $val) = each($HTTP_POST_VARS)) {
  5    echo "$key => $val<br>";
  6 }
  7       

each() を実行した後、配列カーソルは、 配列の次の要素に移動します。配列の最終要素にカーソルがある場合は、 最終要素にとどまります。

key()list()current()reset()next()prev() も参照下さい。