Delicious Bookmark this on Delicious Share on Facebook SlashdotSlashdot It! Digg! Digg



PHP : Function Reference : Array Functions : each

each

Return the current key and value pair from an array and advance the array cursor (PHP 4, PHP 5)
array each ( array &array )

Example 302. each() examples

copy to clipboard
<?php
$foo = array("bob", "fred", "jussi", "jouni", "egon", "marliese");
$bar = each($foo);
print_r($bar);
?>

$bar now contains the following key/value pairs:

copy to clipboard
Array
(
   [1] => bob
   [value] => bob
   [0] => 0
   [key] => 0
)

Example 303. Traversing an array with each()

copy to clipboard
<?php
$fruit = array('a' => 'apple', 'b' => 'banana', 'c' => 'cranberry');

reset($fruit);
while (list($key, $val) = each($fruit)) {
   echo "$key => $val\n";
}
?>

The above example will output:

copy to clipboard
a => apple
b => banana
c => cranberry

Related Examples ( Source code ) » each

Examples ( Source code ) » An HTML Form Including a SELECT Element
Examples ( Source code ) » File based login
Examples ( Source code ) » Login ID Options
Examples ( Source code ) » The Table and HTMLTable Classes
Examples ( Source code ) » The Table Class
Examples ( Source code ) » Print XML attributes
Examples ( Source code ) » XML Path in action
Examples ( Source code ) » Print all MySQL status value
Examples ( Source code ) » Listing All Rows and Fields in a Table
Examples ( Source code ) » Listing Tables in a Database
Examples ( Source code ) » Registering an Array Variable with a Session
Examples ( Source code ) » Disk total space
Examples ( Source code ) » Read text file into array and output
Examples ( Source code ) » Read text file with format
Examples ( Source code ) » the m modifier to change the behavior of $

Code Examples / Notes » each

mindilator
You can nest foreach loops too, though.

wodzuy2k
Yet another useful example of how to make globals out of the config file.
config file:
[section1]
value=foo
PHP result :
variable: $section1_value=foo;
function servicesConfig_makeGlobals()
{
global $servicesConfig;
$servicesConfig = parse_ini_file("servicesConfig.conf", TRUE);
reset($servicesConfig);
while (list ($section, $section_val) = each ($servicesConfig))
{
reset($servicesConfig[$section]);
while (list ($key, $val) = each ($servicesConfig[$section]))
{
$GLOBALS[$section.'_'.$key]=$val;
};
};
};

manz_2007
We have an array like this :
$aField = array("eid" => "c", "name" => "l", "department" => "l", "hire_date" => "d", "hire_date" => "sd", "actives" => "i");
we want to walking every value like :
eid => c
name => l
department => l
hire_date => d
hire_date => sd
actives => i
but when using
foreach($aField as $key => $value)
{ echo "$key, $value"; }
or using
print_r($aField);
its look like this:
eid => c
name => l
department => l
hire_date => sd
actives => i
BTW, the hire_date => d as we expected is missing...
Anybody can resolve this matter ?
Thanks
Man'z

sjoerd-php
Use foreach instead of while, list and each. Foreach is:
- easier to read
- faster
- not influenced by the array pointer, so it does not need reset().
It works like this:
<?php
$arr = array('foo', 'bar');
foreach ($arr as $value) {
   echo "The value is $value.";
}
$arr = array('key' => 'value', 'foo' => 'bar');
foreach ($arr as $key => $value) {
   echo "Key: $key, value: $value";
}
?>

php-traversing-matrices
Traversing multidimensional arrays is
easy, especially if you know how many dimensions are involved. Suppose you have a structure returned from a database query, such as
$returned_rows[$row_number][$field_name]
To walk through each field, you
might try this:
while (
  list($row_number, $row_array)
    = each($query_result_array)
  ) {
  while (
    list($field_name, $field_value)
       = each($row_array)
  ) {
     ##
     ## $row_number has the
     ## current row number,
     ## $field_name hsa the current    
     ## field' name,
     ## $field_value has the current          ## field's value
   }
 }
}

matthew
To panania at 3ringwebs dot com:
If you know for certain that you are only receiving one row, the while becomes redundant. To shorten your code:
$strSQL = "SELECT * FROM table WHERE id=1";
$RecordsetSelect = $db->runQuery ($strSQL);
list($key, $val) = mysql_fetch_row($RecordsetSelect);
echo "$key => $val\n";
mysql_free_result($RecordsetSelect);
With only one row being returned this is more elegant a solution, but just being nit-picky in essence. It also shows another quick way of using list.

ridcully
To output all entries of an array $a, do this
reset ($a);
while( $res=each($a) )
{
 echo "$res[1]
";
};
If you need the keys too, it's in $res[0].

wodzuy2k
This function will help you dump any variable into XML structure.
//dump var into simple XML structure
function var_dump_xml($tagname,$variable,$level=0)
{
for($i=0;$i<$level;$i++) $marg.=' ';
if (eregi('^[0-9].*$',$tagname)) $tagname='tag_'.$tagname; //XML tag cannot start with [0-9] character
if (is_array($variable))
{
   echo $marg."<$tagname>\n";
   while (list ($key, $val) = each ($variable))  var_dump_xml($key,$val,$level+1);
   echo $marg."</$tagname>\n";
}
elseif (strlen($variable)>0)
{
    echo $marg."<$tagname>".htmlspecialchars($variable)."</$tagname>\n";
};
};

/*
example:

$myVar = array("name"=>"Joe", "age"=>"26", "children"=>array("Ann","Michael"));
var_dump_xml("myVarTag",$myVar);
*/

panania
The last method for record sets is great if you don't know the number of rows returned from a query, but if you do there's an easier way...
$strSQL = "SELECT * FROM table WHERE id=1";
$RecordsetSelect = $db->runQuery ($strSQL);
$row_Recordset1 = mysql_fetch_assoc($RecordsetSelect);
while (list($key, $val) = each($row_Recordset1)) {
echo "$key => $val\n";
}
mysql_free_result($RecordsetSelect);
Here we know that only 1 record will be returned because of the WHERE criteria. (Of course this is dependent on you own DB schema.)

michael
Something that I found useful to note is that each() does NOT return a reference to the array contets, but a copy of the item.
So, say you have:
$boxes = Array();
$boxes["Large"] = Array();
$boxes["Medium"] = Array();
$boxes["Small"] = Array();
and want to put the small box inside the medium box inside the large box, doing:
$lastBox = NULL;
while (list($key, $box) = each($boxes)) {
 if (isset($lastBox))
   $lastBox[0] =& $box;
 $lastBox =& $box;
}
will not work.  Instead, you have to use the key like:
$lastBox = NULL;
while (list($key) = each($boxes)) {
 $box =& $boxes[$key];
 if (isset($lastBox))
   $lastBox[0] =& $box;
 $lastBox =& $box;
}
which will work.

kris
Remember to use "reset()" if you iterate over an array with "each()" more than once!  Example:
while(list($key,$value) = each($array)){
// code here
}
NOW the internal pointer on $array is at the end of the array, and another attempt at an iteration like the one above will result in zero executions of the code within the "while" block.  You MUST call "reset($array)" to reset the internal array pointer before iterating over the array again from the first element.

scin
Regarding the user who states that foreach is faster, this depends on the size of the array you are dealing with.
On large arrays while(list($key, $val) = each($array) is considerably faster, as in 10x faster with arrays that number in the millions of elements.

wolfeym38
Regarding speed of foreach vs while(list) =each
I wrote a benchmark script and the results are that clearly foreach is faster. MUCH faster. Even with huge arrays (especially with huge arrays). I tested with sizes 100,000. 1,000,000 and 10,000,000. To do the test with 10 million i had to set my memory limit real high, it was close to 1gb by the time it actually worked. Anyways,
<?php
function getDiff($start, $end) {
$s = explode(' ', $start);
$stot = $s[1] + $s[0];
$e = explode(' ', $end);
$etot = $e[1] + $e[0];
return $etot - $stot;
}
$lim=10000000;
$arr = array();
for ($i=0; $i<$lim; $i++) {
$arr[$i] = $i/2;
}
$start = microtime();
foreach ($arr as $key=>$val);
$end = microtime();
echo "time for foreach = " . getDiff($start, $end) . ".\n";
reset($arr);
$start = microtime();
while (list($key, $val) = each($arr));
$end = microtime();
echo "time list each = " . getDiff($start, $end) . ".\n";
?>
here are some of my results: with 1,000,000
time for foreach = 0.0244591236115.
time list each = 0.158002853394.
desktop:/media/sda5/mpwolfe/tests$ php test.php
time for foreach = 0.0245339870453.
time list each = 0.154260158539.
desktop:/media/sda5/mpwolfe/tests$ php test.php
time for foreach = 0.0269000530243.
time list each = 0.157305955887.
then with 10,000,000:
desktop:/media/sda5/mpwolfe/tests$ php test.php
time for foreach = 1.96586894989.
time list each = 14.1371650696.
desktop:/media/sda5/mpwolfe/tests$ php test.php
time for foreach = 2.02504014969.
time list each = 13.7696218491.
desktop:/media/sda5/mpwolfe/tests$ php test.php
time for foreach = 2.0246758461.
time list each = 13.8425710201.
by the way, these results are with php 5.2 i believe, and a linux machine with 3gb of ram and 2.8ghz dual core pentium

aryn
one way to get variables out of an array dynamically, while skipping the keys is this:
while( list($key,$value)=each($foo)) {
 if (!is_int($key)) {
   echo "$"."$key: $value\n";
   $$key = $value;
 }
}
(the echo line is just for displaying what is variables are getting set; ie: not needed.)

pyxl
Ok, for you folks who are learning this, here's something that should help your comprehension of each(), because I bashed my brains for a while on this one.
The first example indicates that each() spits out a 4-cell 1 dimensional array.  This is all fine and dandy until you get to the second example, where that seems to be thrown out the window, because though each() is still spitting out 4 array elements, the list() being used is set up to only accept 2 values, as it's being executed with only wo variables in it!
For some folks, this might not be a problem, but I couldn't understand the mismatch - why was it done, and where did the array go that each() generated??  Well, upon executing that code, it turns out that the first two array elements of the 4 element array that each() creates are assigned to those two variables, and the last two array element values are just thrown away - they're totally ignored.  It's how PHP is written.
Now, why do that?  Well, the example was definitely written more to show folks how to use each() to make life much easier when dealing with a particular operations array in PHP that a lot of people work with, but it also has the side effect (which hopefully my little explaination has made more palatable) of demonstrating how each() can act when being used with other functions that don't necessarily want all of each()'s input.

phpmanual
Note further that each() performs a shallow copy
of the value side of an (assoc) array; if you need to iterate on deep structures, something like:
reset($A); while (list($k,) = each($A)) {
$elem = &$A[$k];
/* ... */
}
Is needed.  Copy construction would be handy to have here.

mark rosenberg
manz_2007 at yahoo dot com:
You don't seem to understand what a key is. It is the unique key which references the item in the array. It can't be duplicated. To make it more clear:
array[0]="hello";
array[0]="world";
print(array[0]);
array[0] will obviously print "world". This is because you first set the array element with the key 0 to hello, and then set it to world. The old value is overwritten.
In your example hire_date is a key, just like 0 is. You set the value of it twice, and of course the second value overwrites the first.
You can of course enter duplicate values into an array, but not keys. Think about it, how would you reference two different values with one key?

james
It's worth noting that references to an array don't have thier own array pointer, and taking a reference to an array doesn't reset it's array pointer, so this works as you would expect it would by eaching the first three items of the array, rather than the first item 3 times.
<?php
 $x = array(1,2,3);
 print_r(each($x));
 echo "\n";
 
 $y =& $x;
 print_r(each($y));
 echo "\n";
 
 $z =& $y;
 print_r(each($z));
 echo "\n";
?>

michael k name der redaktion bekannt.
If you want to iterate over a two-dimensional, sparse array, and want to  first display every first element, then every second and so on, you can use this code:
$fruits = array ( "fruits"  => array ( "a" => "orange",
                                     "b" => "banana",
                                     "c" => "apple"
                                   ),
                "numbers" => array ( 1,
                                     2,
                                     3,
                                     4,
                                     5,
                                     6
                                   ),
                "holes"   => array (      "first",
                                     5 => "second",
                                          "third",
                                    10 => "fourth",
                                   )
              );
$done = False;
while ($done == False) {        
      $done = True;
      // Important: &$val has to be a reference (use the &),
      // if you don't, the internal counter of $val will be
      // re-initialized each time and you loop over the first elements
      // for eternity.
      foreach($fruits as $key => &$val) {
              if (list($inner_key, $inner_val) = each(&$val)) {
                      $done = False;
                      echo "$key : : $inner_key => $inner_val  
\n";
              }
      }
}
NOTE: this is just a quick hack, if you know a better way, post it!

sopinon
If you want to display the hole structure (tree) of your array, then you can use this recursive solution.
<?PHP
$tree= "";
array_tree($your_array);
echo $tree;
// Recursive Function
function array_tree($array, $index=0){
global $tree;
$space="";
for ($i=0;$i<$index;$i++){
$space .= "     ";
}
if(gettype($array)=="array"){
$index++;
while (list ($x, $tmp) = each ($array)){
$tree .= $space."$x => $tmp\n";
array_tree($tmp, $index);
}
}
}
?>

amby2
I've found a compact way to cycle through an associative array using for statement (not while, as it has been done in the most of examples below):
<?php
for (reset($array); list($key) = each($array);) {
 echo $key;
 echo $array[$key];
}
?>
or
<?php
for (reset($array); list($key, $value) = each($array);) {
 echo $key;
 echo $value;
 echo $array[$key];
}
?>
You hardly forget to add reset($array) code line using such construction.

gillis
I wrote a short and pretty simple script to search through associative arrays for some value in the values, heres a simplifyed example of it:
<?php
$foo['bob'] = "bob is ugly";
$foo['bill'] = "bill is rich";
$foo['barbie'] = "barbie is cute";
$search = "rich";
echo "searching the array foo for $search:
";
reset ($foo);
while (list ($key, $val) = each ($foo)) {
if (preg_match ("/$search/i", $val)) {
   print "A match was found in $key.<br />";
} else {
   print "A match was not found in $key.<br />";
}
}
?>
will output:
Searching the array foo for rich:
A match was not found in bob
A match was found in bill
A match was not found in barbie

13-feb-2002 12:10
I usually work a lot with 2D arrays. Since I've had some trouble traversing them correctly maybe someone out there also experienced those problems and can use this one.
It's based on a 2D-array called $array[$x][$y]. At some (but not necessarily all) (x,y) there is a value I want to reach. Note that I do not know beforehand the ranges of $x or $y (that is their highest and lowest values).
while (list ($x, $tmp) = each ($array)) {
  while (list ($y, $val) = each ($tmp)) {
     echo "$x, $y, $val";
  }
}
The answer for each (x,y) pair can thus be (providng, of course those values where in your array beforehand):
1, 1, 2
2, 2, 0
3, 1, 1
5, 2, 2
5, 1, 2
Note that only the (x,y) pairs with a corresponding value is shown.
Hang in there
Jon Egil Strand
NTNU

bleach984
have found something interesting.
when I use a FOREACH with the WHILE statement inside it as talk has been going on,
it will give you all of the values of a multi-dimensional array.
like this
<?php
$categories = return_cats();
foreach ( $categories as $category ) {
      while(list($k, $v) = each ($category)) {
     
      echo "$k ... $v <br />";
     
      }
}
?>
will output something like this
Truecat_name ... Awesome
category_nicename ... awesome
cat_count ... 3
lastday ... 28
lastmonth ... 10
cat_name ... Uncategorized
category_nicename ... uncategorized
cat_count ... 1
lastday ... 28
lastmonth ... 10
cat_name ... Welcome Messages
category_nicename ... welcome-messages
cat_count ... 3
lastday ... 28
lastmonth ... 10

tk
Be sure to use the integrated functions "unset();" or "reset();" - many people forget this and wonder about the created output!

steve
As of PHP 4.0b3, the interpreter's not quite smart enough to manage the following:
while(list($k,$v)=each(array("first","second","third")) {
Instead, use:
$ary=array("first","second","third");
while (list($k,$v)=each($ary)) {

ellenzhg
<?php
//each.php
$foo = array( "Robert" => "Bob", "Seppo" => "Sepi" );
$bar = each( $foo );
$k = implode(array_keys($bar),",");
$v = implode(array_values($bar),",");
echo $k ."
";
echo $v;
?>
output:
1,value,0,key
Bob,Bob,Robert,Robert
Above example only be interpretered by PHP4.

Change Language


Follow Navioo On Twitter
array_change_key_case
array_chunk
array_combine
array_count_values
array_diff_assoc
array_diff_key
array_diff_uassoc
array_diff_ukey
array_diff
array_fill_keys
array_fill
array_filter
array_flip
array_intersect_assoc
array_intersect_key
array_intersect_uassoc
array_intersect_ukey
array_intersect
array_key_exists
array_keys
array_map
array_merge_recursive
array_merge
array_multisort
array_pad
array_pop
array_product
array_push
array_rand
array_reduce
array_reverse
array_search
array_shift
array_slice
array_splice
array_sum
array_udiff_assoc
array_udiff_uassoc
array_udiff
array_uintersect_assoc
array_uintersect_uassoc
array_uintersect
array_unique
array_unshift
array_values
array_walk_recursive
array_walk
array
arsort
asort
compact
count
current
each
end
extract
in_array
key
krsort
ksort
list
natcasesort
natsort
next
pos
prev
range
reset
rsort
shuffle
sizeof
sort
uasort
uksort
usort
Terms of Service Privacy Policy Sitemap

©2024 -EPSILONSYS SOFTWARE inc

Other EPSILONSYS SOFTWARE Web Sites : Programming Resources | News Headline | Free local classifieds

eXTReMe Tracker