PREV(3) 1 PREV(3)prev - Rewind the internal array pointerSYNOPSIS
mixed prev (array &$array)
DESCRIPTION
Rewind the internal array pointer.
prev(3) behaves just like next(3), except it rewinds the internal array pointer one place instead of advancing it.
PARAMETERS
o $array
- The input array.
RETURN VALUES
Returns the array value in the previous place that's pointed to by the internal array pointer, or FALSE if there are no more elements.
EXAMPLES
Example #1
Example use of prev(3) and friends
<?php
$transport = array('foot', 'bike', 'car', 'plane');
$mode = current($transport); // $mode = 'foot';
$mode = next($transport); // $mode = 'bike';
$mode = next($transport); // $mode = 'car';
$mode = prev($transport); // $mode = 'bike';
$mode = end($transport); // $mode = 'plane';
?>
NOTES
Warning
This function may return Boolean FALSE, but may also return a non-Boolean value which evaluates to FALSE. Please read the section on
Booleans for more information. Use the === operator for testing the return value of this function.
Note
You won't be able to distinguish the beginning of an array from a boolean FALSE element. To properly traverse an array which may
contain FALSE elements, see the each(3) function.
SEE ALSO current(3), end(3), next(3), reset(3), each(3).
PHP Documentation Group PREV(3)
Check Out this Related Man Page
EACH(3) 1 EACH(3)each - Return the current key and value pair from an array and advance the array cursorSYNOPSIS
array each (array &$array)
DESCRIPTION
Return the current key and value pair from an array and advance the array cursor.
After each(3) has executed, the array cursor will be left on the next element of the array, or past the last element if it hits the end of
the array. You have to use reset(3) if you want to traverse the array again using each.
PARAMETERS
o $array
- The input array.
RETURN VALUES
Returns the current key and value pair from the array $array. This pair is returned in a four-element array, with the keys 0, 1, key, and
value. Elements 0 and key contain the key name of the array element, and 1 and value contain the data.
If the internal pointer for the array points past the end of the array contents, each(3) returns FALSE.
EXAMPLES
Example #1
each(3) examples
<?php
$foo = array("bob", "fred", "jussi", "jouni", "egon", "marliese");
$bar = each($foo);
print_r($bar);
?>
$bar now contains the following key/value pairs:
Array
(
[1] => bob
[value] => bob
[0] => 0
[key] => 0
)
<?php
$foo = array("Robert" => "Bob", "Seppo" => "Sepi");
$bar = each($foo);
print_r($bar);
?>
$bar now contains the following key/value pairs:
Array
(
[1] => Bob
[value] => Bob
[0] => Robert
[key] => Robert
)
each(3) is typically used in conjunction with list(3) to traverse an array, here's an example:
Example #2
Traversing an array with each(3)
<?php
$fruit = array('a' => 'apple', 'b' => 'banana', 'c' => 'cranberry');
reset($fruit);
while (list($key, $val) = each($fruit)) {
echo "$key => $val
";
}
?>
The above example will output:
a => apple
b => banana
c => cranberry
Caution
Because assigning an array to another variable resets the original array's pointer, our example above would cause an endless loop
had we assigned $fruit to another variable inside the loop.
Warning
each(3) will also accept objects, but may return unexpected results. It's therefore not recommended to iterate though object proper-
ties with each(3).
SEE ALSO key(3), list(3), current(3), reset(3), next(3), prev(3), foreach, Object Iteration.
PHP Documentation Group EACH(3)